Skip to content

Commit 795c053

Browse files
authored
Fix spec links (#9603)
1 parent e349846 commit 795c053

File tree

31 files changed

+40
-39
lines changed

31 files changed

+40
-39
lines changed

.github/workflows/reusable-markdown-link-check.yml

+1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@ jobs:
1818
-name '*.md' \
1919
-not -path './CHANGELOG.md' \
2020
-not -path './licenses/*' \
21+
-not -path '*/build/*' \
2122
| xargs .github/scripts/markdown-link-check-with-retry.sh

docs/contributing/using-instrumenter-api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ A `SpanNameExtractor` is a simple functional interface that accepts the `REQUEST
147147
the span name. For more detailed guidelines on span naming please take a look at
148148
the [`Span` specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#span)
149149
and the
150-
tracing [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/README.md).
150+
tracing [semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/trace.md).
151151

152152
Consider the following example:
153153

@@ -453,6 +453,6 @@ class MySpanKindExtractor implements SpanKindExtractor<Request> {
453453
The example `SpanKindExtractor` above decides whether to use `PRODUCER` or `CLIENT` based on how the
454454
request is going to be processed. This example reflects a real-life scenario: you might find
455455
similar code in a messaging library instrumentation, since according to
456-
the [OpenTelemetry messaging semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#span-kind)
456+
the [OpenTelemetry messaging semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#span-kind)
457457
the span kind should be set to `CLIENT` if sending the message is completely synchronous and waits
458458
for the response.

docs/supported-libraries.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ These are the supported libraries and frameworks:
8080
| [JDBC](https://docs.oracle.com/javase/8/docs/api/java/sql/package-summary.html) | Java 8+ | [opentelemetry-jdbc](../instrumentation/jdbc/library) | [Database Client Spans] |
8181
| [Jedis](https://github.com/xetorthio/jedis) | 1.4+ | N/A | [Database Client Spans] |
8282
| [JMS](https://javaee.github.io/javaee-spec/javadocs/javax/jms/package-summary.html) | 1.1+ | N/A | [Messaging Spans] |
83-
| [Jodd Http](https://javadoc.io/doc/org.jodd/jodd-http/latest/index.html) | 4.2+ | N/A | [HTTP Client Spans], [HTTP Client Metrics] |
83+
| [Jodd Http](https://http.jodd.org/) | 4.2+ | N/A | [HTTP Client Spans], [HTTP Client Metrics] |
8484
| [JSP](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/jsp/package-summary.html) | 2.3+ | N/A | none |
8585
| [Kotlin Coroutines](https://kotlinlang.org/docs/coroutines-overview.html) | 1.0+ | N/A | Context propagation |
8686
| [Ktor](https://github.com/ktorio/ktor) | 1.0+ | [opentelemetry-ktor-1.0](../instrumentation/ktor/ktor-1.0/library),<br>[opentelemetry-ktor-2.0](../instrumentation/ktor/ktor-2.0/library) | [HTTP Client Spans], [HTTP Client Metrics], [HTTP Server Spans], [HTTP Server Metrics] |
@@ -155,7 +155,7 @@ These are the supported libraries and frameworks:
155155
[Messaging Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md
156156
[Database Client Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md
157157
[Database Pool Metrics]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-metrics.md
158-
[JVM Runtime Metrics]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/system/runtime-environment-metrics.md#jvm-metrics
158+
[JVM Runtime Metrics]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/jvm/jvm-metrics.md
159159
[System Metrics]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/system/system-metrics.md
160160
[GraphQL Server Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/graphql.md
161161
[FaaS Server Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/faas-spans.md

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/code/CodeAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
/**
1717
* Extractor of <a
18-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/span-general.md#source-code-attributes">source
18+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/attributes.md#source-code-attributes">source
1919
* code attributes</a>.
2020
*/
2121
public final class CodeAttributesExtractor<REQUEST, RESPONSE>

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/db/DbClientAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
/**
1616
* Extractor of <a
17-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md">database
17+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md">database
1818
* client attributes</a>.
1919
*
2020
* <p>This class delegates to a type-specific {@link DbClientAttributesGetter} for individual

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/db/SqlClientAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
/**
1919
* Extractor of <a
20-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md">database
20+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md">database
2121
* attributes</a>. This class is designed with SQL (or SQL-like) database clients in mind.
2222
*
2323
* <p>It sets the same set of attributes as {@link DbClientAttributesExtractor} plus an additional

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
/**
2424
* Extractor of <a
25-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-client">HTTP
25+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-client">HTTP
2626
* client attributes</a>. Instrumentation of HTTP client frameworks should extend this class,
2727
* defining {@link REQUEST} and {@link RESPONSE} with the actual request / response types of the
2828
* instrumented library. If an attribute is not available in this library, it is appropriate to

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractorBuilder.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public final class HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> {
5050

5151
/**
5252
* Configures the HTTP request headers that will be captured as span attributes as described in <a
53-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers">HTTP
53+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes">HTTP
5454
* semantic conventions</a>.
5555
*
5656
* <p>The HTTP request header values will be captured under the {@code http.request.header.<name>}
@@ -69,7 +69,7 @@ public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedReques
6969
/**
7070
* Configures the HTTP response headers that will be captured as span attributes as described in
7171
* <a
72-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers">HTTP
72+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes">HTTP
7373
* semantic conventions</a>.
7474
*
7575
* <p>The HTTP response header values will be captured under the {@code

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpCommonAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
/**
2525
* Extractor of <a
26-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#common-attributes">HTTP
26+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes">HTTP
2727
* attributes</a> that are common to client and server instrumentations.
2828
*/
2929
abstract class HttpCommonAttributesExtractor<

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
/**
2525
* Extractor of <a
26-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-server">HTTP
26+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-server">HTTP
2727
* server attributes</a>. Instrumentation of HTTP server frameworks should extend this class,
2828
* defining {@link REQUEST} and {@link RESPONSE} with the actual request / response types of the
2929
* instrumented library. If an attribute is not available in this library, it is appropriate to

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerAttributesExtractorBuilder.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public final class HttpServerAttributesExtractorBuilder<REQUEST, RESPONSE> {
5252

5353
/**
5454
* Configures the HTTP request headers that will be captured as span attributes as described in <a
55-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers">HTTP
55+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes">HTTP
5656
* semantic conventions</a>.
5757
*
5858
* <p>The HTTP request header values will be captured under the {@code http.request.header.<name>}
@@ -71,7 +71,7 @@ public HttpServerAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedReques
7171
/**
7272
* Configures the HTTP response headers that will be captured as span attributes as described in
7373
* <a
74-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers">HTTP
74+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes">HTTP
7575
* semantic conventions</a>.
7676
*
7777
* <p>The HTTP response header values will be captured under the {@code

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpSpanNameExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
/**
1414
* Extractor of the <a
15-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#name">HTTP
15+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#name">HTTP
1616
* span name</a>. Instrumentation of HTTP server or client frameworks should use this class to
1717
* comply with OpenTelemetry HTTP semantic conventions.
1818
*/

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpSpanStatusExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
/**
1414
* Extractor of the <a
15-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#status">HTTP
15+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#status">HTTP
1616
* span status</a>. Instrumentation of HTTP server or client frameworks should use this class to
1717
* comply with OpenTelemetry HTTP semantic conventions.
1818
*/

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/messaging/MessageOperation.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
/**
1111
* Represents type of <a
12-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#operation-names">operations</a>
12+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#operation-names">operations</a>
1313
* that may be used in a messaging system.
1414
*/
1515
public enum MessageOperation {
@@ -19,7 +19,7 @@ public enum MessageOperation {
1919

2020
/**
2121
* Returns the operation name as defined in <a
22-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#operation-names">the
22+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#operation-names">the
2323
* specification</a>.
2424
*/
2525
String operationName() {

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/messaging/MessagingAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
/**
2424
* Extractor of <a
25-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md">messaging
25+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md">messaging
2626
* attributes</a>.
2727
*
2828
* <p>This class delegates to a type-specific {@link MessagingAttributesGetter} for individual

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/messaging/MessagingSpanNameExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ public final class MessagingSpanNameExtractor<REQUEST> implements SpanNameExtrac
1111

1212
/**
1313
* Returns a {@link SpanNameExtractor} that constructs the span name according to <a
14-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#span-name">
14+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#span-name">
1515
* messaging semantic conventions</a>: {@code <destination name> <operation name>}.
1616
*
1717
* @see MessagingAttributesGetter#getDestination(Object) used to extract {@code <destination

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
/**
2020
* Extractor of <a
21-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/span-general.md#general-network-connection-attributes">Network
21+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/attributes.md#server-client-and-shared-network-attributes">Network
2222
* attributes</a>.
2323
*
2424
* <p>This class delegates to a type-specific {@link NetClientAttributesGetter} for individual

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/net/NetServerAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
/**
2121
* Extractor of <a
22-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/span-general.md#general-network-connection-attributes">Network
22+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/attributes.md#server-client-and-shared-network-attributes">Network
2323
* attributes</a>.
2424
*
2525
* @deprecated Make sure that your instrumentation uses the extractors from the {@code ...network}

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/net/PeerServiceAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
/**
1818
* Extractor of the {@code peer.service} span attribute, described in <a
19-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/span-general.md#general-remote-service-attributes">the
19+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/attributes.md#general-remote-service-attributes">the
2020
* specification</a>.
2121
*/
2222
public final class PeerServiceAttributesExtractor<REQUEST, RESPONSE>

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/rpc/RpcClientAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
/**
1313
* Extractor of <a
14-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md">RPC
14+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md">RPC
1515
* client attributes</a>.
1616
*
1717
* <p>This class delegates to a type-specific {@link RpcAttributesGetter} for individual attribute

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/rpc/RpcServerAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
/**
1313
* Extractor of <a
14-
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md">RPC
14+
* href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md">RPC
1515
* server attributes</a>.
1616
*
1717
* <p>This class delegates to a type-specific {@link RpcAttributesGetter} for individual attribute

instrumentation/graphql-java-12.0/library/src/main/java/io/opentelemetry/instrumentation/graphql/v12_0/GraphqlAttributesExtractor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
final class GraphqlAttributesExtractor
1818
implements AttributesExtractor<InstrumentationExecutionParameters, ExecutionResult> {
19-
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/instrumentation/graphql.md
19+
// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/graphql.md
2020
private static final AttributeKey<String> OPERATION_NAME =
2121
AttributeKey.stringKey("graphql.operation.name");
2222
private static final AttributeKey<String> OPERATION_TYPE =

instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaConsumerInstrumentation.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ public static void onExit(
116116
// we're storing the context of the receive span so that process spans can use it as
117117
// parent context even though the span has ended
118118
// this is the suggested behavior according to the spec batch receive scenario:
119-
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#batch-receiving
119+
// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#batch-receiving
120120
// we're attaching the consumer to the records to be able to retrieve things like consumer
121121
// group or clientId later
122122
KafkaConsumerContextUtil.set(records, context, consumer);

0 commit comments

Comments
 (0)