From b3a921af196d2a6ed2a42120f2aa05a9516d47d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Tue, 15 Nov 2022 18:22:27 +0100 Subject: [PATCH] Link fixes (#737) --- .github/workflows/markdownlint.yml | 2 +- .../CHANGELOG.md | 2 +- src/OpenTelemetry.Instrumentation.AspNet/README.md | 12 ++++++------ .../README.md | 2 +- .../README.md | 2 +- src/OpenTelemetry.Instrumentation.Quartz/README.md | 2 +- .../README.md | 6 +++--- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml index 97f85f9e2b..fec61cedeb 100644 --- a/.github/workflows/markdownlint.yml +++ b/.github/workflows/markdownlint.yml @@ -16,7 +16,7 @@ jobs: steps: - name: check out code - uses: actions/checkout@v3 + uses: actions/checkout@v3.1.0 - name: install markdownlint-cli run: sudo npm install -g markdownlint-cli diff --git a/src/OpenTelemetry.Instrumentation.AspNet/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.AspNet/CHANGELOG.md index ca186294be..d859c59e1b 100644 --- a/src/OpenTelemetry.Instrumentation.AspNet/CHANGELOG.md +++ b/src/OpenTelemetry.Instrumentation.AspNet/CHANGELOG.md @@ -71,7 +71,7 @@ Released 2021-Oct-08 [Microsoft.AspNet.TelemetryCorrelation](https://www.nuget.org/packages/Microsoft.AspNet.TelemetryCorrelation/) to listen for incoming http requests to the process. Please see the (Step 2: Modify - Web.config)[https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Instrumentation.AspNet#step-2-modify-webconfig] + Web.config)[https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.AspNet#step-2-modify-webconfig] README section for details on the new HttpModule definition required. ([#2222](https://github.com/open-telemetry/opentelemetry-dotnet/issues/2222)) diff --git a/src/OpenTelemetry.Instrumentation.AspNet/README.md b/src/OpenTelemetry.Instrumentation.AspNet/README.md index 3a2ed2c1b7..aa73d15b14 100644 --- a/src/OpenTelemetry.Instrumentation.AspNet/README.md +++ b/src/OpenTelemetry.Instrumentation.AspNet/README.md @@ -14,7 +14,7 @@ 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](../../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 @@ -57,8 +57,8 @@ following shows changes required to your `Web.config` when using IIS web server. ASP.NET instrumentation must be enabled at application startup. This is typically done in the `Global.asax.cs` as shown below. This example also sets up the OpenTelemetry Jaeger exporter, which requires adding the package -[`OpenTelemetry.Exporter.Jaeger`](../OpenTelemetry.Exporter.Jaeger/README.md) to -the application. +[`OpenTelemetry.Exporter.Jaeger`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Jaeger/README.md) +to the application. ```csharp using OpenTelemetry; @@ -150,9 +150,9 @@ this.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 `HttpRequest` and `HttpResponse`. ### RecordException diff --git a/src/OpenTelemetry.Instrumentation.MassTransit/README.md b/src/OpenTelemetry.Instrumentation.MassTransit/README.md index f6067618dc..cacb56f8a1 100644 --- a/src/OpenTelemetry.Instrumentation.MassTransit/README.md +++ b/src/OpenTelemetry.Instrumentation.MassTransit/README.md @@ -64,7 +64,7 @@ x.AddMassTransitInstrumentation( })); ``` -For full operation list please see: [OperationName](../OpenTelemetry.Instrumentation.MassTransit/Implementation/OperationName.cs). +For full operation list please see: [OperationName](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 ea6cb7deee..1aded70cb7 100644 --- a/src/OpenTelemetry.Instrumentation.MySqlData/README.md +++ b/src/OpenTelemetry.Instrumentation.MySqlData/README.md @@ -50,7 +50,7 @@ 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). For an ASP.NET application, adding instrumentation is typically done in the -`Global.asax.cs`. Refer to documentation for [OpenTelemetry.Instrumentation.AspNet](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNet/README.md). +`Global.asax.cs`. Refer to documentation for [OpenTelemetry.Instrumentation.AspNet](../OpenTelemetry.Instrumentation.AspNet/README.md). Note, If you are using `Mysql.Data` 8.0.31 or later, please add option `Logging=true` in your connection string to enable tracing. diff --git a/src/OpenTelemetry.Instrumentation.Quartz/README.md b/src/OpenTelemetry.Instrumentation.Quartz/README.md index 6967b65841..da549407b2 100644 --- a/src/OpenTelemetry.Instrumentation.Quartz/README.md +++ b/src/OpenTelemetry.Instrumentation.Quartz/README.md @@ -70,7 +70,7 @@ x.AddQuartzInstrumentation( ``` For full operation list please see: -[OperationName](../OpenTelemetry.Instrumentation.Quartz/Implementation/OperationName.cs). +[OperationName](OperationName.cs). All operations are enabled by default. diff --git a/src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md b/src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md index 5b109755fb..167cae9ff4 100644 --- a/src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md +++ b/src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md @@ -13,7 +13,7 @@ and collects traces about outgoing calls to Redis. [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](../../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 @@ -42,7 +42,7 @@ to make Redis calls. Only those Redis calls made using the same instance of the The following example demonstrates adding StackExchange.Redis instrumentation 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 @@ -65,7 +65,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](../OpenTelemetry.Instrumentation.AspNetCore/README.md). +[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/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).