Skip to content

Commit ab83554

Browse files
committed
be consistent with wording in descriptions, address code review comments
1 parent c9bad11 commit ab83554

File tree

22 files changed

+52
-52
lines changed

22 files changed

+52
-52
lines changed

docs/instrumentation-list.yaml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
libraries:
66
activej:
77
- name: activej-http-6.0
8-
description: This instrumentation provides SERVER spans and metrics for the ActiveJ
8+
description: this instrumentation enables SERVER spans and metrics for the ActiveJ
99
HTTP server.
1010
source_path: instrumentation/activej-http-6.0
1111
minimum_java_version: 17
@@ -260,7 +260,7 @@ libraries:
260260
apache:
261261
- name: apache-dbcp-2.0
262262
description: |
263-
This instrumentation provides database connection pools metrics for Apache DBCP.
263+
this instrumentation enables database connection pools metrics for Apache DBCP.
264264
The instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot, this happens automatically as all Spring beans that support JMX registration are automatically registered by default.
265265
source_path: instrumentation/apache-dbcp-2.0
266266
scope:
@@ -382,7 +382,7 @@ libraries:
382382
- name: rpc.system
383383
type: STRING
384384
- name: apache-httpasyncclient-4.1
385-
description: This instrumentation provides CLIENT spans and metrics for the Apache
385+
description: this instrumentation enables CLIENT spans and metrics for the Apache
386386
HttpAsyncClient.
387387
source_path: instrumentation/apache-httpasyncclient-4.1
388388
scope:
@@ -428,7 +428,7 @@ libraries:
428428
- name: url.full
429429
type: STRING
430430
- name: apache-httpclient-2.0
431-
description: This instrumentation provides CLIENT spans and metrics for versions
431+
description: this instrumentation enables CLIENT spans and metrics for versions
432432
2 and 3 of the Apache HttpClient.
433433
source_path: instrumentation/apache-httpclient/apache-httpclient-2.0
434434
scope:
@@ -472,7 +472,7 @@ libraries:
472472
- name: url.full
473473
type: STRING
474474
- name: apache-httpclient-4.0
475-
description: This instrumentation provides CLIENT spans and metrics for version
475+
description: this instrumentation enables CLIENT spans and metrics for version
476476
4 of the Apache HttpClient.
477477
source_path: instrumentation/apache-httpclient/apache-httpclient-4.0
478478
scope:
@@ -567,7 +567,7 @@ libraries:
567567
- name: url.full
568568
type: STRING
569569
- name: apache-httpclient-5.0
570-
description: This instrumentation provides CLIENT spans and metrics for version
570+
description: This instrumentation enables CLIENT spans and metrics for version
571571
5 of the Apache HttpClient.
572572
source_path: instrumentation/apache-httpclient/apache-httpclient-5.0
573573
scope:
@@ -662,7 +662,7 @@ libraries:
662662
type: STRING
663663
- name: apache-shenyu-2.4
664664
description: |
665-
This instrumentation does not emit telemetry on its own. Instead, it hooks into the Shenyu Context and extracts meta data in order to attach it to existing SERVER spans and HTTP server metrics.
665+
This instrumentation does not emit telemetry on its own. Instead, it augments existing SERVER spans and HTTP server metrics with the HTTP route and Shenyu specific attributes.
666666
source_path: instrumentation/apache-shenyu-2.4
667667
scope:
668668
name: io.opentelemetry.apache-shenyu-2.4
@@ -672,13 +672,13 @@ libraries:
672672
configurations:
673673
- name: otel.instrumentation.apache-shenyu.experimental-span-attributes
674674
description: |
675-
Enables experimental `apache-shenyu.meta.` prefixed span attributes like `app-name`, `service-name`, `context-path`, `param-types`, `id`, `method-name`, `rpc-type`, `path`, and `rpc-ext`.
675+
Enables experimental `apache-shenyu.meta.` prefixed span attributes `app-name`, `service-name`, `context-path`, `param-types`, `id`, `method-name`, `rpc-type`, `path` and `rpc-ext`.
676676
type: boolean
677677
default: false
678678
armeria:
679679
- name: armeria-1.3
680-
description: This instrumentation enables CLIENT spans and metrics for the Armeria
681-
HTTP client and server.
680+
description: This instrumentation enables CLIENT and SERVER spans and metrics
681+
for the Armeria HTTP client and server.
682682
source_path: instrumentation/armeria/armeria-1.3
683683
scope:
684684
name: io.opentelemetry.armeria-1.3
@@ -772,8 +772,8 @@ libraries:
772772
- name: user_agent.original
773773
type: STRING
774774
- name: armeria-grpc-1.14
775-
description: This instrumentation enables CLIENT spans and metrics for the Armeria
776-
gRPC client and server.
775+
description: This instrumentation enables CLIENT and SERVER spans and metrics
776+
for the Armeria gRPC client and server.
777777
source_path: instrumentation/armeria/armeria-grpc-1.14
778778
scope:
779779
name: io.opentelemetry.armeria-grpc-1.14
@@ -782,7 +782,7 @@ libraries:
782782
- com.linecorp.armeria:armeria-grpc:[1.14.0,)
783783
async:
784784
- name: async-http-client-1.9
785-
description: This instrumentation provides CLIENT spans and metrics for version
785+
description: This instrumentation enables CLIENT spans and metrics for version
786786
1 of the AsyncHttpClient (AHC) HTTP client.
787787
source_path: instrumentation/async-http-client/async-http-client-1.9
788788
scope:
@@ -824,7 +824,7 @@ libraries:
824824
- name: url.full
825825
type: STRING
826826
- name: async-http-client-2.0
827-
description: This instrumentation provides CLIENT spans and metrics for version
827+
description: This instrumentation enables CLIENT spans and metrics for version
828828
2 of the AsyncHttpClient (AHC) HTTP client.
829829
source_path: instrumentation/async-http-client/async-http-client-2.0
830830
scope:
@@ -1119,7 +1119,7 @@ libraries:
11191119
camel:
11201120
- name: camel-2.20
11211121
description: |
1122-
This instrumentation provides tracing for Apache Camel 2.x applications by generating spans for each route execution. For Camel versions 3.5 and newer, users should instead use the native 'camel-opentelemetry' component provided directly by the Camel project.
1122+
this instrumentation enables tracing for Apache Camel 2.x applications by generating spans for each route execution. For Camel versions 3.5 and newer, users should instead use the native 'camel-opentelemetry' component provided directly by the Camel project.
11231123
source_path: instrumentation/camel-2.20
11241124
scope:
11251125
name: io.opentelemetry.camel-2.20
@@ -1333,9 +1333,9 @@ libraries:
13331333
default: false
13341334
elasticsearch:
13351335
- name: elasticsearch-api-client-7.16
1336-
description: This instrumentation provides client spans for Elasticsearch API
1337-
client requests for version 7 of the client. Versions 8.10 and later have native
1338-
support for OpenTelemetry.
1336+
description: this instrumentation enables client spans for Elasticsearch API client
1337+
requests for version 7 of the client. Versions 8.10 and later have native support
1338+
for OpenTelemetry.
13391339
source_path: instrumentation/elasticsearch/elasticsearch-api-client-7.16
13401340
scope:
13411341
name: io.opentelemetry.elasticsearch-api-client-7.16
@@ -1344,7 +1344,7 @@ libraries:
13441344
- co.elastic.clients:elasticsearch-java:[7.16,7.17.20)
13451345
- co.elastic.clients:elasticsearch-java:[8.0.0,8.10)
13461346
- name: elasticsearch-rest-5.0
1347-
description: This instrumentation provides tracing for Elasticsearch REST clients.
1347+
description: this instrumentation enables tracing for Elasticsearch REST clients.
13481348
source_path: instrumentation/elasticsearch/elasticsearch-rest-5.0
13491349
scope:
13501350
name: io.opentelemetry.elasticsearch-rest-5.0
@@ -1375,7 +1375,7 @@ libraries:
13751375
- name: url.full
13761376
type: STRING
13771377
- name: elasticsearch-rest-6.4
1378-
description: This instrumentation provides tracing for Elasticsearch REST clients.
1378+
description: this instrumentation enables tracing for Elasticsearch REST clients.
13791379
source_path: instrumentation/elasticsearch/elasticsearch-rest-6.4
13801380
scope:
13811381
name: io.opentelemetry.elasticsearch-rest-6.4
@@ -1404,7 +1404,7 @@ libraries:
14041404
- name: url.full
14051405
type: STRING
14061406
- name: elasticsearch-rest-7.0
1407-
description: This instrumentation provides tracing for Elasticsearch REST clients.
1407+
description: this instrumentation enables tracing for Elasticsearch REST clients.
14081408
source_path: instrumentation/elasticsearch/elasticsearch-rest-7.0
14091409
scope:
14101410
name: io.opentelemetry.elasticsearch-rest-7.0
@@ -1436,7 +1436,7 @@ libraries:
14361436
type: STRING
14371437
- name: elasticsearch-transport-5.0
14381438
description: |
1439-
This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
1439+
this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
14401440
source_path: instrumentation/elasticsearch/elasticsearch-transport-5.0
14411441
scope:
14421442
name: io.opentelemetry.elasticsearch-transport-5.0
@@ -1512,7 +1512,7 @@ libraries:
15121512
type: LONG
15131513
- name: elasticsearch-transport-5.3
15141514
description: |
1515-
This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
1515+
this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
15161516
source_path: instrumentation/elasticsearch/elasticsearch-transport-5.3
15171517
scope:
15181518
name: io.opentelemetry.elasticsearch-transport-5.3
@@ -1598,7 +1598,7 @@ libraries:
15981598
type: LONG
15991599
- name: elasticsearch-transport-6.0
16001600
description: |
1601-
This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
1601+
this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
16021602
source_path: instrumentation/elasticsearch/elasticsearch-transport-6.0
16031603
scope:
16041604
name: io.opentelemetry.elasticsearch-transport-6.0
@@ -2442,7 +2442,7 @@ libraries:
24422442
kafka:
24432443
- name: kafka-clients-0.11
24442444
description: |
2445-
This instrumentation provides messaging spans and metrics for Apache Kafka 0.11 clients. It automatically traces message production and consumption, propagates context, and emits metrics for production and consumption.
2445+
This instrumentation enables messaging spans and metrics for Apache Kafka 0.11 clients. It automatically traces message production and consumption, propagates context, and emits metrics for production and consumption.
24462446
source_path: instrumentation/kafka/kafka-clients/kafka-clients-0.11
24472447
scope:
24482448
name: io.opentelemetry.kafka-clients-0.11
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
description: This instrumentation provides SERVER spans and metrics for the ActiveJ HTTP server.
1+
description: this instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server.

instrumentation/apache-dbcp-2.0/metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
description: >
2-
This instrumentation provides database connection pools metrics for Apache DBCP.
2+
this instrumentation enables database connection pools metrics for Apache DBCP.
33
44
The instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it
55
only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot,
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
description: This instrumentation provides CLIENT spans and metrics for the Apache HttpAsyncClient.
1+
description: this instrumentation enables CLIENT spans and 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 provides CLIENT spans and metrics for versions 2 and 3 of the Apache HttpClient.
1+
description: this instrumentation enables CLIENT spans and 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 provides CLIENT spans and metrics for version 4 of the Apache HttpClient.
1+
description: this instrumentation enables CLIENT spans and 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 CLIENT spans and metrics for version 5 of the Apache HttpClient.
1+
description: This instrumentation enables CLIENT spans and metrics for version 5 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 CLIENT spans and metrics for the Apache HttpAsyncClient.
1+
description: this instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
description: >
2-
This instrumentation does not emit telemetry on its own. Instead, it hooks into the Shenyu Context
3-
and extracts meta data in order to attach it to existing SERVER spans and HTTP server metrics.
2+
This instrumentation does not emit telemetry on its own. Instead, it augments existing SERVER
3+
spans and HTTP server metrics with the HTTP route and Shenyu specific attributes.
44
configurations:
55
- name: otel.instrumentation.apache-shenyu.experimental-span-attributes
66
description: >
7-
Enables experimental `apache-shenyu.meta.` prefixed span attributes like `app-name`,
8-
`service-name`, `context-path`, `param-types`, `id`, `method-name`, `rpc-type`, `path`, and
7+
Enables experimental `apache-shenyu.meta.` prefixed span attributes `app-name`,
8+
`service-name`, `context-path`, `param-types`, `id`, `method-name`, `rpc-type`, `path` and
99
`rpc-ext`.
1010
type: boolean
1111
default: false
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 Armeria HTTP client and server.
1+
description: This instrumentation enables CLIENT and SERVER spans and metrics for the Armeria HTTP client and server.

0 commit comments

Comments
 (0)