base on The OpenTelemetry .NET Client # OpenTelemetry .NET [](https://cloud-native.slack.com/archives/C01N3BC2W7Q) [](https://codecov.io/gh/open-telemetry/opentelemetry-dotnet/) [](https://www.nuget.org/profiles/OpenTelemetry) [](https://www.nuget.org/profiles/OpenTelemetry) [](https://github.com/open-telemetry/opentelemetry-dotnet/actions/workflows/ci.yml) [](https://scorecard.dev/viewer/?uri=github.com/open-telemetry/opentelemetry-dotnet) [](https://www.bestpractices.dev/projects/10017) [](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopen-telemetry%2Fopentelemetry-dotnet?ref=badge_shield&issueType=license) [](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopen-telemetry%2Fopentelemetry-dotnet?ref=badge_shield&issueType=security) The .NET [OpenTelemetry](https://opentelemetry.io/) implementation. <details> <summary>Table of Contents</summary> * [Supported .NET versions](#supported-net-versions) * [Project status](#project-status) * [Getting started](#getting-started) * [Getting started with Logging](#getting-started-with-logging) * [Getting started with Metrics](#getting-started-with-metrics) * [Getting started with Tracing](#getting-started-with-tracing) * [Repository structure](#repository-structure) * [Troubleshooting](#troubleshooting) * [Extensibility](#extensibility) * [Releases](#releases) * [Contributing](#contributing) * [References](#references) </details> ## Supported .NET versions Packages shipped from this repository generally support all the officially supported versions of [.NET](https://dotnet.microsoft.com/download/dotnet) and [.NET Framework](https://dotnet.microsoft.com/download/dotnet-framework) (an older Windows-based .NET implementation), except `.NET Framework 3.5`. Any exceptions to this are noted in the individual `README.md` files. ## Project status **Stable** across all 3 signals (`Logs`, `Metrics`, and `Traces`). > [!CAUTION] > Certain components, marked as [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases), are still work in progress and can undergo breaking changes before stable release. Check the individual `README.md` file for each component to understand its current state. To understand which portions of the [OpenTelemetry Specification](https://github.com/open-telemetry/opentelemetry-specification) have been implemented in OpenTelemetry .NET see: [Spec Compliance Matrix](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md). ## Getting started If you are new here, please read the getting started docs: ### Getting started with Logging If you are new to [logging](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/README.md), it is recommended to first follow the [getting started in 5 minutes - ASP.NET Core Application](./docs/logs/getting-started-aspnetcore/README.md) guide or the [getting started in 5 minutes - Console Application](./docs/logs/getting-started-console/README.md) guide to get up and running. For general information and best practices see: [OpenTelemetry .NET Logs](./docs/logs/README.md). For a more detailed explanation of SDK logging features see: [Customizing OpenTelemetry .NET SDK for Logs](./docs/logs/customizing-the-sdk/README.md). ### Getting started with Metrics If you are new to [metrics](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/README.md), it is recommended to first follow the [getting started in 5 minutes - ASP.NET Core Application](./docs/metrics/getting-started-aspnetcore/README.md) guide or the [getting started in 5 minutes - Console Application](./docs/metrics/getting-started-console/README.md) guide to get up and running. For general information and best practices see: [OpenTelemetry .NET Metrics](./docs/metrics/README.md). For a more detailed explanation of SDK metric features see: [Customizing OpenTelemetry .NET SDK for Metrics](./docs/metrics/customizing-the-sdk/README.md). ### Getting started with Tracing If you are new to [traces](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/README.md), it is recommended to first follow the [getting started in 5 minutes - ASP.NET Core Application](./docs/trace/getting-started-aspnetcore/README.md) guide or the [getting started in 5 minutes - Console Application](./docs/trace/getting-started-console/README.md) guide to get up and running. For general information and best practices see: [OpenTelemetry .NET Traces](./docs/trace/README.md). For a more detailed explanation of SDK tracing features see: [Customizing OpenTelemetry .NET SDK for Tracing](./docs/trace/customizing-the-sdk/README.md). ## Repository structure This repository includes only what is defined in the [OpenTelemetry Specification](https://github.com/open-telemetry/opentelemetry-specification) and is shipped as separate packages through [NuGet](https://www.nuget.org/profiles/OpenTelemetry). Each component has an individual `README.md` and `CHANGELOG.md` file which covers the instructions on how to install and get started, and details about the individual changes made (respectively). To find all the available components, please take a look at the `src` folder. Here are the most commonly used components: * [OpenTelemetry API](./src/OpenTelemetry.Api/README.md) * [OpenTelemetry SDK](./src/OpenTelemetry/README.md) * [OpenTelemetry Hosting Extensions](./src/OpenTelemetry.Extensions.Hosting/README.md) Here are the [exporter libraries](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#exporter-library): * [Console](./src/OpenTelemetry.Exporter.Console/README.md) * [In-memory](./src/OpenTelemetry.Exporter.InMemory/README.md) * [OTLP](./src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md) (OpenTelemetry Protocol) * [Prometheus AspNetCore](./src/OpenTelemetry.Exporter.Prometheus.AspNetCore/README.md) * [Prometheus HttpListener](./src/OpenTelemetry.Exporter.Prometheus.HttpListener/README.md) * [Zipkin](./src/OpenTelemetry.Exporter.Zipkin/README.md) (Deprecated) Additional packages including [instrumentation libraries](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#instrumentation-library), exporters, resource detectors, and extensions can be found in the [opentelemetry-dotnet-contrib repository](https://github.com/open-telemetry/opentelemetry-dotnet-contrib) and/or the [OpenTelemetry registry](https://opentelemetry.io/ecosystem/registry/?language=dotnet). ## Troubleshooting For general instructions see: [Troubleshooting](./src/OpenTelemetry/README.md#troubleshooting). Additionally `README.md` files for individual components may contain more detailed troubleshooting information. ## Extensibility OpenTelemetry .NET is designed to be extensible. Here are the most common extension scenarios: * Building a custom [instrumentation library](./docs/trace/extending-the-sdk/README.md#instrumentation-library). * Building a custom exporter for [logs](./docs/logs/extending-the-sdk/README.md#exporter), [metrics](./docs/metrics/extending-the-sdk/README.md#exporter), and [traces](./docs/trace/extending-the-sdk/README.md#exporter). * Building a custom processor for [logs](./docs/logs/extending-the-sdk/README.md#processor) and [traces](./docs/trace/extending-the-sdk/README.md#processor). * Building a custom sampler for [traces](./docs/trace/extending-the-sdk/README.md#sampler). ## Releases For details about upcoming planned releases see: [Milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestones). The dates and features described in issues and milestones are estimates and subject to change. For highlights and announcements for stable releases see: [Release Notes](./RELEASENOTES.md). To access packages, source code, and/or view a list of changes for all components in a release see: [Releases](https://github.com/open-telemetry/opentelemetry-dotnet/releases). Nightly builds from this repo are published to [MyGet](https://www.myget.org), and can be installed using the `https://www.myget.org/F/opentelemetry/api/v3/index.json` source. ### Digital signing Starting with the `1.10.0` release the DLLs included in the packages pushed to NuGet are digitally signed using [Sigstore](https://www.sigstore.dev/). Within each NuGet package the digital signature artifacts are placed alongside the shipped DLL(s) in the `/lib` folder. When a project targets multiple frameworks each target outputs a dedicated DLL and signing artifacts into a sub folder based on the [TFM](https://learn.microsoft.com/dotnet/standard/frameworks). The digital signature files share the same name prefix as the DLL to ensure easy identification and association. To verify the integrity of a DLL inside a NuGet package use the [cosign](https://github.com/sigstore/cosign) tool from Sigstore: #### Version 1.14.0 and later These versions are using bundle format known from cosign 3.0+. ```bash $TAG="core-1.14.0" cosign verify-blob \ --bundle OpenTelemetry.dll.sigstore.json \ --certificate-identity "https://github.com/open-telemetry/opentelemetry-dotnet/.github/workflows/publish-packages-1.0.yml@refs/tags/$TAG" \ --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \ --use-signed-timestamps \ OpenTelemetry.dll ``` #### Versions 1.10.0 - 1.14.0-rc.1 These versions are using separate signature and certificate files format known from cosign 2.x. ```bash $TAG="core-1.12.0" cosign verify-blob \ --signature OpenTelemetry.dll-keyless.sig \ --certificate OpenTelemetry.dll-keyless.pem \ --certificate-identity "https://github.com/open-telemetry/opentelemetry-dotnet/.github/workflows/publish-packages-1.0.yml@refs/tags/$TAG" \ --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \ OpenTelemetry.dll ``` > [!NOTE] > A successful verification outputs `Verify OK`. For more verification options please refer to the [cosign documentation](https://github.com/sigstore/cosign/blob/main/doc/cosign_verify-blob.md). ### Attestation Starting with the `1.14.0` release the DLLs included in the packages pushed to NuGet are attested using [GitHub Artifact attestations](https://docs.github.com/actions/concepts/security/artifact-attestations). To verify the attestation of a DLL inside a NuGet package use the [GitHub CLI](https://cli.github.com/): ```bash gh attestation verify --owner open-telemetry .\OpenTelemetry.dll ``` > [!NOTE] > A successful verification outputs `Verification succeeded!`. For more verification options please refer to the [`gh attestation verify` documentation](https://cli.github.com/manual/gh_attestation_verify). ## Contributing For information about contributing to the project see: [CONTRIBUTING.md](CONTRIBUTING.md). We meet weekly on Tuesdays, and the time of the meeting alternates between 9AM PT and 4PM PT. The meeting is subject to change depending on contributors' availability. Check the [OpenTelemetry community calendar](https://github.com/open-telemetry/community?tab=readme-ov-file#calendar) for specific dates and for Zoom meeting links. Meeting notes are available as a public [Google doc](https://docs.google.com/document/d/1yjjD6aBcLxlRazYrawukDgrhZMObwHARJbB9glWdHj8/edit?usp=sharing). If you have trouble accessing the doc, please get in touch on [Slack](https://cloud-native.slack.com/archives/C01N3BC2W7Q). The meeting is open for all to join. We invite everyone to join our meeting, regardless of your experience level. Whether you're a seasoned OpenTelemetry developer, just starting your journey, or simply curious about the work we do, you're more than welcome to participate! ### Maintainers * [Alan West](https://github.com/alanwest), New Relic * [Piotr Kie&#x142;kowicz](https://github.com/Kielek), Splunk * [Rajkumar Rangaraj](https://github.com/rajkumar-rangaraj), Microsoft For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer). ### Approvers * [Cijo Thomas](https://github.com/cijothomas), Microsoft * [Martin Costello](https://github.com/martincostello), Grafana Labs * [Mikel Blanchard](https://github.com/CodeBlanch), Microsoft For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver). ### Triagers * [Martin Thwaites](https://github.com/martinjt), Honeycomb * [Timothy "Mothra" Lee](https://github.com/TimothyMothra) For more information about the triager role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#triager). ### Emeritus Maintainers * [Mike Goldsmith](https://github.com/MikeGoldsmith) * [Sergey Kanzhelev](https://github.com/SergeyKanzhelev) * [Utkarsh Umesan Pillai](https://github.com/utpilla) For more information about the emeritus role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager). ### Emeritus Approvers * [Bruno Garcia](https://github.com/bruno-garcia) * [Eddy Nakamura](https://github.com/eddynaka) * [Liudmila Molkova](https://github.com/lmolkova) * [Paulo Janotti](https://github.com/pjanotti) * [Reiley Yang](https://github.com/reyang) * [Robert Paj&#x105;k](https://github.com/pellared) * [Vishwesh Bankwar](https://github.com/vishweshbankwar) For more information about the emeritus role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager). ### Emeritus Triagers * [Victor Lu](https://github.com/victlu) For more information about the emeritus role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager). ### Thanks to all the people who have contributed [](https://github.com/open-telemetry/opentelemetry-dotnet/graphs/contributors) ## References * [OpenTelemetry Project](https://opentelemetry.io/) * [OpenTelemetry Specification](https://github.com/open-telemetry/opentelemetry-specification) ", Assign "at most 3 tags" to the expected json: {"id":"990","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"