Skip to content

Commit 7519b26

Browse files
authored
Update references to spankind in descriptions (#14616)
1 parent aa3bd49 commit 7519b26

File tree

40 files changed

+133
-124
lines changed

40 files changed

+133
-124
lines changed

docs/contributing/documenting-instrumentation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,33 +86,33 @@ At a minimum, every instrumentation metadata file should include a `description`
8686

8787
Some example descriptions:
8888

89-
* This instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server.
89+
* This instrumentation enables HTTP server spans and HTTP server metrics for the ActiveJ HTTP server.
9090
* This instrumentation provides context propagation for Akka actors, it does not emit any telemetry
9191
on its own.
9292
* The Alibaba Druid instrumentation generates database connection pool metrics for druid data sources.
93-
* The Apache Dubbo instrumentation provides CLIENT and SERVER spans
94-
for Apache Dubbo RPC calls. Each call produces a span named after the Dubbo
95-
method, enriched with standard RPC attributes (system, service, method), network
96-
attributes, and error details if an exception occurs.
93+
* The Apache Dubbo instrumentation provides RPC client spans and RPC server spans for Apache Dubbo
94+
RPC calls. Each call produces a span named after the Dubbo method, enriched with standard RPC
95+
attributes (system, service, method), network attributes, and error details if an exception
96+
occurs.
9797

9898
Some notes when writing descriptions:
9999

100100
* You don't always need to explicitly name the instrumentation, and you can start with "This
101101
instrumentation..."
102102
* Prefer the convention of using the word "enables" when describing what the instrumentation does,
103-
"This instrumentation enables SERVER spans and metrics for the ActiveJ" instead of something like
104-
"This instrumentation provides SERVER spans and metrics for the ActiveJ".
103+
"This instrumentation **enables** HTTP server spans and HTTP server metrics for the ActiveJ" instead
104+
of something like "This instrumentation **provides** HTTP server spans and HTTP server metrics for the ActiveJ".
105105
* Explicitly state whether the instrumentation generates new telemetry (spans, metrics, logs).
106106
* If it doesn't generate new telemetry, clearly explain what it's purpose is, for example whether it
107107
augments or enriches existing telemetry produced by other instrumentations (e.g., by adding
108108
attributes or ensuring context propagation).
109+
* When describing the functionality of the instrumentation and the telemetry, specify using
110+
[semantic convention categories](https://opentelemetry.io/docs/specs/semconv/) when possible
111+
(e.g., "database client spans", "RPC server metrics", "consumer messaging spans").
109112
* Do not include specific method names, class names, or other low-level implementation details in
110113
the description unless they are essential to understanding the purpose of the instrumentation.
111114
* It is not usually necessary to include specific library or framework version numbers in the
112115
description, unless that context is significant in some way.
113-
* When an instrumentation generates spans, be specific about the SpanKind (e.g., SERVER, CLIENT,
114-
PRODUCER, CONSUMER, INTERNAL).
115-
* Capitalize SpanKind values (e.g., SERVER, CLIENT) when used in descriptions.
116116

117117

118118
### Configurations

docs/instrumentation-list.yaml

Lines changed: 65 additions & 62 deletions
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
description: This instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server.
1+
description: This instrumentation enables HTTP server spans and HTTP server metrics for the ActiveJ HTTP server.
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
description: This instrumentation enables CLIENT and SERVER spans and metrics for the Akka HTTP client and server.
1+
description: >
2+
This instrumentation enables HTTP client spans and metrics for the Akka HTTP client, and HTTP
3+
server spans and metrics for the Akka HTTP server.

instrumentation/apache-dubbo-2.7/metadata.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
description: The Apache Dubbo instrumentation provides client and server spans for Apache Dubbo
2-
RPC calls. Each call produces a span named after the Dubbo method, enriched with standard RPC
3-
attributes (system, service, method), network attributes, and error details if an exception
4-
occurs.
1+
description: The Apache Dubbo instrumentation provides RPC client spans and RPC server spans for
2+
Apache Dubbo RPC calls. Each call produces a span named after the Dubbo method, enriched with
3+
standard RPC attributes (system, service, method), network attributes, and error details if an
4+
exception occurs.
55
configurations:
66
- name: otel.instrumentation.common.peer-service-mapping
77
description: Used to specify a mapping from host names or IP addresses to peer services.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
description: This instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient.
1+
description: This instrumentation enables HTTP client spans and HTTP client metrics for the Apache HttpAsyncClient.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
description: This instrumentation enables CLIENT spans and metrics for versions 2 and 3 of the Apache HttpClient.
1+
description: This instrumentation enables HTTP client spans and HTTP client metrics for versions 2 and 3 of the Apache HttpClient.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
description: This instrumentation enables CLIENT spans and metrics for version 4 of the Apache HttpClient.
1+
description: This instrumentation enables HTTP client spans and HTTP client metrics for version 4 of the Apache HttpClient.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
description: This instrumentation provides a library integration that enables CLIENT spans and metrics for the Apache HttpClient.
1+
description: This instrumentation provides a library integration that enables HTTP client spans and HTTP client metrics for the Apache HttpClient.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
description: This instrumentation enables CLIENT spans and metrics for version 5 of the Apache HttpClient.
1+
description: This instrumentation enables HTTP client spans and HTTP client metrics for version 5 of the Apache HttpClient.

0 commit comments

Comments
 (0)