From 07a4f5559c7d4286a7f95b0aae8b5312e45e797a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20=C5=81ach?= Date: Mon, 29 Apr 2024 09:58:59 +0200 Subject: [PATCH] OpenTelemetry .NET Automatic Instrumentation v1.6.0 (#4379) --- .../languages/net/automatic/instrumentations.md | 13 ++++++++----- .../docs/languages/net/automatic/nuget-packages.md | 2 +- .../docs/languages/net/automatic/troubleshooting.md | 2 +- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/content/en/docs/languages/net/automatic/instrumentations.md b/content/en/docs/languages/net/automatic/instrumentations.md index 361b5783fbe9..284ed130efc4 100644 --- a/content/en/docs/languages/net/automatic/instrumentations.md +++ b/content/en/docs/languages/net/automatic/instrumentations.md @@ -112,8 +112,11 @@ enabled without using the .NET CLR Profiler by setting the ### Instrumentation options -| Environment variable | Description | Default value | Status | -| --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------- | -| `OTEL_DOTNET_AUTO_ENTITYFRAMEWORKCORE_SET_DBSTATEMENT_FOR_TEXT` | Whether the Entity Framework Core instrumentation can pass SQL statements through the `db.statement` attribute. Queries might contain sensitive information. If set to `false`, `db.statement` is recorded only for executing stored procedures. | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `OTEL_DOTNET_AUTO_GRAPHQL_SET_DOCUMENT` | Whether the GraphQL instrumentation can pass raw queries through the `graphql.document` attribute. Queries might contain sensitive information. | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `OTEL_DOTNET_AUTO_SQLCLIENT_SET_DBSTATEMENT_FOR_TEXT` | Whether the SQL Client instrumentation can pass SQL statements through the `db.statement` attribute. Queries might contain sensitive information. If set to `false`, `db.statement` is recorded only for executing stored procedures. **Not supported on .NET Framework for System.Data.SqlClient.** | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) | +| Environment variable | Description | Default value | Status | +| ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------- | +| `OTEL_DOTNET_AUTO_ENTITYFRAMEWORKCORE_SET_DBSTATEMENT_FOR_TEXT` | Whether the Entity Framework Core instrumentation can pass SQL statements through the `db.statement` attribute. Queries might contain sensitive information. If set to `false`, `db.statement` is recorded only for executing stored procedures. | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `OTEL_DOTNET_AUTO_GRAPHQL_SET_DOCUMENT` | Whether the GraphQL instrumentation can pass raw queries through the `graphql.document` attribute. Queries might contain sensitive information. | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `OTEL_DOTNET_AUTO_SQLCLIENT_SET_DBSTATEMENT_FOR_TEXT` | Whether the SQL Client instrumentation can pass SQL statements through the `db.statement` attribute. Queries might contain sensitive information. If set to `false`, `db.statement` is recorded only for executing stored procedures. **Not supported on .NET Framework for System.Data.SqlClient.** | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTION` | Whether the ASP.NET Core instrumentation turns off redaction of the `url.query` attribute value. | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTION` | Whether the HTTP client instrumentation turns off redaction of the `url.full` attribute value. | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `OTEL_DOTNET_EXPERIMENTAL_ASPNET_DISABLE_URL_QUERY_REDACTION` | Whether the ASP.NET instrumentation turns off redaction of the `url.query` attribute value. | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) | diff --git a/content/en/docs/languages/net/automatic/nuget-packages.md b/content/en/docs/languages/net/automatic/nuget-packages.md index f909d2e310e4..dcaa41b8751d 100644 --- a/content/en/docs/languages/net/automatic/nuget-packages.md +++ b/content/en/docs/languages/net/automatic/nuget-packages.md @@ -46,7 +46,7 @@ you to either add the missing instrumentation package or to skip the instrumentation of the corresponding package: ```terminal -~packages/opentelemetry.autoinstrumentation.buildtasks/1.5.0/build/OpenTelemetry.AutoInstrumentation.BuildTasks.targets(29,5): error : OpenTelemetry.AutoInstrumentation: add a reference to the instrumentation package 'MongoDB.Driver.Core.Extensions.DiagnosticSources' version 1.4.0 or add 'MongoDB.Driver.Core' to the property 'SkippedInstrumentations' to suppress this error. +~packages/opentelemetry.autoinstrumentation.buildtasks/1.6.0/build/OpenTelemetry.AutoInstrumentation.BuildTasks.targets(29,5): error : OpenTelemetry.AutoInstrumentation: add a reference to the instrumentation package 'MongoDB.Driver.Core.Extensions.DiagnosticSources' version 1.4.0 or add 'MongoDB.Driver.Core' to the property 'SkippedInstrumentations' to suppress this error. ``` To resolve the error either add the recommended instrumentation package or skip diff --git a/content/en/docs/languages/net/automatic/troubleshooting.md b/content/en/docs/languages/net/automatic/troubleshooting.md index e1adf50e8078..618b3a71d919 100644 --- a/content/en/docs/languages/net/automatic/troubleshooting.md +++ b/content/en/docs/languages/net/automatic/troubleshooting.md @@ -60,7 +60,7 @@ When adding the NuGet packages to your project you get an error message similar to: ```txt -Could not install package 'OpenTelemetry.AutoInstrumentation.Runtime.Native 1.5.0'. You are trying to install this package into a project that targets '.NETFramework,Version=v4.7.2', but the package does not contain any assembly references or content files that are compatible with that framework. For more information, contact the package author. +Could not install package 'OpenTelemetry.AutoInstrumentation.Runtime.Native 1.6.0'. You are trying to install this package into a project that targets '.NETFramework,Version=v4.7.2', but the package does not contain any assembly references or content files that are compatible with that framework. For more information, contact the package author. ``` The NuGet packages don't support old-style `csproj` projects. Either deploy the