OpenTelemetry 1.11.0-rc.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.6.2 This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher.
This is a prerelease version of OpenTelemetry. 
dotnet add package OpenTelemetry --version 1.11.0-rc.1                

                    
                

            
NuGet\Install-Package OpenTelemetry -Version 1.11.0-rc.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="OpenTelemetry" Version="1.11.0-rc.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add OpenTelemetry --version 1.11.0-rc.1                

                    
                

            
#r "nuget: OpenTelemetry, 1.11.0-rc.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install OpenTelemetry as a Cake Addin
#addin nuget:?package=OpenTelemetry&version=1.11.0-rc.1&prerelease

// Install OpenTelemetry as a Cake Tool
#tool nuget:?package=OpenTelemetry&version=1.11.0-rc.1&prerelease

OpenTelemetry .NET SDK

NuGet NuGet

<details> <summary>Table of Contents</summary>

</details>

Installation

dotnet add package OpenTelemetry

Introduction

OpenTelemetry SDK is a reference implementation of the OpenTelemetry API. It implements the Logging API, Metrics API, Tracing API, Resource API, and the Context API. Once a valid SDK is installed and configured all the OpenTelemetry API methods, which were no-ops without an SDK, will start emitting telemetry. This SDK also ships with ILogger integration to automatically capture and enrich logs emitted using Microsoft.Extensions.Logging.

The SDK deals with concerns such as sampling, processing pipelines (exporting telemetry to a particular backend, etc.), metrics aggregation, and other concerns outlined in the OpenTelemetry Specification. In most cases, users indirectly install and enable the SDK when they install an exporter.

To learn how to set up and configure the OpenTelemetry SDK see: Getting started. For additional details about initialization patterns see: Initialize the SDK.

Troubleshooting

All the components shipped from this repo uses EventSource for its internal logging. The name of the EventSource used by OpenTelemetry SDK is "OpenTelemetry-Sdk". To know the EventSource names used by other components, refer to the individual readme files.

While it is possible to view these logs using tools such as PerfView, dotnet-trace etc., this SDK also ships a self-diagnostics feature, which helps with troubleshooting.

Self-diagnostics

OpenTelemetry SDK ships with built-in self-diagnostics feature. This feature, when enabled, will listen to internal logs generated by all OpenTelemetry components (i.e EventSources whose name starts with "OpenTelemetry-") and writes them to a log file.

The self-diagnostics feature can be enabled/changed/disabled while the process is running (without restarting the process). The SDK will attempt to read the configuration file every 10 seconds in non-exclusive read-only mode. The SDK will create or overwrite a file with new logs according to the configuration. This file will not exceed the configured max size and will be overwritten in a circular way.

To enable self-diagnostics, go to the current working directory of your process and create a configuration file named OTEL_DIAGNOSTICS.json with the following content:

{
    "LogDirectory": ".",
    "FileSize": 32768,
    "LogLevel": "Warning"
}

To disable self-diagnostics, delete the above file.

Tip: In most cases, you could just drop the file along your application. On Windows, you can use Process Explorer, double click on the process to pop up Properties dialog and find "Current directory" in "Image" tab. Internally, it looks for the configuration file located in GetCurrentDirectory, and then AppContext.BaseDirectory. You can also find the exact directory by calling these methods from your code.

Configuration Parameters

  1. LogDirectory is the directory where the output log file will be stored. It can be an absolute path or a relative path to the current directory.

  2. FileSize is a positive integer, which specifies the log file size in KiB. This value must be within range [1024, 131072] (1 MiB /<= size /<= 128 MiB), or it will be rounded to the closest upper or lower limit. The log file will never exceed this configured size, and will be overwritten in a circular way.

  3. LogLevel is the lowest level of the events to be captured. It has to be one of the values of the EventLevel enum. The level signifies the severity of an event. Lower severity levels encompass higher severity levels. For example, Warning includes the Error and Critical levels.

Remarks

A FileSize-KiB log file named as ExecutableName.ProcessId.log (e.g. foobar.exe.12345.log) will be generated at the specified directory LogDirectory, into which logs are written to.

If the SDK fails to parse the LogDirectory, FileSize or LogLevel fields as the specified format, the configuration file will be treated as invalid and no log file would be generated.

When the LogDirectory or FileSize is found to be changed, the SDK will create or overwrite a file with new logs according to the new configuration. The configuration file has to be no more than 4 KiB. In case the file is larger than 4 KiB, only the first 4 KiB of content will be read.

The log file might not be a proper text file format to achieve the goal of having minimal overhead and bounded resource usage: it may have trailing NULs if log text is less than configured size; once write operation reaches the end, it will start from beginning and overwrite existing text.

References

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (326)

Showing the top 5 NuGet packages that depend on OpenTelemetry:

Package Downloads
OpenTelemetry.Extensions.Hosting

Contains extensions to start OpenTelemetry in applications using Microsoft.Extensions.Hosting
OpenTelemetry.Exporter.OpenTelemetryProtocol

OpenTelemetry protocol exporter for OpenTelemetry .NET
OpenTelemetry.Exporter.Console

Console exporter for OpenTelemetry .NET
OpenTelemetry.Exporter.Jaeger

Jaeger exporter for OpenTelemetry .NET
OpenTelemetry.Instrumentation.GrpcNetClient

gRPC for .NET client instrumentation for OpenTelemetry .NET.

GitHub repositories (56)

Showing the top 5 popular GitHub repositories that depend on OpenTelemetry:

Repository Stars
dotnet/runtime
.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
dotnetcore/CAP
Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern
quartznet/quartznet
Quartz Enterprise Scheduler .NET
Azure/azure-sdk-for-net
This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
dotnet/tye
Tye is a tool that makes developing, testing, and deploying microservices and distributed applications easier. Project Tye includes a local orchestrator to make developing microservices easier and the ability to deploy microservices to Kubernetes with minimal configuration.
Version Downloads Last updated
1.11.0-rc.1 2,320 12/12/2024
1.10.0 1,169,906 11/12/2024
1.10.0-rc.1 8,823 11/1/2024
1.10.0-beta.1 29,848 9/30/2024
1.9.0 16,654,708 6/14/2024
1.9.0-rc.1 155,442 6/7/2024
1.9.0-alpha.1 63,427 5/20/2024
1.8.1 10,957,358 4/18/2024
1.8.0 4,454,526 4/3/2024
1.8.0-rc.1 954,148 3/27/2024
1.8.0-beta.1 134,348 3/14/2024
1.7.0 12,778,861 12/9/2023
1.7.0-rc.1 1,574,541 11/30/2023
1.7.0-alpha.1 531,183 10/17/2023
1.6.0 14,665,633 9/6/2023
1.6.0-rc.1 1,662,277 8/21/2023
1.6.0-alpha.1 467,128 7/12/2023
1.5.1 11,626,959 6/26/2023
1.5.0 3,624,289 6/6/2023 1.5.0 is deprecated.
1.5.0-rc.1 1,968,662 5/26/2023
1.5.0-alpha.2 1,062,881 4/1/2023
1.5.0-alpha.1 1,309,730 3/8/2023
1.4.0 13,851,228 2/24/2023
1.4.0-rc.4 2,833,447 2/11/2023
1.4.0-rc.3 728,998 2/2/2023
1.4.0-rc.2 934,273 1/9/2023
1.4.0-rc.1 1,267,395 12/12/2022
1.4.0-beta.3 2,011,973 11/7/2022
1.4.0-beta.2 1,030,245 10/17/2022
1.4.0-beta.1 415,865 9/30/2022
1.4.0-alpha.2 1,721,604 8/18/2022
1.4.0-alpha.1 1,563,167 8/3/2022
1.3.2 3,788,261 12/20/2022
1.3.1 7,309,491 9/8/2022
1.3.0 8,158,495 6/3/2022 1.3.0 is deprecated because it has critical bugs.
1.3.0-rc.2 1,602,258 6/1/2022
1.3.0-beta.2 203,919 5/17/2022
1.3.0-beta.1 2,358,929 4/20/2022
1.2.0 5,439,144 4/15/2022 1.2.0 is deprecated because it has critical bugs.
1.2.0-rc5 582,972 4/13/2022
1.2.0-rc4 787,282 3/30/2022
1.2.0-rc3 1,099,757 3/5/2022
1.2.0-rc2 2,557,578 2/3/2022
1.2.0-rc1 2,254,332 11/30/2021
1.2.0-beta2.1 446,141 11/19/2021
1.2.0-beta1 4,943,945 10/8/2021
1.2.0-alpha4 42,308 9/23/2021
1.2.0-alpha3 20,346 9/14/2021
1.2.0-alpha2 93,420 8/25/2021
1.2.0-alpha1 123,153 7/23/2021
1.1.0 9,879,960 7/13/2021 1.1.0 is deprecated because it has critical bugs.
1.1.0-rc1 273,356 6/26/2021
1.1.0-beta4 2,144,956 6/9/2021
1.1.0-beta3 236,639 5/12/2021
1.1.0-beta2 523,613 4/23/2021
1.1.0-beta1 1,248,173 3/19/2021
1.0.1 8,246,298 2/10/2021 1.0.1 is deprecated because it has critical bugs.
1.0.0-rc4 41,724 2/9/2021
1.0.0-rc3 32,465 2/5/2021
1.0.0-rc2 324,761 1/30/2021
1.0.0-rc1.1 652,137 11/18/2020
0.8.0-beta.1 120,479 11/5/2020
0.7.0-beta.1 28,243 10/16/2020
0.6.0-beta.1 936,959 9/16/2020
0.5.0-beta.2 18,992 8/28/2020
0.4.0-beta.2 142,117 7/25/2020
0.3.0-beta.1 3,439 7/23/2020
0.2.0-alpha.275 241,040 5/19/2020
0.2.0-alpha.220 442,973 5/19/2020
0.2.0-alpha.179 177,428 1/28/2020
0.2.0-alpha.100 247,360 11/5/2019
0.2.0-alpha.40 141,236 9/24/2019
0.2.0-alpha.5 14,634 8/3/2019

For highlights and announcements see: https://github.com/open-telemetry/opentelemetry-dotnet/blob/core-1.11.0-rc.1/RELEASENOTES.md.

       For detailed changes see: https://github.com/open-telemetry/opentelemetry-dotnet/blob/core-1.11.0-rc.1/src/OpenTelemetry/CHANGELOG.md.