Skip to content

Commit aa8f726

Browse files
authored
Updating another batch of instrumentation metadata (#14967)
1 parent 0997afc commit aa8f726

File tree

6 files changed

+236
-0
lines changed

6 files changed

+236
-0
lines changed

docs/instrumentation-list.yaml

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -834,6 +834,8 @@ libraries:
834834
description: |
835835
This instrumentation does not emit telemetry on its own. Instead, it augments existing HTTP server spans and HTTP server metrics with the HTTP route and Shenyu specific attributes.
836836
library_link: https://shenyu.apache.org/
837+
features:
838+
- HTTP_ROUTE
837839
source_path: instrumentation/apache-shenyu-2.4
838840
scope:
839841
name: io.opentelemetry.apache-shenyu-2.4
@@ -850,7 +852,14 @@ libraries:
850852
- name: armeria-1.3
851853
description: |
852854
This instrumentation enables HTTP client spans and metrics for the Armeria HTTP client, and HTTP server spans and metrics for the Armeria HTTP server.
855+
semantic_conventions:
856+
- HTTP_CLIENT_SPANS
857+
- HTTP_CLIENT_METRICS
858+
- HTTP_SERVER_SPANS
859+
- HTTP_SERVER_METRICS
853860
library_link: https://armeria.dev/
861+
features:
862+
- HTTP_ROUTE
854863
source_path: instrumentation/armeria/armeria-1.3
855864
scope:
856865
name: io.opentelemetry.armeria-1.3
@@ -859,6 +868,47 @@ libraries:
859868
- com.linecorp.armeria:armeria:[1.3.0,)
860869
library:
861870
- com.linecorp.armeria:armeria:1.3.0
871+
configurations:
872+
- name: otel.instrumentation.http.known-methods
873+
description: |
874+
Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as `_OTHER`.
875+
type: list
876+
default: CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE
877+
- name: otel.instrumentation.http.client.capture-request-headers
878+
description: List of HTTP request headers to capture in HTTP client telemetry.
879+
type: list
880+
default: ''
881+
- name: otel.instrumentation.http.client.capture-response-headers
882+
description: List of HTTP response headers to capture in HTTP client telemetry.
883+
type: list
884+
default: ''
885+
- name: otel.instrumentation.common.peer-service-mapping
886+
description: Used to specify a mapping from host names or IP addresses to peer
887+
services.
888+
type: map
889+
default: ''
890+
- name: otel.instrumentation.http.client.emit-experimental-telemetry
891+
description: |
892+
Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size` and `http.response.body.size` attributes to spans, and records `http.client.request.size` and `http.client.response.size` metrics.
893+
type: boolean
894+
default: false
895+
- name: otel.instrumentation.http.client.experimental.redact-query-parameters
896+
description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
897+
type: boolean
898+
default: true
899+
- name: otel.instrumentation.http.server.capture-request-headers
900+
description: List of HTTP request headers to capture in HTTP server telemetry.
901+
type: list
902+
default: ''
903+
- name: otel.instrumentation.http.server.capture-response-headers
904+
description: List of HTTP response headers to capture in HTTP server telemetry.
905+
type: list
906+
default: ''
907+
- name: otel.instrumentation.http.server.emit-experimental-telemetry
908+
description: |
909+
Enable the capture of experimental HTTP server telemetry. Adds the `http.request.body.size` and `http.response.body.size` attributes to spans, and records `http.server.request.size` and `http.server.response.size` metrics.
910+
type: boolean
911+
default: false
862912
telemetry:
863913
- when: default
864914
metrics:
@@ -988,13 +1038,44 @@ libraries:
9881038
- name: async-http-client-1.9
9891039
description: This instrumentation enables HTTP client spans and HTTP client metrics
9901040
for version 1 of the AsyncHttpClient (AHC) HTTP client.
1041+
semantic_conventions:
1042+
- HTTP_CLIENT_SPANS
1043+
- HTTP_CLIENT_METRICS
9911044
library_link: https://github.com/AsyncHttpClient/async-http-client
9921045
source_path: instrumentation/async-http-client/async-http-client-1.9
9931046
scope:
9941047
name: io.opentelemetry.async-http-client-1.9
9951048
target_versions:
9961049
javaagent:
9971050
- com.ning:async-http-client:[1.9.0,)
1051+
configurations:
1052+
- name: otel.instrumentation.http.known-methods
1053+
description: |
1054+
Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as `_OTHER`.
1055+
type: list
1056+
default: CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE
1057+
- name: otel.instrumentation.http.client.capture-request-headers
1058+
description: List of HTTP request headers to capture in HTTP client telemetry.
1059+
type: list
1060+
default: ''
1061+
- name: otel.instrumentation.http.client.capture-response-headers
1062+
description: List of HTTP response headers to capture in HTTP client telemetry.
1063+
type: list
1064+
default: ''
1065+
- name: otel.instrumentation.common.peer-service-mapping
1066+
description: Used to specify a mapping from host names or IP addresses to peer
1067+
services.
1068+
type: map
1069+
default: ''
1070+
- name: otel.instrumentation.http.client.emit-experimental-telemetry
1071+
description: |
1072+
Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size` and `http.response.body.size` attributes to spans, and records `http.client.request.size` and `http.client.response.size` metrics.
1073+
type: boolean
1074+
default: false
1075+
- name: otel.instrumentation.http.client.experimental.redact-query-parameters
1076+
description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
1077+
type: boolean
1078+
default: true
9981079
telemetry:
9991080
- when: default
10001081
metrics:
@@ -1031,13 +1112,44 @@ libraries:
10311112
- name: async-http-client-2.0
10321113
description: This instrumentation enables HTTP client spans and HTTP client metrics
10331114
for version 2 of the AsyncHttpClient (AHC) HTTP client.
1115+
semantic_conventions:
1116+
- HTTP_CLIENT_SPANS
1117+
- HTTP_CLIENT_METRICS
10341118
library_link: https://github.com/AsyncHttpClient/async-http-client
10351119
source_path: instrumentation/async-http-client/async-http-client-2.0
10361120
scope:
10371121
name: io.opentelemetry.async-http-client-2.0
10381122
target_versions:
10391123
javaagent:
10401124
- org.asynchttpclient:async-http-client:[2.0.0,)
1125+
configurations:
1126+
- name: otel.instrumentation.http.known-methods
1127+
description: |
1128+
Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as `_OTHER`.
1129+
type: list
1130+
default: CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE
1131+
- name: otel.instrumentation.http.client.capture-request-headers
1132+
description: List of HTTP request headers to capture in HTTP client telemetry.
1133+
type: list
1134+
default: ''
1135+
- name: otel.instrumentation.http.client.capture-response-headers
1136+
description: List of HTTP response headers to capture in HTTP client telemetry.
1137+
type: list
1138+
default: ''
1139+
- name: otel.instrumentation.common.peer-service-mapping
1140+
description: Used to specify a mapping from host names or IP addresses to peer
1141+
services.
1142+
type: map
1143+
default: ''
1144+
- name: otel.instrumentation.http.client.emit-experimental-telemetry
1145+
description: |
1146+
Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size` and `http.response.body.size` attributes to spans, and records `http.client.request.size` and `http.client.response.size` metrics.
1147+
type: boolean
1148+
default: false
1149+
- name: otel.instrumentation.http.client.experimental.redact-query-parameters
1150+
description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
1151+
type: boolean
1152+
default: true
10411153
telemetry:
10421154
- when: default
10431155
metrics:
@@ -1084,6 +1196,8 @@ libraries:
10841196
description: |
10851197
This instrumentation does not emit telemetry on its own. Instead, it hooks into the Avaje Jex Context to extract the HTTP route and attach it to existing HTTP server spans and HTTP server metrics.
10861198
library_link: https://avaje.io/jex/
1199+
features:
1200+
- HTTP_ROUTE
10871201
source_path: instrumentation/avaje-jex-3.0
10881202
minimum_java_version: 21
10891203
scope:

instrumentation/apache-shenyu-2.4/metadata.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ description: >
22
This instrumentation does not emit telemetry on its own. Instead, it augments existing HTTP server
33
spans and HTTP server metrics with the HTTP route and Shenyu specific attributes.
44
library_link: https://shenyu.apache.org/
5+
features:
6+
- HTTP_ROUTE
57
configurations:
68
- name: otel.instrumentation.apache-shenyu.experimental-span-attributes
79
description: >

instrumentation/armeria/armeria-1.3/metadata.yaml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,55 @@ description: >
22
This instrumentation enables HTTP client spans and metrics for the Armeria HTTP client, and HTTP
33
server spans and metrics for the Armeria HTTP server.
44
library_link: https://armeria.dev/
5+
semantic_conventions:
6+
- HTTP_CLIENT_SPANS
7+
- HTTP_CLIENT_METRICS
8+
- HTTP_SERVER_SPANS
9+
- HTTP_SERVER_METRICS
10+
features:
11+
- HTTP_ROUTE
12+
configurations:
13+
- name: otel.instrumentation.http.known-methods
14+
description: >
15+
Configures the instrumentation to recognize an alternative set of HTTP request methods. All
16+
other methods will be treated as `_OTHER`.
17+
type: list
18+
default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
19+
- name: otel.instrumentation.http.client.capture-request-headers
20+
description: List of HTTP request headers to capture in HTTP client telemetry.
21+
type: list
22+
default: ""
23+
- name: otel.instrumentation.http.client.capture-response-headers
24+
description: List of HTTP response headers to capture in HTTP client telemetry.
25+
type: list
26+
default: ""
27+
- name: otel.instrumentation.common.peer-service-mapping
28+
description: Used to specify a mapping from host names or IP addresses to peer services.
29+
type: map
30+
default: ""
31+
- name: otel.instrumentation.http.client.emit-experimental-telemetry
32+
description: >
33+
Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
34+
and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
35+
`http.client.response.size` metrics.
36+
type: boolean
37+
default: false
38+
- name: otel.instrumentation.http.client.experimental.redact-query-parameters
39+
description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
40+
type: boolean
41+
default: true
42+
- name: otel.instrumentation.http.server.capture-request-headers
43+
description: List of HTTP request headers to capture in HTTP server telemetry.
44+
type: list
45+
default: ""
46+
- name: otel.instrumentation.http.server.capture-response-headers
47+
description: List of HTTP response headers to capture in HTTP server telemetry.
48+
type: list
49+
default: ""
50+
- name: otel.instrumentation.http.server.emit-experimental-telemetry
51+
description: >
52+
Enable the capture of experimental HTTP server telemetry. Adds the `http.request.body.size`
53+
and `http.response.body.size` attributes to spans, and records `http.server.request.size` and
54+
`http.server.response.size` metrics.
55+
type: boolean
56+
default: false
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
description: This instrumentation enables HTTP client spans and HTTP client metrics for version 1 of the AsyncHttpClient (AHC) HTTP client.
22
library_link: https://github.com/AsyncHttpClient/async-http-client
3+
semantic_conventions:
4+
- HTTP_CLIENT_SPANS
5+
- HTTP_CLIENT_METRICS
6+
configurations:
7+
- name: otel.instrumentation.http.known-methods
8+
description: >
9+
Configures the instrumentation to recognize an alternative set of HTTP request methods. All
10+
other methods will be treated as `_OTHER`.
11+
type: list
12+
default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
13+
- name: otel.instrumentation.http.client.capture-request-headers
14+
description: List of HTTP request headers to capture in HTTP client telemetry.
15+
type: list
16+
default: ""
17+
- name: otel.instrumentation.http.client.capture-response-headers
18+
description: List of HTTP response headers to capture in HTTP client telemetry.
19+
type: list
20+
default: ""
21+
- name: otel.instrumentation.common.peer-service-mapping
22+
description: Used to specify a mapping from host names or IP addresses to peer services.
23+
type: map
24+
default: ""
25+
- name: otel.instrumentation.http.client.emit-experimental-telemetry
26+
description: >
27+
Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
28+
and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
29+
`http.client.response.size` metrics.
30+
type: boolean
31+
default: false
32+
- name: otel.instrumentation.http.client.experimental.redact-query-parameters
33+
description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
34+
type: boolean
35+
default: true
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
description: This instrumentation enables HTTP client spans and HTTP client metrics for version 2 of the AsyncHttpClient (AHC) HTTP client.
22
library_link: https://github.com/AsyncHttpClient/async-http-client
3+
semantic_conventions:
4+
- HTTP_CLIENT_SPANS
5+
- HTTP_CLIENT_METRICS
6+
configurations:
7+
- name: otel.instrumentation.http.known-methods
8+
description: >
9+
Configures the instrumentation to recognize an alternative set of HTTP request methods. All
10+
other methods will be treated as `_OTHER`.
11+
type: list
12+
default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
13+
- name: otel.instrumentation.http.client.capture-request-headers
14+
description: List of HTTP request headers to capture in HTTP client telemetry.
15+
type: list
16+
default: ""
17+
- name: otel.instrumentation.http.client.capture-response-headers
18+
description: List of HTTP response headers to capture in HTTP client telemetry.
19+
type: list
20+
default: ""
21+
- name: otel.instrumentation.common.peer-service-mapping
22+
description: Used to specify a mapping from host names or IP addresses to peer services.
23+
type: map
24+
default: ""
25+
- name: otel.instrumentation.http.client.emit-experimental-telemetry
26+
description: >
27+
Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
28+
and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
29+
`http.client.response.size` metrics.
30+
type: boolean
31+
default: false
32+
- name: otel.instrumentation.http.client.experimental.redact-query-parameters
33+
description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
34+
type: boolean
35+
default: true

instrumentation/avaje-jex-3.0/metadata.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@ description: >
33
Context to extract the HTTP route and attach it to existing HTTP server spans and HTTP server
44
metrics.
55
library_link: https://avaje.io/jex/
6+
features:
7+
- HTTP_ROUTE

0 commit comments

Comments
 (0)