This project adds OpenTelemetry instrumentation to .NET applications without having to modify their source code.

⚠️ The following documentation refers to the in-development version of OpenTelemetry .NET Automatic Instrumentation. Docs for the latest version (0.5.0) can be found here.

OpenTelemetry .NET Automatic Instrumentation is built on top of OpenTelemetry .NET:

• Core components: 1.4.0-rc.2
• System.Diagnostics.DiagnosticSource: 7.0.0 referencing System.Runtime.CompilerServices.Unsafe: 6.0.0

You can find all references in OpenTelemetry.AutoInstrumentation.csproj and OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Build.props.

To automatically instrument applications, the OpenTelemetry .NET Automatic Instrumentation does the following:

1. Injects and configures the OpenTelemetry .NET SDK into the application.
2. Adds OpenTelemetry Instrumentation to key packages and APIs used by the application.

You can enable the OpenTelemetry .NET Automatic Instrumentation as a .NET Profiler to inject additional instrumentations of this project at runtime, using a technique known as monkey-patching. When enabled, the OpenTelemetry .NET Automatic Instrumentation generates traces for libraries that don't already generate traces using the OpenTelemetry .NET SDK.

See design.md for an architectural overview.

The versioning information and stability guarantees can be found in the versioning documentation.

OpenTelemetry .NET Automatic Instrumentation attempts to work with all officially supported operating systems and versions of .NET, and .NET Framework.

Versions lower than .NET Framework 4.6.2 are not supported.

.NET Core 3.1 is not supported. 0.4.0-beta.1 is the latest version supporting it.

CI tests run against the following operating systems:

• macOS Big Sur 11
• Microsoft Windows Server 2022
• Ubuntu 20.04 LTS
• Alpine

See config.md#instrumented-libraries-and-frameworks.

Download and extract the appropriate binaries from the latest release.

The path where you put the binaries is referenced as $INSTALL_DIR

When running your application, make sure to:

1. Set the resources.
2. Set the environment variables from the table below.

Some settings can be omitted on .NET. For more information, see config.md.

You can install OpenTelemetry .NET Automatic Instrumentation and instrument your .NET application using the provided Shell scripts. Example usage:

curl -sSfL https://raw.githubusercontent.com/open-telemetry/opentelemetry-dotnet-instrumentation/v0.5.1-beta.3/otel-dotnet-auto-install.sh -O
sh ./otel-dotnet-auto-install.sh
. $HOME/.otel-dotnet-auto/instrument.sh
OTEL_SERVICE_NAME=myapp OTEL_RESOURCE_ATTRIBUTES=deployment.environment=staging,service.version=1.0.0 dotnet run

otel-dotnet-auto-install.sh script uses environment variables as parameters:

instrument.sh script uses environment variables as parameters:

On macOS coreutils is required.

On Windows, you should install OpenTelemetry .NET Automatic Instrumentation and instrument your .NET application using the provided PowerShell module. Example usage (run as administrator):

# Download and import the module
$module_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-dotnet-instrumentation/v0.5.1-beta.3/OpenTelemetry.DotNet.Auto.psm1"
$download_path = Join-Path $env:temp "OpenTelemetry.DotNet.Auto.psm1"
Invoke-WebRequest -Uri $module_url -OutFile $download_path
Import-Module $download_path

# Install core files
Install-OpenTelemetryCore

# Setup IIS instrumentation
Register-OpenTelemetryForIIS

# Setup your Windows Service instrumentation
Register-OpenTelemetryForWindowsService -WindowsServiceName "MyServiceName" -OTelServiceName "MyServiceDisplayName"

# Setup environment to start instrumentation from the current PowerShell session
Register-OpenTelemetryForCurrentSession -OTelServiceName "MyServiceDisplayName"

# Get current installation location
Get-OpenTelemetryInstallDirectory

# List all available commands
Get-Command -Module OpenTelemetry.DotNet.Auto

# Get command's usage information
Get-Help Install-OpenTelemetryCore -Detailed

⚠️ Register for IIS and Windows Service performs a service restart.

You can find our demonstrative example that uses Docker Compose here.

You can also consider using the Kubernetes Operator for OpenTelemetry Collector.

See windows-service-instrumentation.md.

See iis-instrumentation.md.

See config.md.

See manual-instrumentation.md.

See troubleshooting.md.

See CONTRIBUTING.md.

See CONTRIBUTING.md.

Maintainers (@open-telemetry/dotnet-instrumentation-maintainers):

• Chris Ventura, New Relic
• Paulo Janotti, Splunk
• Rajkumar Rangaraj, Microsoft
• Robert Pająk, Splunk
• Zach Montoya, Datadog

Approvers (@open-telemetry/dotnet-instrumentation-approvers):

• Piotr Kiełkowicz, Splunk
• Rasmus Kuusmann, Splunk

Emeritus Maintainer/Approver/Triager:

• Colin Higgins
• Greg Paperin
• Kevin Gosse
• Lucas Pimentel-Ordyna
• Mike Goldsmith
• Tony Redondo

Learn more about roles in the community repository.