From c756eb438c42adc4f076c39aefb4947c9e2ec93b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Mon, 12 Feb 2024 19:09:55 +0100 Subject: [PATCH] Release 1.4.0 (#3265) * Fix redis instrumentation version * Release 1.4.0 * Add statement about SetDbStatement Not supported on .NET Framework for System.Data.SqlClient. --- CHANGELOG.md | 18 +++++++++++++++--- docs/README.md | 10 +++++----- docs/config.md | 10 +++++----- docs/troubleshooting.md | 2 +- docs/using-the-nuget-packages.md | 2 +- ...etry.AutoInstrumentation.BuildTasks.targets | 2 +- test/IntegrationTests/SqlClientSystemTests.cs | 2 ++ 7 files changed, 30 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 415aadccb3..00e3cc7d6c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,21 @@ All notable changes to this component are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/compare/v1.3.0..HEAD) +## [Unreleased](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/compare/v1.4.0..HEAD) + +### Added + +### Changed + +#### Dependency updates + +### Deprecated + +### Removed + +### Fixed + +## [1.4.0](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v1.4.0) ### Added @@ -39,8 +53,6 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h - .NET Framework only, following packages updated - `OpenTelemetry.Instrumentation.AspNet` from `1.7.0-beta.1` to `1.7.0-beta.2`. -### Deprecated - ### Removed - Container resource detector will be not executed on .NET Framework. diff --git a/docs/README.md b/docs/README.md index 3007659222..628848f0c0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,9 +12,9 @@ to .NET applications without having to modify their source code. > [!WARNING] > The following documentation refers to the in-development version of OpenTelemetry .NET Automatic Instrumentation. Docs for the latest version -([1.3.0](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest)) +([1.4.0](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest)) can be found in [opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/languages/net/automatic) -or [here](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.3.0/docs/README.md). +or [here](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.4.0/docs/README.md). --- @@ -164,7 +164,7 @@ Example usage: ```sh # Download the bash script -curl -sSfL https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/download/v1.3.0/otel-dotnet-auto-install.sh -O +curl -sSfL https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/download/v1.4.0/otel-dotnet-auto-install.sh -O # Install core files sh ./otel-dotnet-auto-install.sh @@ -187,7 +187,7 @@ uses environment variables as parameters: | `OTEL_DOTNET_AUTO_HOME` | Location where binaries are to be installed | No | `$HOME/.otel-dotnet-auto` | | `OS_TYPE` | Possible values: `linux-glibc`, `linux-musl`, `macos`, `windows` | No | *Calculated* | | `TMPDIR` | Temporary directory used when downloading the files | No | `$(mktemp -d)` | -| `VERSION` | Version to download | No | `1.3.0` | +| `VERSION` | Version to download | No | `1.4.0` | [instrument.sh](../instrument.sh) script uses environment variables as parameters: @@ -206,7 +206,7 @@ Example usage (run as administrator): ```powershell # Download the module -$module_url = "https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/download/v1.3.0/OpenTelemetry.DotNet.Auto.psm1" +$module_url = "https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/download/v1.4.0/OpenTelemetry.DotNet.Auto.psm1" $download_path = Join-Path $env:temp "OpenTelemetry.DotNet.Auto.psm1" Invoke-WebRequest -Uri $module_url -OutFile $download_path -UseBasicParsing diff --git a/docs/config.md b/docs/config.md index 88552867db..c32679cc4a 100644 --- a/docs/config.md +++ b/docs/config.md @@ -198,11 +198,11 @@ the `ASPNETCORE_HOSTINGSTARTUPASSEMBLIES` environment variable to ### 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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | -| `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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | -| `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. | `false` | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | +| 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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | +| `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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | +| `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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | ## Propagators diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index f8cf9b4a97..684a8183fc 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -62,7 +62,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.3.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.4.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. ``` #### Solution diff --git a/docs/using-the-nuget-packages.md b/docs/using-the-nuget-packages.md index 3c3cf80def..2e6e05fae5 100644 --- a/docs/using-the-nuget-packages.md +++ b/docs/using-the-nuget-packages.md @@ -40,7 +40,7 @@ you to either add the missing instrumentation package or to skip the instrumentation of the corresponding package: ```terminal -~packages/opentelemetry.autoinstrumentation.buildtasks/1.3.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.3.0 or add 'MongoDB.Driver.Core' to the property 'SkippedInstrumentations' to suppress this error. +~packages/opentelemetry.autoinstrumentation.buildtasks/1.4.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.3.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/src/OpenTelemetry.AutoInstrumentation.BuildTasks/OpenTelemetry.AutoInstrumentation.BuildTasks.targets b/src/OpenTelemetry.AutoInstrumentation.BuildTasks/OpenTelemetry.AutoInstrumentation.BuildTasks.targets index fda7e124c3..c634401e75 100644 --- a/src/OpenTelemetry.AutoInstrumentation.BuildTasks/OpenTelemetry.AutoInstrumentation.BuildTasks.targets +++ b/src/OpenTelemetry.AutoInstrumentation.BuildTasks/OpenTelemetry.AutoInstrumentation.BuildTasks.targets @@ -14,7 +14,7 @@ Condition="!$(SkippedInstrumentations.Contains('StackExchange.Redis')) AND !$(TargetFramework.StartsWith('net4'))" TargetNuGetPackageVersionRange="[2.1.58, 3.0.0)" InstrumentationNuGetPackageId="OpenTelemetry.Instrumentation.StackExchangeRedis" - InstrumentationNuGetPackageVersion="1.0.0-rc9.12" /> + InstrumentationNuGetPackageVersion="1.0.0-rc9.13" /> diff --git a/test/IntegrationTests/SqlClientSystemTests.cs b/test/IntegrationTests/SqlClientSystemTests.cs index dc4180d88c..28aa462f0d 100644 --- a/test/IntegrationTests/SqlClientSystemTests.cs +++ b/test/IntegrationTests/SqlClientSystemTests.cs @@ -22,7 +22,9 @@ public static IEnumerable GetData() { foreach (var version in LibraryVersion.SqlClientSystem) { +#if NET6_0_OR_GREATER yield return new[] { version[0], true }; +#endif yield return new[] { version[0], false }; } }