From 7d25f652b4f280ef726b6080206242e4e90e5ea2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Thu, 7 Sep 2023 09:09:13 +0200 Subject: [PATCH] Changelog + documentation --- CHANGELOG.md | 10 ++++++++++ docs/README.md | 4 ++-- docs/manual-instrumentation.md | 4 ++-- docs/plugins.md | 22 +++++++++++----------- 4 files changed, 25 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e8f55f764..e8a2b4e252 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,12 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h ## [Unreleased](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/compare/v1.0.0-rc.2...HEAD) +This release is built on top of [OpenTelemetry .NET](https://github.com/open-telemetry/opentelemetry-dotnet): + +- [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) + ### Added - Added support for Azure SDK traces instrumentation on .NET Framework. @@ -14,8 +20,12 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h ### Changed +- Updated [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). - [MySql.Data](https://www.nuget.org/packages/MySql.Data/) instrumentation is now supported from version 8.1.0 working on .NET. +- OpenTracing traces are registered under `opentracing-shim` name + instead of `OpenTelemetry.AutoInstrumentation.OpenTracingShim`. ### Deprecated diff --git a/docs/README.md b/docs/README.md index 5d34f08c43..072280dbfb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -41,8 +41,8 @@ OpenTelemetry .NET Automatic Instrumentation is built on top of [OpenTelemetry .NET](https://github.com/open-telemetry/opentelemetry-dotnet): - [Core components](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#core-components): -[`1.5.1`](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.5.1) -- `System.Diagnostics.DiagnosticSource`: [`7.0.0`](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/7.0.0) +[`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) 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 diff --git a/docs/manual-instrumentation.md b/docs/manual-instrumentation.md index ebbc86c41d..68d054d708 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/plugins.md b/docs/plugins.md index bce11fadab..7860019030 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -108,9 +108,9 @@ public class MyPlugin | Options type | NuGet package | NuGet version | |-------------------------------------------------------------------------------------------|---------------------------------------------------|---------------| -| OpenTelemetry.Exporter.ConsoleExporterOptions | OpenTelemetry.Exporter.Console | 1.5.1 | -| OpenTelemetry.Exporter.ZipkinExporterOptions | OpenTelemetry.Exporter.Zipkin | 1.5.1 | -| OpenTelemetry.Exporter.OtlpExporterOptions | OpenTelemetry.Exporter.OpenTelemetryProtocol | 1.5.1 | +| OpenTelemetry.Exporter.ConsoleExporterOptions | OpenTelemetry.Exporter.Console | 1.6.0 | +| OpenTelemetry.Exporter.ZipkinExporterOptions | OpenTelemetry.Exporter.Zipkin | 1.6.0 | +| OpenTelemetry.Exporter.OtlpExporterOptions | OpenTelemetry.Exporter.OpenTelemetryProtocol | 1.6.0 | | OpenTelemetry.Instrumentation.AspNet.AspNetInstrumentationOptions | OpenTelemetry.Instrumentation.AspNet | 1.0.0-rc9.9 | | OpenTelemetry.Instrumentation.AspNetCore.AspNetCoreInstrumentationOptions | OpenTelemetry.Instrumentation.AspNetCore | 1.5.1-beta.1 | | OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions | OpenTelemetry.Instrumentation.EntityFrameworkCore | 1.0.0-beta.7 | @@ -119,16 +119,16 @@ public class MyPlugin | OpenTelemetry.Instrumentation.Quartz.QuartzInstrumentationOptions | OpenTelemetry.Instrumentation.Quartz | 1.0.0-alpha.3 | | OpenTelemetry.Instrumentation.SqlClient.SqlClientInstrumentationOptions | OpenTelemetry.Instrumentation.SqlClient | 1.5.1-beta.1 | | OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions | OpenTelemetry.Instrumentation.StackExchangeRedis | 1.0.0-rc9.10 | -| OpenTelemetry.Instrumentation.Wcf.WcfInstrumentationOptions | OpenTelemetry.Instrumentation.Wcf | 1.0.0-rc.10 | +| OpenTelemetry.Instrumentation.Wcf.WcfInstrumentationOptions | OpenTelemetry.Instrumentation.Wcf | 1.0.0-rc.12 | ### Metrics | Options type | NuGet package | NuGet version | |----------------------------------------------------------------------------------|------------------------------------------------|---------------| -| OpenTelemetry.Metrics.MetricReaderOptions | OpenTelemetry | 1.5.1 | -| OpenTelemetry.Exporter.ConsoleExporterOptions | OpenTelemetry.Exporter.Console | 1.5.1 | -| OpenTelemetry.Exporter.PrometheusExporterOptions | OpenTelemetry.Exporter.Prometheus.HttpListener | 1.5.0-rc.1 | -| OpenTelemetry.Exporter.OtlpExporterOptions | OpenTelemetry.Exporter.OpenTelemetryProtocol | 1.5.1 | +| OpenTelemetry.Metrics.MetricReaderOptions | OpenTelemetry | 1.6.0 | +| OpenTelemetry.Exporter.ConsoleExporterOptions | OpenTelemetry.Exporter.Console | 1.6.0 | +| OpenTelemetry.Exporter.PrometheusExporterOptions | OpenTelemetry.Exporter.Prometheus.HttpListener | 1.6.0-rc.1 | +| OpenTelemetry.Exporter.OtlpExporterOptions | OpenTelemetry.Exporter.OpenTelemetryProtocol | 1.6.0 | | OpenTelemetry.Instrumentation.AspNetCore.AspNetCoreMetricsInstrumentationOptions | OpenTelemetry.Instrumentation.AspNetCore | 1.5.1-beta.1 | | OpenTelemetry.Instrumentation.Runtime.RuntimeInstrumentationOptions | OpenTelemetry.Instrumentation.Runtime | 1.5.1 | @@ -136,9 +136,9 @@ public class MyPlugin | Options type | NuGet package | NuGet version | |-----------------------------------------------|----------------------------------------------|---------------| -| OpenTelemetry.Logs.OpenTelemetryLoggerOptions | OpenTelemetry | 1.5.0-rc.1 | -| OpenTelemetry.Exporter.ConsoleExporterOptions | OpenTelemetry.Exporter.Console | 1.5.1 | -| OpenTelemetry.Exporter.OtlpExporterOptions | OpenTelemetry.Exporter.OpenTelemetryProtocol | 1.5.1 | +| OpenTelemetry.Logs.OpenTelemetryLoggerOptions | OpenTelemetry | 1.6.0 | +| OpenTelemetry.Exporter.ConsoleExporterOptions | OpenTelemetry.Exporter.Console | 1.6.0 | +| OpenTelemetry.Exporter.OtlpExporterOptions | OpenTelemetry.Exporter.OpenTelemetryProtocol | 1.6.0 | ## Requirements