From 077dacfd109f8364d423726a7d2612c0f924e455 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Tue, 21 Nov 2023 19:21:08 +0100 Subject: [PATCH] Release 1.2.0 (#3135) * Changelog * Bump Meziantou.Framework.NuGetPackageValidation.Tool to 1.0.14 * Update IIS documentation. Removing specific versions as we do not have a fix in place. * Update external links * Update version in documentation * Fix Azure tests * Update documentation to 8.0.0 --- .github/workflows/build-nuget-packages.yml | 2 +- CHANGELOG.md | 26 ++++++++++++++----- docs/README.md | 12 ++++----- docs/config.md | 6 ++--- docs/iis-instrumentation.md | 3 +-- docs/manual-instrumentation.md | 4 +-- docs/troubleshooting.md | 2 +- docs/using-the-nuget-packages.md | 2 +- .../TestApplication.Azure.csproj | 3 ++- 9 files changed, 37 insertions(+), 23 deletions(-) diff --git a/.github/workflows/build-nuget-packages.yml b/.github/workflows/build-nuget-packages.yml index 4f4b0dbacf..c4d4124d7a 100644 --- a/.github/workflows/build-nuget-packages.yml +++ b/.github/workflows/build-nuget-packages.yml @@ -71,7 +71,7 @@ jobs: run: dotnet tool install --global dotnet-validate --version 0.0.1-preview.304 - name: Install Meziantou.Framework.NuGetPackageValidation.Tool - run: dotnet tool install --global Meziantou.Framework.NuGetPackageValidation.Tool --version 1.0.12 + run: dotnet tool install --global Meziantou.Framework.NuGetPackageValidation.Tool --version 1.0.14 - name: Validate nuget packages shell: pwsh diff --git a/CHANGELOG.md b/CHANGELOG.md index 99a80cc029..8c500c01c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,25 @@ 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.1.0..HEAD) +## [Unreleased](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/compare/v1.2.0..HEAD) + +### Added + +### Changed + +#### Dependency updates + +### Deprecated + +### Removed + +### Fixed + +## [1.2.0](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v1.2.0) + +- [Core components](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#core-components): + [`1.6.0`](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.6.0) +- `System.Diagnostics.DiagnosticSource`: [`8.0.0`](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/8.0.0) ### Added @@ -16,7 +34,7 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h ### Changed -### Dependency updates +#### Dependency updates - .NET Framework only, `Grpc.Core.Api` updated from `2.57.0` to `2.59.0`. - .NET only, `OpenTelemetry.Instrumentation.EntityFrameworkCore` updated @@ -52,15 +70,11 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h - `Microsoft.Extensions.Logging.Configuration` from `7.0.0` to `8.0.0`, - `System.Diagnostics.DiagnosticSource` from `7.0.2` to `8.0.0`. -### Deprecated - ### Removed - Removed support for `OpenTelemetry.Instrumentation.AspNetCore.AspNetCoreMetricsInstrumentationOptions` for plugins. -### Fixed - ## [1.1.0](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v1.1.0) ### Added diff --git a/docs/README.md b/docs/README.md index 741a401cb7..70c8457eaa 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,9 +10,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.1.0](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest)) +([1.2.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/instrumentation/net/automatic) -or [here](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.1.0/docs/README.md). +or [here](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.2.0/docs/README.md). --- @@ -43,7 +43,7 @@ OpenTelemetry .NET Automatic Instrumentation is built on top of - [Core components](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#core-components): [`1.6.0`](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.6.0) -- `System.Diagnostics.DiagnosticSource`: [`7.0.2`](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/7.0.2) +- `System.Diagnostics.DiagnosticSource`: [`8.0.0`](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/8.0.0) referencing `System.Runtime.CompilerServices.Unsafe`: [`6.0.0`](https://www.nuget.org/packages/System.Runtime.CompilerServices.Unsafe/6.0.0) You can find all references in @@ -162,7 +162,7 @@ Example usage: ```sh # Download the bash script -curl -sSfL https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/download/v1.1.0/otel-dotnet-auto-install.sh -O +curl -sSfL https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/download/v1.2.0/otel-dotnet-auto-install.sh -O # Install core files sh ./otel-dotnet-auto-install.sh @@ -185,7 +185,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.1.0` | +| `VERSION` | Version to download | No | `1.2.0` | [instrument.sh](../instrument.sh) script uses environment variables as parameters: @@ -204,7 +204,7 @@ Example usage (run as administrator): ```powershell # Download the module -$module_url = "https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/download/v1.1.0/OpenTelemetry.DotNet.Auto.psm1" +$module_url = "https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/download/v1.2.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 aa2a2a74c3..bf8b87b290 100644 --- a/docs/config.md +++ b/docs/config.md @@ -166,9 +166,9 @@ 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.6.0-beta.1/src/OpenTelemetry.Instrumentation.AspNet/README.md#list-of-metrics-produced) | * | source & bytecode | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | -| `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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | -| `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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | +| `ASPNET` | ASP.NET Framework \[1\] **Not supported on .NET** | [ASP.NET metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.AspNet-1.6.0-beta.2/src/OpenTelemetry.Instrumentation.AspNet/README.md#list-of-metrics-produced) | * | source & bytecode | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | +| `ASPNETCORE` | ASP.NET Core \[2\] **Not supported on .NET Framework** | [ASP.NET Core metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/1.6.0-beta.3/src/OpenTelemetry.Instrumentation.AspNetCore/README.md#list-of-metrics-produced) | * | source | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | +| `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/1.6.0-beta.3/src/OpenTelemetry.Instrumentation.Http/README.md#list-of-metrics-produced) | * | source | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | | `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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | | `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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | | `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](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) | diff --git a/docs/iis-instrumentation.md b/docs/iis-instrumentation.md index 970ba5da13..091c9d03bd 100644 --- a/docs/iis-instrumentation.md +++ b/docs/iis-instrumentation.md @@ -16,8 +16,7 @@ Install-OpenTelemetryCore Register-OpenTelemetryForIIS ``` -If you are using versions 0.7.0 - 1.1.0 of the OpenTelemetry .NET Automatic Instrumentation -and you are instrumenting an ASP.NET Core application, you must also configure +If you are instrumenting an ASP.NET Core application, you must also configure the application's application pool with `.NET CLR Version` set to `No Managed Code`. If this is not configured correctly, no telemetry data will be generated and the debug-level tracer logs will show that no ReJIT's (bytecode rewriting) have diff --git a/docs/manual-instrumentation.md b/docs/manual-instrumentation.md index 68d054d708..0596d24409 100644 --- a/docs/manual-instrumentation.md +++ b/docs/manual-instrumentation.md @@ -12,7 +12,7 @@ To create your custom traces manually, follow these steps: 1. Add the `System.Diagnostics.DiagnosticSource` dependency to your project: ```xml - + ``` 2. Create an `ActivitySource` instance: @@ -48,7 +48,7 @@ To create your custom metrics manually, follow these steps: 1. Add the `System.Diagnostics.DiagnosticSource` dependency to your project: ```xml - + ``` 2. Create a `Meter` instance: diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index fdd7476647..bd3f3a5b82 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.1.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.2.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 323c74285d..c79a73fd17 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.1.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.2.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/test/test-applications/integrations/TestApplication.Azure/TestApplication.Azure.csproj b/test/test-applications/integrations/TestApplication.Azure/TestApplication.Azure.csproj index 969d91021b..0883abc664 100644 --- a/test/test-applications/integrations/TestApplication.Azure/TestApplication.Azure.csproj +++ b/test/test-applications/integrations/TestApplication.Azure/TestApplication.Azure.csproj @@ -2,6 +2,7 @@ - + +