Skip to content

Commit 46e0c60

Browse files
authoredDec 16, 2024
[documentation] Fix links (#2423)
1 parent 1ca0568 commit 46e0c60

File tree

22 files changed

+64
-77
lines changed

22 files changed

+64
-77
lines changed
 

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ A PR is considered to be **ready to merge** when:
168168

169169
Any maintainer can merge PRs once they are **ready to merge** however
170170
maintainers might decide to wait on merging changes until there are more
171-
approvals and/or dicussion, or based on other factors such as release timing and
171+
approvals and/or discussion, or based on other factors such as release timing and
172172
risk to users. For example if a stable release is planned and a new change is
173173
introduced adding public API(s) or behavioral changes it might be held until the
174174
next alpha/beta release.

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ repository](https://github.com/open-telemetry/community/blob/main/guides/contrib
9494
* [Piotr Kiełkowicz](https://github.com/Kielek), Splunk
9595

9696
*Find more about the maintainer role in [community
97-
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)).*
97+
repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).*
9898

9999
### Emeritus
100100

‎src/OpenTelemetry.Exporter.InfluxDB/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ dotnet add package --prerelease OpenTelemetry.Exporter.InfluxDB
2626

2727
### Step 2: Configure OpenTelemetry MeterProvider
2828

29-
* When using the [OpenTelemetry.Extensions.Hosting](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Extensions.Hosting/README.md)
29+
* When using the [OpenTelemetry.Extensions.Hosting](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Extensions.Hosting/README.md)
3030
package on .NET 6.0+:
3131

3232
```csharp

‎src/OpenTelemetry.Extensions.AWS/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,4 +103,4 @@ SDK](https://www.nuget.org/packages/OpenTelemetry/).
103103
The AWSXRay extensions include plugin to generate X-Ray format trace-ids and a
104104
propagator to propagate the X-Ray trace header to downstream. For more details,
105105
please refer to the
106-
[README](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Contrib.Extensions.AWSXRay/README.md)
106+
[README](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Extensions.AWS/README.md)

‎src/OpenTelemetry.Instrumentation.AspNet/README.md

+3-11
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,9 @@ which instruments [ASP.NET](https://docs.microsoft.com/aspnet/overview) and
1515
collect metrics and traces about incoming web requests.
1616

1717
> [!NOTE]
18-
> This component is based on the OpenTelemetry semantic conventions for
19-
[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions)
20-
and
21-
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
22-
These conventions are
23-
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
24-
and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases).
25-
Until a [stable
26-
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
27-
is released, there can be breaking changes. You can track the progress from
28-
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).
18+
> This package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases).
19+
Until a [stable version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
20+
is released, there can be breaking changes.
2921

3022
## Steps to enable OpenTelemetry.Instrumentation.AspNet
3123

‎src/OpenTelemetry.Instrumentation.AspNetCore/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ ASP.NET Core instrumentation must be enabled at application startup. This is
4141
typically done in the `ConfigureServices` of your `Startup` class. Both examples
4242
below enables OpenTelemetry by calling `AddOpenTelemetry()` on `IServiceCollection`.
4343
This extension method requires adding the package
44-
[`OpenTelemetry.Extensions.Hosting`](../OpenTelemetry.Extensions.Hosting/README.md)
44+
[`OpenTelemetry.Extensions.Hosting`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Extensions.Hosting/README.md)
4545
to the application. This ensures instrumentations are disposed when the host
4646
is shutdown.
4747

@@ -51,7 +51,7 @@ The following example demonstrates adding ASP.NET Core instrumentation with the
5151
extension method `WithTracing()` on `OpenTelemetryBuilder`.
5252
then extension method `AddAspNetCoreInstrumentation()` on `TracerProviderBuilder`
5353
to the application. This example also sets up the Console Exporter,
54-
which requires adding the package [`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md)
54+
which requires adding the package [`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md)
5555
to the application.
5656

5757
```csharp
@@ -97,7 +97,7 @@ The following example demonstrates adding ASP.NET Core instrumentation with the
9797
extension method `WithMetrics()` on `OpenTelemetryBuilder`
9898
then extension method `AddAspNetCoreInstrumentation()` on `MeterProviderBuilder`
9999
to the application. This example also sets up the Console Exporter,
100-
which requires adding the package [`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md)
100+
which requires adding the package [`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md)
101101
to the application.
102102

103103
```csharp
@@ -185,7 +185,7 @@ This instrumentation can be configured to change the default behavior by using
185185

186186
// TODO: This section could be refined.
187187
When used with
188-
[`OpenTelemetry.Extensions.Hosting`](../OpenTelemetry.Extensions.Hosting/README.md),
188+
[`OpenTelemetry.Extensions.Hosting`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Extensions.Hosting/README.md),
189189
all configurations to `AspNetCoreTraceInstrumentationOptions` can be done in the
190190
`ConfigureServices`
191191
method of you applications `Startup` class as shown below.
@@ -270,7 +270,7 @@ services.AddOpenTelemetry()
270270
}));
271271
```
272272

273-
[Processor](../../docs/trace/extending-the-sdk/README.md#processor),
273+
[Processor](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/docs/trace/extending-the-sdk/README.md#processor),
274274
is the general extensibility point to add additional properties to any activity.
275275
The `Enrich` option is specific to this instrumentation, and is provided to
276276
get access to `HttpRequest` and `HttpResponse`.
@@ -365,8 +365,8 @@ This component uses an
365365
[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource)
366366
with the name "OpenTelemetry-Instrumentation-AspNetCore" for its internal
367367
logging. Please refer to [SDK
368-
troubleshooting](../OpenTelemetry/README.md#troubleshooting) for instructions on
369-
seeing these internal logs.
368+
troubleshooting](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry/README.md#troubleshooting)
369+
for instructions on seeing these internal logs.
370370

371371
## References
372372

‎src/OpenTelemetry.Instrumentation.Cassandra/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public class Program
6363

6464
For an ASP.NET Core application, adding instrumentation is typically done in
6565
the `ConfigureServices` of your `Startup` class. Refer to documentation for
66-
[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md).
66+
[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md).
6767

6868
For an ASP.NET application, adding instrumentation is typically done in the
6969
`Global.asax.cs`. Refer to documentation for [OpenTelemetry.Instrumentation.AspNet](../OpenTelemetry.Instrumentation.AspNet/README.md).
@@ -101,6 +101,6 @@ var cluster = new Builder()
101101

102102
* [OpenTelemetry Project](https://opentelemetry.io/)
103103

104-
* [OpenTelemetry semantic conventions for database calls](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md)
104+
* [OpenTelemetry semantic conventions for Cassandra](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/cassandra.md)
105105

106106
* [Cassandra C# Driver](https://github.com/datastax/csharp-driver)

‎src/OpenTelemetry.Instrumentation.ElasticsearchClient/README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,18 @@ Library](https://github.com/open-telemetry/opentelemetry-specification/blob/main
1616
which instruments [NEST/Elasticsearch.Net](https://www.nuget.org/packages/NEST)
1717
and collects traces about outgoing requests.
1818

19-
**Note: This component is based on the OpenTelemetry semantic conventions for
20-
[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions)
19+
> [!NOTE]
20+
> This component is based on the OpenTelemetry semantic conventions for
21+
[metrics](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/elasticsearch.md)
2122
and
22-
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
23+
[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/elasticsearch.md).
2324
These conventions are
2425
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
2526
and hence, this package is a
2627
[pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases).
2728
Until a [stable
2829
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
29-
is released, there can be [breaking changes](./CHANGELOG.md). You can track the
30-
progress from
31-
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).**
30+
is released, there can be [breaking changes](./CHANGELOG.md).
3231

3332
## Steps to enable OpenTelemetry.Instrumentation.ElasticsearchClient
3433

@@ -70,7 +69,7 @@ public class Program
7069

7170
For an ASP.NET Core application, adding instrumentation is typically done in the
7271
`ConfigureServices` of your `Startup` class. Refer to documentation for
73-
[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md).
72+
[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md).
7473

7574
For an ASP.NET application, adding instrumentation is typically done in the
7675
`Global.asax.cs`. Refer to the documentation for

‎src/OpenTelemetry.Instrumentation.EntityFrameworkCore/README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,16 @@ which instruments
1616
and collects traces about outgoing requests.
1717

1818
**Note: This component is based on the OpenTelemetry semantic conventions for
19-
[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions)
19+
[metrics](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-metrics.md)
2020
and
21-
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
21+
[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md).
2222
These conventions are
2323
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
2424
and hence, this package is a
2525
[pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases).
2626
Until a [stable
2727
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
28-
is released, there can be [breaking changes](./CHANGELOG.md). You can track the
29-
progress from
30-
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).**
28+
is released, there can be [breaking changes](./CHANGELOG.md).**
3129

3230
## Steps to enable OpenTelemetry.Instrumentation.EntityFrameworkCore
3331

@@ -68,7 +66,7 @@ public class Program
6866

6967
For an ASP.NET Core application, adding instrumentation is typically done in
7068
the `ConfigureServices` of your `Startup` class. Refer to documentation for
71-
[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md).
69+
[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md).
7270

7371
For an ASP.NET application, adding instrumentation is typically done in the
7472
`Global.asax.cs`. Refer to the documentation for

‎src/OpenTelemetry.Instrumentation.GrpcCore/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,14 @@ Adds OpenTelemetry instrumentation for gRPC Core-based client and server calls.
1313

1414
gRPC Core is the predecessor to ASP.NET Core gRPC. See <https://github.com/grpc/grpc/tree/master/src/csharp>
1515

16-
For ASP.NET Core gRPC client instrumentation see <https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md>
16+
For ASP.NET Core gRPC client instrumentation see
17+
[OpenTelemetry.Instrumentation.GrpcNetClient](../OpenTelemetry.Instrumentation.GrpcNetClient/README.md).
1718

1819
For ASP.NET Core gRPC server instrumentation is bundled within the AspNetCore
1920
instrumentation.
2021

2122
Each inbound or outbound gRPC call will generate a Span which follows the
22-
semantic RPC specification <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md>
23+
[semantic RPC specification](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md).
2324

2425
## Installation
2526

‎src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Released 2024-Feb-09
3232

3333
* **Breaking Change**:
3434
Please be advised that the
35-
[SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation)
35+
[SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation)
3636
option no longer works when used in conjunction with the
3737
`OpenTelemetry.Instrumentation.Http` package version `1.6.0` or greater.
3838
This is not a result of a change in the `OpenTelemetry.Instrumentation.GrpcNetClient`

‎src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,10 @@ and collects traces about outgoing gRPC requests.
1818
[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md).
1919
These conventions are
2020
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
21-
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
21+
and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/VERSIONING.md#pre-releases).
2222
Until a [stable
2323
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
24-
is released, there can be breaking changes. You can track the progress from
25-
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).
24+
is released, there can be breaking changes.
2625

2726
## Supported .NET Versions
2827

@@ -50,7 +49,7 @@ The following example demonstrates adding Grpc.Net.Client instrumentation to a
5049
console application. This example also sets up the OpenTelemetry Console
5150
exporter and adds instrumentation for HttpClient, which requires adding the
5251
packages
53-
[`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md)
52+
[`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md)
5453
and
5554
[`OpenTelemetry.Instrumentation.Http`](../OpenTelemetry.Instrumentation.Http/README.md)
5655
to the application. As Grpc.Net.Client uses HttpClient underneath, it is
@@ -135,7 +134,7 @@ services.AddOpenTelemetry()
135134
});
136135
```
137136

138-
[Processor](../../docs/trace/extending-the-sdk/README.md#processor),
137+
[Processor](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace/extending-the-sdk/README.md#processor),
139138
is the general extensibility point to add additional properties to any activity.
140139
The `Enrich` option is specific to this instrumentation, and is provided to
141140
get access to `HttpRequest` and `HttpResponse`.

‎src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Released 2023-Dec-01
8888

8989
* Removed reference to `OpenTelemetry` package. This is a **breaking change**
9090
for users relying on
91-
[SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation)
91+
[SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation)
9292
option in `OpenTelemetry.Instrumentation.GrpcNetClient`. For details, check
9393
out this
9494
[issue](https://github.com/open-telemetry/opentelemetry-dotnet/issues/5092).

‎src/OpenTelemetry.Instrumentation.Http/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The following example demonstrates adding `HttpClient` instrumentation with the
5252
extension method `.AddHttpClientInstrumentation()` on `TracerProviderBuilder` to
5353
a console application. This example also sets up the OpenTelemetry Console
5454
Exporter, which requires adding the package
55-
[`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md)
55+
[`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md)
5656
to the application.
5757

5858
```csharp
@@ -97,7 +97,7 @@ The following example demonstrates adding `HttpClient` instrumentation with the
9797
extension method `.AddHttpClientInstrumentation()` on `MeterProviderBuilder` to
9898
a console application. This example also sets up the OpenTelemetry Console
9999
Exporter, which requires adding the package
100-
[`OpenTelemetry.Exporter.Console`](../OpenTelemetry.Exporter.Console/README.md)
100+
[`OpenTelemetry.Exporter.Console`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Console/README.md)
101101
to the application.
102102

103103
```csharp
@@ -116,8 +116,8 @@ public class Program
116116
}
117117
```
118118

119-
Refer to this [example](../../examples/AspNetCore/Program.cs) to see how to
120-
enable this instrumentation in an ASP.NET core application.
119+
Refer to this [example](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/examples/AspNetCore/Program.cs)
120+
to see how to enable this instrumentation in an ASP.NET Core application.
121121

122122
Refer to this
123123
[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()
344344
.Build();
345345
```
346346

347-
[Processor](../../docs/trace/extending-the-sdk/README.md#processor), is the
348-
general extensibility point to add additional properties to any activity. The
349-
`Enrich` option is specific to this instrumentation, and is provided to get
347+
[Processor](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/docs/trace/extending-the-sdk/README.md#processor),
348+
is the general extensibility point to add additional properties to any activity.
349+
The `Enrich` option is specific to this instrumentation, and is provided to get
350350
access to raw request, response, and exception objects.
351351

352352
When overriding the default settings provided by instrumentation or adding
@@ -406,8 +406,8 @@ This component uses an
406406
[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource)
407407
with the name "OpenTelemetry-Instrumentation-Http" for its internal logging.
408408
Please refer to [SDK
409-
troubleshooting](../OpenTelemetry/README.md#troubleshooting) for instructions on
410-
seeing these internal logs.
409+
troubleshooting](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry/README.md#troubleshooting)
410+
for instructions on seeing these internal logs.
411411

412412
## References
413413

‎src/OpenTelemetry.Instrumentation.MassTransit/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ x.AddMassTransitInstrumentation(
7575
}));
7676
```
7777

78-
For full operation list please see: [OperationName](OperationName.cs).
78+
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).
7979

8080
All operations are enabled by default.
8181

‎src/OpenTelemetry.Instrumentation.MySqlData/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public class Program
6060

6161
For an ASP.NET Core application, adding instrumentation is typically done in
6262
the `ConfigureServices` of your `Startup` class. Refer to documentation for
63-
[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md).
63+
[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md).
6464

6565
For an ASP.NET application, adding instrumentation is typically done in the
6666
`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
7878
### Capturing 'db.statement'
7979

8080
The `MySqlDataInstrumentationOptions` class exposes several properties that can be
81-
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)
81+
used to configure how the [`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/mysql.md)
8282
attribute is captured upon execution of a query.
8383

8484
#### SetDbStatement
8585

8686
The `SetDbStatement` property can be used to control whether this instrumentation
87-
should set the [`db.statement`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md#call-level-attributes)
87+
should set the [`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/mysql.md)
8888
attribute to the text of the `MySqlCommand` being executed.
8989

9090
Since `CommandType.Text` might contain sensitive data, SQL capturing is
@@ -124,7 +124,7 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder()
124124
### RecordException
125125

126126
This option can be set to instruct the instrumentation to record Exceptions
127-
as Activity [events](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/exceptions.md).
127+
as Activity [events](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md).
128128

129129
> Due to the limitation of this library's implementation, We cannot get the raw `MysqlException`,
130130
> only exception message is available.
@@ -143,4 +143,4 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder()
143143

144144
* [OpenTelemetry Project](https://opentelemetry.io/)
145145

146-
* [OpenTelemetry semantic conventions for database calls](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md)
146+
* [OpenTelemetry semantic conventions for MySQL](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/mysql.md)

‎src/OpenTelemetry.Instrumentation.Owin/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ even if tracing is disabled.
9595
```
9696

9797
The instrumentation is implemented based on [metrics semantic
98-
conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/http-metrics.md#metric-httpserverduration).
98+
conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md#metric-httpserverrequestduration).
9999
Currently, the instrumentation supports the following metric.
100100

101101
| Name | Instrument Type | Unit | Description |
@@ -107,7 +107,7 @@ Currently, the instrumentation supports the following metric.
107107
The OpenTelemetry OWIN instrumentation will create spans with very generic names
108108
based on the http method of the request. For example: `HTTP GET` or `HTTP POST`.
109109
The reason for this is the [OpenTelemetry Specification http semantic
110-
conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#name)
110+
conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#name)
111111
call specifically for low cardinality values and OWIN does not expose any kind
112112
of route template.
113113

‎src/OpenTelemetry.Instrumentation.Process/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ telemetry about process behavior.
1616

1717
The process metric instruments being implemented are following OpenTelemetry
1818
[metrics semantic
19-
conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/process-metrics.md#metric-instruments).
19+
conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/system/process-metrics.md).
2020

2121
## Steps to enable OpenTelemetry.Instrumentation.Process
2222

@@ -133,7 +133,7 @@ The API used to retrieve the value is
133133
> This metric is under
134134
> [discussion](https://github.com/open-telemetry/opentelemetry-specification/issues/3200)
135135
and not part of the [Process Metrics
136-
Spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/process-metrics.md)
136+
Spec](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/system/process-metrics.md)
137137
at this time.
138138

139139
### process.thread.count

‎src/OpenTelemetry.Instrumentation.Quartz/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Automatically instruments the Quartz jobs from
1717
QuartzNET Instrumentation is only supported when using .NET Framework >=
1818
`net472` and .NET Standard >= `netstandard2.0`. Quartz`net461` support for
1919
activity sources has been removed, more information can be found
20-
[here](https://www.quartz-scheduler.net/2021/04/07/quartznet-3-3-released/).
20+
[here](https://github.com/quartznet/quartznet/releases/tag/v3.3.0).
2121

2222
## Installation
2323

‎src/OpenTelemetry.Instrumentation.SqlClient/README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,10 @@ and later.
2727
[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md).
2828
These conventions are
2929
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
30-
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
30+
and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases).
3131
Until a [stable
3232
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
33-
is released, there can be breaking changes. You can track the progress from
34-
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).
33+
is released, there can be breaking changes.
3534

3635
## Steps to enable OpenTelemetry.Instrumentation.SqlClient
3736

@@ -223,9 +222,9 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder()
223222
.Build();
224223
```
225224

226-
[Processor](../../docs/trace/extending-the-sdk/README.md#processor), is the
227-
general extensibility point to add additional properties to any activity. The
228-
`Enrich` option is specific to this instrumentation, and is provided to get
225+
[Processor](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace/extending-the-sdk/README.md#processor),
226+
is the general extensibility point to add additional properties to any activity.
227+
The `Enrich` option is specific to this instrumentation, and is provided to get
229228
access to `SqlCommand` object.
230229

231230
### RecordException

‎src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@ and collects traces about outgoing calls to Redis.
1717

1818
> [!NOTE]
1919
> This component is based on the OpenTelemetry semantic conventions for
20-
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
20+
[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/redis.md).
2121
These conventions are
2222
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
2323
and hence, this package is a [pre-release](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#pre-releases).
2424
Until a [stable
2525
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
26-
is released, there can be breaking changes. You can track the progress from
27-
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).
26+
is released, there can be breaking changes.
2827

2928
## Steps to enable OpenTelemetry.Instrumentation.StackExchangeRedis
3029

@@ -72,7 +71,7 @@ public class Program
7271

7372
For an ASP.NET Core application, adding instrumentation is typically done in
7473
the `ConfigureServices` of your `Startup` class. Refer to documentation for
75-
[OpenTelemetry.Instrumentation.AspNetCore](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md).
74+
[OpenTelemetry.Instrumentation.AspNetCore](../OpenTelemetry.Instrumentation.AspNetCore/README.md).
7675

7776
For an ASP.NET application, adding instrumentation is typically done in the
7877
`Global.asax.cs`. Refer to documentation for [OpenTelemetry.Instrumentation.AspNet](../OpenTelemetry.Instrumentation.AspNet/README.md).

‎src/OpenTelemetry.PersistentStorage.FileSystem/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Released 2023-Apr-17
2121
([#1110](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1110))
2222

2323
* Going forward the NuGet package will be
24-
[`OpenTelemetry.PersistentStorage.FileSystem`](https://www.nuget.org/packages/OpenTelemetry.Extensions.FileSystem).
24+
[`OpenTelemetry.PersistentStorage.FileSystem`](https://www.nuget.org/packages/OpenTelemetry.PersistentStorage.FileSystem).
2525
Older versions will remain at
2626
[`OpenTelemetry.Extensions.PersistentStorage`](https://www.nuget.org/packages/OpenTelemetry.Extensions.PersistentStorage)
2727
[(#1079)](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1079)

0 commit comments

Comments
 (0)
Please sign in to comment.