From 46e0c60035b239845f455697efd49720f70521f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Mon, 16 Dec 2024 21:47:10 +0100 Subject: [PATCH] [documentation] Fix links (#2423) --- CONTRIBUTING.md | 2 +- README.md | 2 +- src/OpenTelemetry.Exporter.InfluxDB/README.md | 2 +- src/OpenTelemetry.Extensions.AWS/CHANGELOG.md | 2 +- .../README.md | 14 +++----------- .../README.md | 14 +++++++------- .../README.md | 4 ++-- .../README.md | 13 ++++++------- .../README.md | 10 ++++------ .../README.md | 5 +++-- .../CHANGELOG.md | 2 +- .../README.md | 9 ++++----- .../CHANGELOG.md | 2 +- .../README.md | 18 +++++++++--------- .../README.md | 2 +- .../README.md | 10 +++++----- .../README.md | 4 ++-- .../README.md | 4 ++-- .../README.md | 2 +- .../README.md | 11 +++++------ .../README.md | 7 +++---- .../CHANGELOG.md | 2 +- 22 files changed, 64 insertions(+), 77 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45df3c028c..de776feb7b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -168,7 +168,7 @@ A PR is considered to be **ready to merge** when: Any maintainer can merge PRs once they are **ready to merge** however maintainers might decide to wait on merging changes until there are more -approvals and/or dicussion, or based on other factors such as release timing and +approvals and/or discussion, or based on other factors such as release timing and risk to users. For example if a stable release is planned and a new change is introduced adding public API(s) or behavioral changes it might be held until the next alpha/beta release. diff --git a/README.md b/README.md index cab0fc0fdc..f553a9afb3 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ repository](https://github.com/open-telemetry/community/blob/main/guides/contrib * [Piotr Kiełkowicz](https://github.com/Kielek), Splunk *Find more about the maintainer role in [community -repository](h[ttps://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer)).* +repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).* ### Emeritus diff --git a/src/OpenTelemetry.Exporter.InfluxDB/README.md b/src/OpenTelemetry.Exporter.InfluxDB/README.md index 3dfbbb893f..590e11e4b9 100644 --- a/src/OpenTelemetry.Exporter.InfluxDB/README.md +++ b/src/OpenTelemetry.Exporter.InfluxDB/README.md @@ -26,7 +26,7 @@ dotnet add package --prerelease OpenTelemetry.Exporter.InfluxDB ### Step 2: Configure OpenTelemetry MeterProvider -* When using the [OpenTelemetry.Extensions.Hosting](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Extensions.Hosting/README.md) +* When using the [OpenTelemetry.Extensions.Hosting](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Extensions.Hosting/README.md) package on .NET 6.0+: ```csharp diff --git a/src/OpenTelemetry.Extensions.AWS/CHANGELOG.md b/src/OpenTelemetry.Extensions.AWS/CHANGELOG.md index 057affda10..27d883bd1a 100644 --- a/src/OpenTelemetry.Extensions.AWS/CHANGELOG.md +++ b/src/OpenTelemetry.Extensions.AWS/CHANGELOG.md @@ -103,4 +103,4 @@ SDK](https://www.nuget.org/packages/OpenTelemetry/). The AWSXRay extensions include plugin to generate X-Ray format trace-ids and a propagator to propagate the X-Ray trace header to downstream. For more details, please refer to the -[README](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Contrib.Extensions.AWSXRay/README.md) +[README](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Extensions.AWS/README.md) diff --git a/src/OpenTelemetry.Instrumentation.AspNet/README.md b/src/OpenTelemetry.Instrumentation.AspNet/README.md index 4e9c7b5447..ce0fc4a879 100644 --- a/src/OpenTelemetry.Instrumentation.AspNet/README.md +++ b/src/OpenTelemetry.Instrumentation.AspNet/README.md @@ -15,17 +15,9 @@ which instruments [ASP.NET](https://docs.microsoft.com/aspnet/overview) and collect metrics and traces about incoming web requests. > [!NOTE] -> This component is based on the OpenTelemetry semantic conventions for -[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions) -and -[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions). -These conventions are -[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md), -and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases). -Until a [stable -version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md) -is released, there can be breaking changes. You can track the progress from -[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23). +> This package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases). +Until a [stable version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md) +is released, there can be breaking changes. ## Steps to enable OpenTelemetry.Instrumentation.AspNet diff --git a/src/OpenTelemetry.Instrumentation.AspNetCore/README.md b/src/OpenTelemetry.Instrumentation.AspNetCore/README.md index 12a76ed607..7ca1c3350e 100644 --- a/src/OpenTelemetry.Instrumentation.AspNetCore/README.md +++ b/src/OpenTelemetry.Instrumentation.AspNetCore/README.md @@ -41,7 +41,7 @@ ASP.NET Core instrumentation must be enabled at application startup. This is typically done in the `ConfigureServices` of your `Startup` class. Both examples below enables OpenTelemetry by calling `AddOpenTelemetry()` on `IServiceCollection`. This extension method requires adding the package -[`OpenTelemetry.Extensions.Hosting`](../OpenTelemetry.Extensions.Hosting/README.md) +[`OpenTelemetry.Extensions.Hosting`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Extensions.Hosting/README.md) to the application. This ensures instrumentations are disposed when the host is shutdown. @@ -51,7 +51,7 @@ The following example demonstrates adding ASP.NET Core instrumentation with the extension method `WithTracing()` on `OpenTelemetryBuilder`. then extension method `AddAspNetCoreInstrumentation()` on `TracerProviderBuilder` to the application. This example also sets up the Console Exporter, -which requires adding the package [`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md) +which requires adding the package [`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md) to the application. ```csharp @@ -97,7 +97,7 @@ The following example demonstrates adding ASP.NET Core instrumentation with the extension method `WithMetrics()` on `OpenTelemetryBuilder` then extension method `AddAspNetCoreInstrumentation()` on `MeterProviderBuilder` to the application. This example also sets up the Console Exporter, -which requires adding the package [`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md) +which requires adding the package [`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md) to the application. ```csharp @@ -185,7 +185,7 @@ This instrumentation can be configured to change the default behavior by using // TODO: This section could be refined. When used with -[`OpenTelemetry.Extensions.Hosting`](../OpenTelemetry.Extensions.Hosting/README.md), +[`OpenTelemetry.Extensions.Hosting`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Extensions.Hosting/README.md), all configurations to `AspNetCoreTraceInstrumentationOptions` can be done in the `ConfigureServices` method of you applications `Startup` class as shown below. @@ -270,7 +270,7 @@ services.AddOpenTelemetry() })); ``` -[Processor](../../docs/trace/extending-the-sdk/README.md#processor), +[Processor](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/docs/trace/extending-the-sdk/README.md#processor), is the general extensibility point to add additional properties to any activity. The `Enrich` option is specific to this instrumentation, and is provided to get access to `HttpRequest` and `HttpResponse`. @@ -365,8 +365,8 @@ This component uses an [EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource) with the name "OpenTelemetry-Instrumentation-AspNetCore" for its internal logging. Please refer to [SDK -troubleshooting](../OpenTelemetry/README.md#troubleshooting) for instructions on -seeing these internal logs. +troubleshooting](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry/README.md#troubleshooting) +for instructions on seeing these internal logs. ## References diff --git a/src/OpenTelemetry.Instrumentation.Cassandra/README.md b/src/OpenTelemetry.Instrumentation.Cassandra/README.md index d9dcda3611..6909fbc03f 100644 --- a/src/OpenTelemetry.Instrumentation.Cassandra/README.md +++ b/src/OpenTelemetry.Instrumentation.Cassandra/README.md @@ -63,7 +63,7 @@ public class Program For an ASP.NET Core application, adding instrumentation is typically done in the `ConfigureServices` of your `Startup` class. Refer to documentation for -[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md). +[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md). For an ASP.NET application, adding instrumentation is typically done in the `Global.asax.cs`. Refer to documentation for [OpenTelemetry.Instrumentation.AspNet](../OpenTelemetry.Instrumentation.AspNet/README.md). @@ -101,6 +101,6 @@ var cluster = new Builder() * [OpenTelemetry Project](https://opentelemetry.io/) -* [OpenTelemetry semantic conventions for database calls](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md) +* [OpenTelemetry semantic conventions for Cassandra](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/cassandra.md) * [Cassandra C# Driver](https://github.com/datastax/csharp-driver) diff --git a/src/OpenTelemetry.Instrumentation.ElasticsearchClient/README.md b/src/OpenTelemetry.Instrumentation.ElasticsearchClient/README.md index 690efee13a..1b16f1af16 100644 --- a/src/OpenTelemetry.Instrumentation.ElasticsearchClient/README.md +++ b/src/OpenTelemetry.Instrumentation.ElasticsearchClient/README.md @@ -16,19 +16,18 @@ Library](https://github.com/open-telemetry/opentelemetry-specification/blob/main which instruments [NEST/Elasticsearch.Net](https://www.nuget.org/packages/NEST) and collects traces about outgoing requests. -**Note: This component is based on the OpenTelemetry semantic conventions for -[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions) +> [!NOTE] +> This component is based on the OpenTelemetry semantic conventions for +[metrics](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/elasticsearch.md) and -[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions). +[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/elasticsearch.md). These conventions are [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md), and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases). Until a [stable version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md) -is released, there can be [breaking changes](./CHANGELOG.md). You can track the -progress from -[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).** +is released, there can be [breaking changes](./CHANGELOG.md). ## Steps to enable OpenTelemetry.Instrumentation.ElasticsearchClient @@ -70,7 +69,7 @@ public class Program For an ASP.NET Core application, adding instrumentation is typically done in the `ConfigureServices` of your `Startup` class. Refer to documentation for -[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md). +[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md). For an ASP.NET application, adding instrumentation is typically done in the `Global.asax.cs`. Refer to the documentation for diff --git a/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/README.md b/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/README.md index 0a37df8cee..c545251eb9 100644 --- a/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/README.md +++ b/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/README.md @@ -16,18 +16,16 @@ which instruments and collects traces about outgoing requests. **Note: This component is based on the OpenTelemetry semantic conventions for -[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions) +[metrics](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-metrics.md) and -[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions). +[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md). These conventions are [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md), and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases). Until a [stable version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md) -is released, there can be [breaking changes](./CHANGELOG.md). You can track the -progress from -[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).** +is released, there can be [breaking changes](./CHANGELOG.md).** ## Steps to enable OpenTelemetry.Instrumentation.EntityFrameworkCore @@ -68,7 +66,7 @@ public class Program For an ASP.NET Core application, adding instrumentation is typically done in the `ConfigureServices` of your `Startup` class. Refer to documentation for -[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md). +[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md). For an ASP.NET application, adding instrumentation is typically done in the `Global.asax.cs`. Refer to the documentation for diff --git a/src/OpenTelemetry.Instrumentation.GrpcCore/README.md b/src/OpenTelemetry.Instrumentation.GrpcCore/README.md index a4b2489ddd..b2d23b106d 100644 --- a/src/OpenTelemetry.Instrumentation.GrpcCore/README.md +++ b/src/OpenTelemetry.Instrumentation.GrpcCore/README.md @@ -13,13 +13,14 @@ Adds OpenTelemetry instrumentation for gRPC Core-based client and server calls. gRPC Core is the predecessor to ASP.NET Core gRPC. See -For ASP.NET Core gRPC client instrumentation see +For ASP.NET Core gRPC client instrumentation see +[OpenTelemetry.Instrumentation.GrpcNetClient](../OpenTelemetry.Instrumentation.GrpcNetClient/README.md). For ASP.NET Core gRPC server instrumentation is bundled within the AspNetCore instrumentation. Each inbound or outbound gRPC call will generate a Span which follows the -semantic RPC specification +[semantic RPC specification](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md). ## Installation diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md index 50a8581489..6652dec550 100644 --- a/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md +++ b/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md @@ -32,7 +32,7 @@ Released 2024-Feb-09 * **Breaking Change**: Please be advised that the - [SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation) + [SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation) option no longer works when used in conjunction with the `OpenTelemetry.Instrumentation.Http` package version `1.6.0` or greater. This is not a result of a change in the `OpenTelemetry.Instrumentation.GrpcNetClient` diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md index 1941ded778..f385395c68 100644 --- a/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md +++ b/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md @@ -18,11 +18,10 @@ and collects traces about outgoing gRPC requests. [traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md). These conventions are [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md), -and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases). +and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/VERSIONING.md#pre-releases). Until a [stable version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md) -is released, there can be breaking changes. You can track the progress from -[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23). +is released, there can be breaking changes. ## Supported .NET Versions @@ -50,7 +49,7 @@ The following example demonstrates adding Grpc.Net.Client instrumentation to a console application. This example also sets up the OpenTelemetry Console exporter and adds instrumentation for HttpClient, which requires adding the packages -[`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md) +[`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md) and [`OpenTelemetry.Instrumentation.Http`](../OpenTelemetry.Instrumentation.Http/README.md) to the application. As Grpc.Net.Client uses HttpClient underneath, it is @@ -135,7 +134,7 @@ services.AddOpenTelemetry() }); ``` -[Processor](../../docs/trace/extending-the-sdk/README.md#processor), +[Processor](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace/extending-the-sdk/README.md#processor), is the general extensibility point to add additional properties to any activity. The `Enrich` option is specific to this instrumentation, and is provided to get access to `HttpRequest` and `HttpResponse`. diff --git a/src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md index 3e90df8b9b..6b909b08ac 100644 --- a/src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md +++ b/src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md @@ -88,7 +88,7 @@ Released 2023-Dec-01 * Removed reference to `OpenTelemetry` package. This is a **breaking change** for users relying on - [SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation) + [SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation) option in `OpenTelemetry.Instrumentation.GrpcNetClient`. For details, check out this [issue](https://github.com/open-telemetry/opentelemetry-dotnet/issues/5092). diff --git a/src/OpenTelemetry.Instrumentation.Http/README.md b/src/OpenTelemetry.Instrumentation.Http/README.md index df39d39614..570f2dcf74 100644 --- a/src/OpenTelemetry.Instrumentation.Http/README.md +++ b/src/OpenTelemetry.Instrumentation.Http/README.md @@ -52,7 +52,7 @@ The following example demonstrates adding `HttpClient` instrumentation with the extension method `.AddHttpClientInstrumentation()` on `TracerProviderBuilder` to a console application. This example also sets up the OpenTelemetry Console Exporter, which requires adding the package -[`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md) +[`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md) to the application. ```csharp @@ -97,7 +97,7 @@ The following example demonstrates adding `HttpClient` instrumentation with the extension method `.AddHttpClientInstrumentation()` on `MeterProviderBuilder` to a console application. This example also sets up the OpenTelemetry Console Exporter, which requires adding the package -[`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md) +[`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md) to the application. ```csharp @@ -116,8 +116,8 @@ public class Program } ``` -Refer to this [example](../../examples/AspNetCore/Program.cs) to see how to -enable this instrumentation in an ASP.NET core application. +Refer to this [example](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/examples/AspNetCore/Program.cs) +to see how to enable this instrumentation in an ASP.NET Core application. Refer to this [example](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Instrumentation.AspNet/README.md) @@ -344,9 +344,9 @@ var tracerProvider = Sdk.CreateTracerProviderBuilder() .Build(); ``` -[Processor](../../docs/trace/extending-the-sdk/README.md#processor), is the -general extensibility point to add additional properties to any activity. The -`Enrich` option is specific to this instrumentation, and is provided to get +[Processor](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/docs/trace/extending-the-sdk/README.md#processor), +is the general extensibility point to add additional properties to any activity. +The `Enrich` option is specific to this instrumentation, and is provided to get access to raw request, response, and exception objects. When overriding the default settings provided by instrumentation or adding @@ -406,8 +406,8 @@ This component uses an [EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource) with the name "OpenTelemetry-Instrumentation-Http" for its internal logging. Please refer to [SDK -troubleshooting](../OpenTelemetry/README.md#troubleshooting) for instructions on -seeing these internal logs. +troubleshooting](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry/README.md#troubleshooting) +for instructions on seeing these internal logs. ## References diff --git a/src/OpenTelemetry.Instrumentation.MassTransit/README.md b/src/OpenTelemetry.Instrumentation.MassTransit/README.md index 2183728485..dd5bcd13b7 100644 --- a/src/OpenTelemetry.Instrumentation.MassTransit/README.md +++ b/src/OpenTelemetry.Instrumentation.MassTransit/README.md @@ -75,7 +75,7 @@ x.AddMassTransitInstrumentation( })); ``` -For full operation list please see: [OperationName](OperationName.cs). +For full operation list please see: [OperationName](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.MassTransit-1.0.0-beta.3/src/OpenTelemetry.Instrumentation.MassTransit/OperationName.cs). All operations are enabled by default. diff --git a/src/OpenTelemetry.Instrumentation.MySqlData/README.md b/src/OpenTelemetry.Instrumentation.MySqlData/README.md index 6671c3ba39..6df201d3cf 100644 --- a/src/OpenTelemetry.Instrumentation.MySqlData/README.md +++ b/src/OpenTelemetry.Instrumentation.MySqlData/README.md @@ -60,7 +60,7 @@ public class Program For an ASP.NET Core application, adding instrumentation is typically done in the `ConfigureServices` of your `Startup` class. Refer to documentation for -[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md). +[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md). For an ASP.NET application, adding instrumentation is typically done in the `Global.asax.cs`. Refer to documentation for [OpenTelemetry.Instrumentation.AspNet](../OpenTelemetry.Instrumentation.AspNet/README.md). @@ -78,13 +78,13 @@ This instrumentation can be configured to change the default behavior by using ### Capturing 'db.statement' The `MySqlDataInstrumentationOptions` class exposes several properties that can be -used to configure how the [`db.statement`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md#call-level-attributes) +used to configure how the [`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/mysql.md) attribute is captured upon execution of a query. #### SetDbStatement The `SetDbStatement` property can be used to control whether this instrumentation -should set the [`db.statement`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md#call-level-attributes) +should set the [`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/mysql.md) attribute to the text of the `MySqlCommand` being executed. Since `CommandType.Text` might contain sensitive data, SQL capturing is @@ -124,7 +124,7 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder() ### RecordException This option can be set to instruct the instrumentation to record Exceptions -as Activity [events](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/exceptions.md). +as Activity [events](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md). > Due to the limitation of this library's implementation, We cannot get the raw `MysqlException`, > only exception message is available. @@ -143,4 +143,4 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder() * [OpenTelemetry Project](https://opentelemetry.io/) -* [OpenTelemetry semantic conventions for database calls](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md) +* [OpenTelemetry semantic conventions for MySQL](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/mysql.md) diff --git a/src/OpenTelemetry.Instrumentation.Owin/README.md b/src/OpenTelemetry.Instrumentation.Owin/README.md index f2553161b3..afdb703055 100644 --- a/src/OpenTelemetry.Instrumentation.Owin/README.md +++ b/src/OpenTelemetry.Instrumentation.Owin/README.md @@ -95,7 +95,7 @@ even if tracing is disabled. ``` The instrumentation is implemented based on [metrics semantic -conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/http-metrics.md#metric-httpserverduration). +conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md#metric-httpserverrequestduration). Currently, the instrumentation supports the following metric. | Name | Instrument Type | Unit | Description | @@ -107,7 +107,7 @@ Currently, the instrumentation supports the following metric. The OpenTelemetry OWIN instrumentation will create spans with very generic names based on the http method of the request. For example: `HTTP GET` or `HTTP POST`. The reason for this is the [OpenTelemetry Specification http semantic -conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#name) +conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#name) call specifically for low cardinality values and OWIN does not expose any kind of route template. diff --git a/src/OpenTelemetry.Instrumentation.Process/README.md b/src/OpenTelemetry.Instrumentation.Process/README.md index 4cebfd9a1e..46eb214cc5 100644 --- a/src/OpenTelemetry.Instrumentation.Process/README.md +++ b/src/OpenTelemetry.Instrumentation.Process/README.md @@ -16,7 +16,7 @@ telemetry about process behavior. The process metric instruments being implemented are following OpenTelemetry [metrics semantic -conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/process-metrics.md#metric-instruments). +conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/system/process-metrics.md). ## Steps to enable OpenTelemetry.Instrumentation.Process @@ -133,7 +133,7 @@ The API used to retrieve the value is > This metric is under > [discussion](https://github.com/open-telemetry/opentelemetry-specification/issues/3200) and not part of the [Process Metrics -Spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/process-metrics.md) +Spec](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/system/process-metrics.md) at this time. ### process.thread.count diff --git a/src/OpenTelemetry.Instrumentation.Quartz/README.md b/src/OpenTelemetry.Instrumentation.Quartz/README.md index 1ce4f8aac0..c98a9d35fd 100644 --- a/src/OpenTelemetry.Instrumentation.Quartz/README.md +++ b/src/OpenTelemetry.Instrumentation.Quartz/README.md @@ -17,7 +17,7 @@ Automatically instruments the Quartz jobs from QuartzNET Instrumentation is only supported when using .NET Framework >= `net472` and .NET Standard >= `netstandard2.0`. Quartz`net461` support for activity sources has been removed, more information can be found -[here](https://www.quartz-scheduler.net/2021/04/07/quartznet-3-3-released/). +[here](https://github.com/quartznet/quartznet/releases/tag/v3.3.0). ## Installation diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/README.md b/src/OpenTelemetry.Instrumentation.SqlClient/README.md index 96d36f896b..d77db1ce59 100644 --- a/src/OpenTelemetry.Instrumentation.SqlClient/README.md +++ b/src/OpenTelemetry.Instrumentation.SqlClient/README.md @@ -27,11 +27,10 @@ and later. [traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md). These conventions are [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md), -and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases). +and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases). Until a [stable version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md) -is released, there can be breaking changes. You can track the progress from -[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23). +is released, there can be breaking changes. ## Steps to enable OpenTelemetry.Instrumentation.SqlClient @@ -223,9 +222,9 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder() .Build(); ``` -[Processor](../../docs/trace/extending-the-sdk/README.md#processor), is the -general extensibility point to add additional properties to any activity. The -`Enrich` option is specific to this instrumentation, and is provided to get +[Processor](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace/extending-the-sdk/README.md#processor), +is the general extensibility point to add additional properties to any activity. +The `Enrich` option is specific to this instrumentation, and is provided to get access to `SqlCommand` object. ### RecordException diff --git a/src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md b/src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md index cf9efeae8f..bfcc48ca73 100644 --- a/src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md +++ b/src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md @@ -17,14 +17,13 @@ and collects traces about outgoing calls to Redis. > [!NOTE] > This component is based on the OpenTelemetry semantic conventions for -[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions). +[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/redis.md). These conventions are [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md), and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases). Until a [stable version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md) -is released, there can be breaking changes. You can track the progress from -[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23). +is released, there can be breaking changes. ## Steps to enable OpenTelemetry.Instrumentation.StackExchangeRedis @@ -72,7 +71,7 @@ public class Program For an ASP.NET Core application, adding instrumentation is typically done in the `ConfigureServices` of your `Startup` class. Refer to documentation for -[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md). +[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md). For an ASP.NET application, adding instrumentation is typically done in the `Global.asax.cs`. Refer to documentation for [OpenTelemetry.Instrumentation.AspNet](../OpenTelemetry.Instrumentation.AspNet/README.md). diff --git a/src/OpenTelemetry.PersistentStorage.FileSystem/CHANGELOG.md b/src/OpenTelemetry.PersistentStorage.FileSystem/CHANGELOG.md index 89a5d7a7a7..59bfc34787 100644 --- a/src/OpenTelemetry.PersistentStorage.FileSystem/CHANGELOG.md +++ b/src/OpenTelemetry.PersistentStorage.FileSystem/CHANGELOG.md @@ -21,7 +21,7 @@ Released 2023-Apr-17 ([#1110](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1110)) * Going forward the NuGet package will be - [`OpenTelemetry.PersistentStorage.FileSystem`](https://www.nuget.org/packages/OpenTelemetry.Extensions.FileSystem). + [`OpenTelemetry.PersistentStorage.FileSystem`](https://www.nuget.org/packages/OpenTelemetry.PersistentStorage.FileSystem). Older versions will remain at [`OpenTelemetry.Extensions.PersistentStorage`](https://www.nuget.org/packages/OpenTelemetry.Extensions.PersistentStorage) [(#1079)](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1079)