From 673a2299566b501c565cca646b403a7a5f2711bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Thu, 18 Jan 2024 12:03:45 +0100 Subject: [PATCH] Documentation for OTel .NET AutoInstrumentation 1.3.0 (#3800) --- .../en/docs/languages/net/automatic/config.md | 13 +++++++----- .../net/automatic/instrumentations.md | 21 ++++++++++--------- static/refcache.json | 4 ++++ 3 files changed, 23 insertions(+), 15 deletions(-) diff --git a/content/en/docs/languages/net/automatic/config.md b/content/en/docs/languages/net/automatic/config.md index 4a7af58069d6..275a231d01e2 100644 --- a/content/en/docs/languages/net/automatic/config.md +++ b/content/en/docs/languages/net/automatic/config.md @@ -3,7 +3,7 @@ title: Configuration and settings linkTitle: Configuration weight: 20 # prettier-ignore -cSpell:ignore: AZUREAPPSERVICE Bitness CLSID CORECLR dylib NETFX UNHANDLEDEXCEPTION +cSpell:ignore: AZUREAPPSERVICE Bitness CLSID CORECLR dylib NETFX PROCESSRUNTIME UNHANDLEDEXCEPTION --- ## Configuration methods @@ -95,10 +95,13 @@ for more details. The following resource detectors are included and enabled by default: -| ID | Description | Documentation | Status | -| ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| `CONTAINER` | Container detector | [Container resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Container-1.0.0-beta.3/src/OpenTelemetry.ResourceDetectors.Container/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `AZUREAPPSERVICE` | Azure App Service detector | [Azure resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Azure-1.0.0-beta.2/src/OpenTelemetry.ResourceDetectors.Azure/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| ID | Description | Documentation | Status | +| ----------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| `AZUREAPPSERVICE` | Azure App Service detector | [Azure resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Azure-1.0.0-beta.4/src/OpenTelemetry.ResourceDetectors.Azure/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `CONTAINER` | Container detector | [Container resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Container-1.0.0-beta.5/src/OpenTelemetry.ResourceDetectors.Container/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `HOST` | Host detector | [Host resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Host-0.1.0-alpha.2/src/OpenTelemetry.ResourceDetectors.Host/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `PROCESS` | Process detector | [Process resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Process-0.1.0-alpha.2/src/OpenTelemetry.ResourceDetectors.Process/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `PROCESSRUNTIME` | Process Runtime detector | [Process Runtime resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.ProcessRuntime-0.1.0-alpha.2/src/OpenTelemetry.ResourceDetectors.ProcessRuntime/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | ## Propagators diff --git a/content/en/docs/languages/net/automatic/instrumentations.md b/content/en/docs/languages/net/automatic/instrumentations.md index 7804c030859a..5e0b336400a5 100644 --- a/content/en/docs/languages/net/automatic/instrumentations.md +++ b/content/en/docs/languages/net/automatic/instrumentations.md @@ -52,13 +52,14 @@ stable semantic convention. | `GRAPHQL` | [GraphQL](https://www.nuget.org/packages/GraphQL) **Not supported on .NET Framework** | ≥7.5.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `GRPCNETCLIENT` | [Grpc.Net.Client](https://www.nuget.org/packages/Grpc.Net.Client) | ≥2.52.0 & < 3.0.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `HTTPCLIENT` | [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient) and [System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `QUARTZ` | [Quartz](https://www.nuget.org/packages/Quartz) **Not supported on .NET Framework 4.7.1 and older** | ≥3.4.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `KAFKA` | [Confluent.Kafka](https://www.nuget.org/packages/Confluent.Kafka) | ≥1.4.0 < 3.0.0 | bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | | `MASSTRANSIT` | [MassTransit](https://www.nuget.org/packages/MassTransit) **Not supported on .NET Framework** | ≥8.0.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `MONGODB` | [MongoDB.Driver.Core](https://www.nuget.org/packages/MongoDB.Driver.Core) | ≥2.13.3 & < 3.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | | `MYSQLCONNECTOR` | [MySqlConnector](https://www.nuget.org/packages/MySqlConnector) | ≥2.0.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `MYSQLDATA` | [MySql.Data](https://www.nuget.org/packages/MySql.Data) **Not supported on .NET Framework** | ≥8.1.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `NPGSQL` | [Npgsql](https://www.nuget.org/packages/Npgsql) | ≥6.0.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `NSERVICEBUS` | [NServiceBus](https://www.nuget.org/packages/NServiceBus) | ≥8.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `QUARTZ` | [Quartz](https://www.nuget.org/packages/Quartz) **Not supported on .NET Framework 4.7.1 and older** | ≥3.4.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `SQLCLIENT` | [Microsoft.Data.SqlClient](https://www.nuget.org/packages/Microsoft.Data.SqlClient), [System.Data.SqlClient](https://www.nuget.org/packages/System.Data.SqlClient) and `System.Data` (shipped with .NET Framework) | \* \[4\] | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `STACKEXCHANGEREDIS` | [StackExchange.Redis](https://www.nuget.org/packages/StackExchange.Redis) **Not supported on .NET Framework** | ≥2.0.405 < 3.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | | `WCFCLIENT` | WCF | \* | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | @@ -81,14 +82,14 @@ to [issue](https://github.com/open-telemetry/opentelemetry-dotnet/issues/4243). stable, but particular instrumentation are in Experimental status due to lack of stable semantic convention. -| ID | Instrumented library | Documentation | Supported versions | Instrumentation type | Status | -| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -------------------- | --------------------------------------------------------- | -| `ASPNET` | ASP.NET Framework \[1\] **Not supported on .NET** | [ASP.NET metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.AspNet-1.0.0-rc9.9/src/OpenTelemetry.Instrumentation.AspNet/README.md#list-of-metrics-produced) | \* | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `ASPNETCORE` | ASP.NET Core \[2\] **Not supported on .NET Framework** | [ASP.NET Core metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/core-1.5.0/src/OpenTelemetry.Instrumentation.AspNetCore/README.md#list-of-metrics-produced) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `HTTPCLIENT` | [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient) and [System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest) | [HttpClient metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/core-1.5.0/src/OpenTelemetry.Instrumentation.Http/README.md#list-of-metrics-produced) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `NETRUNTIME` | [OpenTelemetry.Instrumentation.Runtime](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Runtime) | [Runtime metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.Runtime-1.5.1/src/OpenTelemetry.Instrumentation.Process/README.md#metrics) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `PROCESS` | [OpenTelemetry.Instrumentation.Process](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Process) | [Process metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.Process-0.5.0-beta.3/src/OpenTelemetry.Instrumentation.Process/README.md#metrics) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `NSERVICEBUS` | [NServiceBus](https://www.nuget.org/packages/NServiceBus) | [NServiceBus metrics](https://docs.particular.net/samples/open-telemetry/prometheus-grafana/#reporting-metric-values) | ≥8.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | +| ID | Instrumented library | Documentation | Supported versions | Instrumentation type | Status | +| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | -------------------- | --------------------------------------------------------- | +| `ASPNET` | ASP.NET Framework \[1\] **Not supported on .NET** | [ASP.NET metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.AspNet-1.7.0-beta.1/src/OpenTelemetry.Instrumentation.AspNet/README.md#list-of-metrics-produced) | \* | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `ASPNETCORE` | ASP.NET Core \[2\] **Not supported on .NET Framework** | [ASP.NET Core metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/Instrumentation.AspNetCore-1.7.0/src/OpenTelemetry.Instrumentation.AspNetCore/README.md#list-of-metrics-produced) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `HTTPCLIENT` | [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient) and [System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest) | [HttpClient metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/Instrumentation.Http-1.7.0/src/OpenTelemetry.Instrumentation.Http/README.md#list-of-metrics-produced) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `NETRUNTIME` | [OpenTelemetry.Instrumentation.Runtime](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Runtime) | [Runtime metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.Runtime-1.7.0/src/OpenTelemetry.Instrumentation.Process/README.md#metrics) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `PROCESS` | [OpenTelemetry.Instrumentation.Process](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Process) | [Process metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.Process-0.5.0-beta.4/src/OpenTelemetry.Instrumentation.Process/README.md#metrics) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `NSERVICEBUS` | [NServiceBus](https://www.nuget.org/packages/NServiceBus) | [NServiceBus metrics](https://docs.particular.net/samples/open-telemetry/prometheus-grafana/#reporting-metric-values) | ≥8.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | \[1\]: The ASP.NET metrics are generated only if the `AspNet` trace instrumentation is also enabled. @@ -102,7 +103,7 @@ instrumentation is also enabled. | ID | Instrumented library | Supported versions | Instrumentation type | Status | | --------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -------------------- | --------------------------------------------------------- | -| `ILOGGER` | [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging) **Not supported on .NET Framework** | ≥6.0.0 | bytecode or source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `ILOGGER` | [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging) **Not supported on .NET Framework** | ≥8.0.0 | bytecode or source | [Experimental](/docs/specs/otel/versioning-and-stability) | For ASP.NET Core applications, the `LoggingBuilder` instrumentation can be enabled without using the .NET CLR Profiler by setting the diff --git a/static/refcache.json b/static/refcache.json index 4cb6d6c5eaa6..ffbb56fd8656 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -6663,6 +6663,10 @@ "StatusCode": 200, "LastSeen": "2023-09-06T15:04:25.165623+02:00" }, + "https://www.nuget.org/packages/Confluent.Kafka": { + "StatusCode": 200, + "LastSeen": "2024-01-18T10:45:19.955108939Z" + }, "https://www.nuget.org/packages/Elastic.Clients.Elasticsearch": { "StatusCode": 200, "LastSeen": "2023-09-06T15:04:24.3457+02:00"