.NET Tracer for Datadog APM

Installation and Usage

Please read our documentation for instructions on setting up .NET tracing and details about supported frameworks.

Downloads

Package	Download
Windows and Linux Installers	See releases
Datadog.Trace
Datadog.Trace.OpenTracing

Build Status on master

Pipeline	Build Status
Unit tests
Integration tests

Development

Components

Datadog Agent: A service that runs on your application servers, accepting trace data from the Datadog Tracer and sending it to Datadog. The Agent is not part of this repo; it's the same Agent to which all Datadog tracers (e.g. Go, Python, Java, Ruby) send data.

Datadog .NET Tracer: This repository. A set of .NET libraries that let you trace any piece of your .NET code. Supports manual instrumentation and can automatically instrument supported libraries out-of-the-box.

Windows

Minimum requirements

• Visual Studio 2019 (16.8) or newer
  • Workloads
    • Desktop development with C++
    • .NET desktop development
    • .NET Core cross-platform development
    • Optional: ASP.NET and web development (to build samples)
  • Individual components
    • .NET Framework 4.7 targeting pack
• .NET 5.0 SDK
• Optional: .NET Core 2.1 Runtime to test in .NET Core 2.1 locally.
• Optional: .NET Core 3.0 Runtime to test in .NET Core 3.0 locally.
• Optional: .NET Core 3.1 Runtime to test in .NET Core 3.1 locally.
• Optional: nuget.exe CLI v5.3 or newer
• Optional: WiX Toolset 3.11.1 or newer to build Windows installer (msi)
  • Requires .NET Framework 3.5 SP2 (install from Windows Features control panel: OptionalFeatures.exe)
  • WiX Toolset Visual Studio Extension to build installer from Visual Studio
• Optional: Docker for Windows to build Linux binaries and run integration tests on Linux containers. See section on Docker Compose.
  • Requires Windows 10 (1607 Anniversary Update, Build 14393 or newer)

Microsoft provides evaluation developer VMs with Windows 10 and Visual Studio pre-installed.

Building from a command line

From a Developer Command Prompt for VS 2019:

rem Restore NuGet packages
rem nuget.exe is required for command line restore because msbuild doesn't support packages.config
rem (see https://github.com/NuGet/Home/issues/7386)
nuget restore Datadog.Trace.sln

rem Build C# projects (Platform: always AnyCPU)
msbuild Datadog.Trace.proj /t:BuildCsharp /p:Configuration=Release

rem Build NuGet packages
dotnet pack src\Datadog.Trace\Datadog.Trace.csproj
dotnet pack src\Datadog.Trace.OpenTracing\Datadog.Trace.OpenTracing.csproj

rem Build C++ projects
rem The native profiler depends on the Datadog.Trace.ClrProfiler.Managed.Loader C# project so be sure that is built first
msbuild Datadog.Trace.proj /t:BuildCpp /p:Configuration=Release;Platform=x64
msbuild Datadog.Trace.proj /t:BuildCpp /p:Configuration=Release;Platform=x86

rem Build MSI installer for Windows x64 (supports both x64 and x86 apps)
msbuild Datadog.Trace.proj /t:msi /p:Configuration=Release;Platform=x64

rem Build MSI installer for Windows x86 (supports x86 apps only)
msbuild Datadog.Trace.proj /t:msi /p:Configuration=Release;Platform=x86

rem Build tracer home directory for Windows.
rem Valid values for property `Platform` are `x64`, `x86`, and `All`.
msbuild Datadog.Trace.proj /t:CreateHomeDirectory /p:Configuration=Release;Platform=All

Linux

Minimum requirements

To build C# projects and NuGet packages only

• .NET 5.0 SDK
• Optional: .NET Core 2.1 Runtime to test in .NET Core 2.1 locally.
• Optional: .NET Core 3.0 Runtime to test in .NET Core 3.0 locally.
• Optional: .NET Core 3.1 Runtime to test in .NET Core 3.1 locally.

To build everything and run integration tests

• Docker Compose

Building and running tests with Docker Compose

You can use Docker Compose with Linux containers to build Linux binaries and run the test suites. This works on both Linux and Windows hosts.

# build C# projects
docker-compose run build

# build C++ project
docker-compose run Profiler

# run integration tests
docker-compose run IntegrationTests

Further Reading

Datadog APM

• Datadog APM
• Datadog APM - Tracing .NET Core and .NET 5 Applications
• Datadog APM - Tracing .NET Framework Applications

Microsoft .NET Profiling APIs

• Profiling API
• Metadata API
• The Book of the Runtime - Profiling

OpenTracing

• OpenTracing documentation
• OpenTracing terminology

Get in touch

If you have questions, feedback, or feature requests, reach our support.