Skip to content

Commit 247d946

Browse files
authored
Merge branch 'main' into test-partitions
2 parents 3ae56f5 + a08a6b4 commit 247d946

File tree

15 files changed

+325
-0
lines changed

15 files changed

+325
-0
lines changed

docs/instrumentation-list.yaml

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6470,6 +6470,12 @@ libraries:
64706470
type: STRING
64716471
jms:
64726472
- name: jms-1.1
6473+
display_name: JMS (Java Message Service)
6474+
description: |
6475+
This instrumentation enables messaging spans for JMS (Java Message Service) message producers and consumers.
6476+
semantic_conventions:
6477+
- MESSAGING_SPANS
6478+
library_link: https://javaee.github.io/javaee-spec/javadocs/javax/jms/package-summary.html
64736479
source_path: instrumentation/jms/jms-1.1
64746480
scope:
64756481
name: io.opentelemetry.jms-1.1
@@ -6478,22 +6484,137 @@ libraries:
64786484
- javax.jms:javax.jms-api:(,)
64796485
- jakarta.jms:jakarta.jms-api:(,3)
64806486
- javax.jms:jms-api:(,)
6487+
configurations:
6488+
- name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
6489+
description: |
6490+
Enables experimental receive telemetry, which will cause consumers to start a new trace, with only a span link connecting it to the producer trace.
6491+
type: boolean
6492+
default: false
6493+
- name: otel.instrumentation.messaging.experimental.capture-headers
6494+
description: |
6495+
Enables capturing messaging headers as span attributes. Provide a comma-separated list of header names to capture.
6496+
type: list
6497+
default: ''
6498+
telemetry:
6499+
- when: default
6500+
spans:
6501+
- span_kind: CONSUMER
6502+
attributes:
6503+
- name: messaging.destination.name
6504+
type: STRING
6505+
- name: messaging.destination.temporary
6506+
type: BOOLEAN
6507+
- name: messaging.message.id
6508+
type: STRING
6509+
- name: messaging.operation
6510+
type: STRING
6511+
- name: messaging.system
6512+
type: STRING
6513+
- span_kind: PRODUCER
6514+
attributes:
6515+
- name: messaging.destination.name
6516+
type: STRING
6517+
- name: messaging.destination.temporary
6518+
type: BOOLEAN
6519+
- name: messaging.message.id
6520+
type: STRING
6521+
- name: messaging.operation
6522+
type: STRING
6523+
- name: messaging.system
6524+
type: STRING
64816525
- name: jms-3.0
6526+
display_name: JMS (Java Message Service)
6527+
description: |
6528+
This instrumentation enables messaging spans for Jakarta JMS (Java Message Service) message producers and consumers.
6529+
semantic_conventions:
6530+
- MESSAGING_SPANS
6531+
library_link: https://jakarta.ee/specifications/messaging/3.0/
64826532
source_path: instrumentation/jms/jms-3.0
64836533
minimum_java_version: 11
64846534
scope:
64856535
name: io.opentelemetry.jms-3.0
64866536
target_versions:
64876537
javaagent:
64886538
- jakarta.jms:jakarta.jms-api:[3.0.0,)
6539+
configurations:
6540+
- name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
6541+
description: |
6542+
Enables experimental receive telemetry, which will cause consumers to start a new trace, with only a span link connecting it to the producer trace.
6543+
type: boolean
6544+
default: false
6545+
- name: otel.instrumentation.messaging.experimental.capture-headers
6546+
description: |
6547+
Enables capturing messaging headers as span attributes. Provide a comma-separated list of header names to capture.
6548+
type: list
6549+
default: ''
6550+
telemetry:
6551+
- when: default
6552+
spans:
6553+
- span_kind: CONSUMER
6554+
attributes:
6555+
- name: messaging.destination.name
6556+
type: STRING
6557+
- name: messaging.message.id
6558+
type: STRING
6559+
- name: messaging.operation
6560+
type: STRING
6561+
- name: messaging.system
6562+
type: STRING
6563+
- span_kind: PRODUCER
6564+
attributes:
6565+
- name: messaging.destination.name
6566+
type: STRING
6567+
- name: messaging.destination.temporary
6568+
type: BOOLEAN
6569+
- name: messaging.message.id
6570+
type: STRING
6571+
- name: messaging.operation
6572+
type: STRING
6573+
- name: messaging.system
6574+
type: STRING
64896575
jodd:
64906576
- name: jodd-http-4.2
6577+
display_name: Jodd HTTP
6578+
description: This instrumentation enables HTTP client spans and HTTP client metrics
6579+
for Jodd HTTP.
6580+
semantic_conventions:
6581+
- HTTP_CLIENT_SPANS
6582+
- HTTP_CLIENT_METRICS
6583+
library_link: https://http.jodd.org/
64916584
source_path: instrumentation/jodd-http-4.2
64926585
scope:
64936586
name: io.opentelemetry.jodd-http-4.2
64946587
target_versions:
64956588
javaagent:
64966589
- org.jodd:jodd-http:[4.2.0,)
6590+
configurations:
6591+
- name: otel.instrumentation.http.known-methods
6592+
description: |
6593+
Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as `_OTHER`.
6594+
type: list
6595+
default: CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE
6596+
- name: otel.instrumentation.http.client.capture-request-headers
6597+
description: List of HTTP request headers to capture in HTTP client telemetry.
6598+
type: list
6599+
default: ''
6600+
- name: otel.instrumentation.http.client.capture-response-headers
6601+
description: List of HTTP response headers to capture in HTTP client telemetry.
6602+
type: list
6603+
default: ''
6604+
- name: otel.instrumentation.common.peer-service-mapping
6605+
description: Used to specify a mapping from host names or IP addresses to peer
6606+
services.
6607+
type: map
6608+
default: ''
6609+
- name: otel.instrumentation.http.client.emit-experimental-telemetry
6610+
description: |
6611+
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.
6612+
type: boolean
6613+
default: false
6614+
- name: otel.instrumentation.http.client.experimental.redact-query-parameters
6615+
description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
6616+
type: boolean
6617+
default: true
64976618
telemetry:
64986619
- when: default
64996620
metrics:
@@ -6535,6 +6656,12 @@ libraries:
65356656
type: STRING
65366657
jsf:
65376658
- name: jsf-mojarra-1.2
6659+
display_name: JSF
6660+
description: |
6661+
This instrumentation enables controller spans for Mojarra JSF action listeners (controller spans are disabled by default).
6662+
library_link: https://github.com/eclipse-ee4j/mojarra
6663+
features:
6664+
- CONTROLLER_SPANS
65386665
source_path: instrumentation/jsf/jsf-mojarra-1.2
65396666
scope:
65406667
name: io.opentelemetry.jsf-mojarra-1.2
@@ -6545,29 +6672,87 @@ libraries:
65456672
- com.sun.faces:jsf-impl:[2.0,2.1)
65466673
- org.glassfish:javax.faces:[2.0.7,3)
65476674
- javax.faces:jsf-impl:[1.2,2)
6675+
configurations:
6676+
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
6677+
description: Enables the creation of experimental controller spans.
6678+
type: boolean
6679+
default: false
6680+
telemetry:
6681+
- when: otel.instrumentation.common.experimental.controller-telemetry.enabled=true
6682+
spans:
6683+
- span_kind: INTERNAL
6684+
attributes: []
65486685
- name: jsf-mojarra-3.0
6686+
display_name: JSF
6687+
description: |
6688+
This instrumentation enables controller spans for Mojarra JSF action listeners (controller spans are disabled by default).
6689+
library_link: https://github.com/eclipse-ee4j/mojarra
6690+
features:
6691+
- CONTROLLER_SPANS
65496692
source_path: instrumentation/jsf/jsf-mojarra-3.0
65506693
minimum_java_version: 11
65516694
scope:
65526695
name: io.opentelemetry.jsf-mojarra-3.0
65536696
target_versions:
65546697
javaagent:
65556698
- org.glassfish:jakarta.faces:[3,)
6699+
configurations:
6700+
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
6701+
description: Enables the creation of experimental controller spans.
6702+
type: boolean
6703+
default: false
6704+
telemetry:
6705+
- when: otel.instrumentation.common.experimental.controller-telemetry.enabled=true
6706+
spans:
6707+
- span_kind: INTERNAL
6708+
attributes: []
65566709
- name: jsf-myfaces-1.2
6710+
display_name: JSF
6711+
description: |
6712+
This instrumentation enables controller spans for Apache MyFaces action listeners (controller spans are disabled by default).
6713+
library_link: https://myfaces.apache.org/
6714+
features:
6715+
- CONTROLLER_SPANS
65576716
source_path: instrumentation/jsf/jsf-myfaces-1.2
65586717
scope:
65596718
name: io.opentelemetry.jsf-myfaces-1.2
65606719
target_versions:
65616720
javaagent:
65626721
- org.apache.myfaces.core:myfaces-impl:[1.2,3)
6722+
configurations:
6723+
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
6724+
description: Enables the creation of experimental controller spans.
6725+
type: boolean
6726+
default: false
6727+
telemetry:
6728+
- when: otel.instrumentation.common.experimental.controller-telemetry.enabled=true
6729+
spans:
6730+
- span_kind: INTERNAL
6731+
attributes: []
65636732
- name: jsf-myfaces-3.0
6733+
display_name: JSF
6734+
description: |
6735+
This instrumentation enables controller spans for Apache MyFaces action listeners (controller spans are disabled by default).
6736+
library_link: https://myfaces.apache.org/
6737+
features:
6738+
- CONTROLLER_SPANS
65646739
source_path: instrumentation/jsf/jsf-myfaces-3.0
65656740
minimum_java_version: 11
65666741
scope:
65676742
name: io.opentelemetry.jsf-myfaces-3.0
65686743
target_versions:
65696744
javaagent:
65706745
- org.apache.myfaces.core:myfaces-impl:[3,)
6746+
configurations:
6747+
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
6748+
description: Enables the creation of experimental controller spans.
6749+
type: boolean
6750+
default: false
6751+
telemetry:
6752+
- when: otel.instrumentation.common.experimental.controller-telemetry.enabled=true
6753+
spans:
6754+
- span_kind: INTERNAL
6755+
attributes: []
65716756
jsp:
65726757
- name: jsp-2.3
65736758
source_path: instrumentation/jsp-2.3

instrumentation-docs/instrumentations.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,12 @@ readonly INSTRUMENTATIONS=(
139139
"jetty:jetty-12.0:javaagent:test"
140140
"jetty-httpclient:jetty-httpclient-12.0:javaagent:test"
141141
"jetty-httpclient:jetty-httpclient-9.2:javaagent:test"
142+
"jms:jms-1.1:javaagent:test"
142143
"jodd-http-4.2:javaagent:test"
144+
"jsf:jsf-mojarra-1.2:javaagent:mojarra2Test"
145+
"jsf:jsf-mojarra-3.0:javaagent:test"
146+
"jsf:jsf-myfaces-1.2:javaagent:myfaces2Test"
147+
"jsf:jsf-myfaces-3.0:javaagent:test"
143148
"kafka:kafka-connect-2.6:testing:test"
144149
"nats:nats-2.17:javaagent:test"
145150
"nats:nats-2.17:javaagent:testExperimental"
@@ -211,6 +216,7 @@ readonly COLIMA_INSTRUMENTATIONS=(
211216
"elasticsearch:elasticsearch-rest-5.0:javaagent:testStableSemconv"
212217
"elasticsearch:elasticsearch-rest-6.4:javaagent:test"
213218
"elasticsearch:elasticsearch-rest-6.4:javaagent:testStableSemconv"
219+
"jms:jms-3.0:javaagent:test"
214220
"oracle-ucp-11.2:javaagent:test"
215221
"oracle-ucp-11.2:javaagent:testStableSemconv"
216222
"spring:spring-jms:spring-jms-6.0:javaagent:test"

instrumentation/jms/jms-1.1/javaagent/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ testing {
5353
tasks {
5454
withType<Test>().configureEach {
5555
usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
56+
systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
5657
}
5758

5859
val testReceiveSpansDisabled by registering(Test::class) {
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
display_name: JMS (Java Message Service)
2+
description: >
3+
This instrumentation enables messaging spans for JMS (Java Message Service) message producers and
4+
consumers.
5+
semantic_conventions:
6+
- MESSAGING_SPANS
7+
library_link: https://javaee.github.io/javaee-spec/javadocs/javax/jms/package-summary.html
8+
configurations:
9+
- name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
10+
description: >
11+
Enables experimental receive telemetry, which will cause consumers to start a new trace, with
12+
only a span link connecting it to the producer trace.
13+
type: boolean
14+
default: false
15+
- name: otel.instrumentation.messaging.experimental.capture-headers
16+
description: >
17+
Enables capturing messaging headers as span attributes. Provide a comma-separated list of
18+
header names to capture.
19+
type: list
20+
default: ''

instrumentation/jms/jms-3.0/javaagent/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ otelJava {
3838
tasks {
3939
test {
4040
usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
41+
systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
4142
}
4243

4344
val testReceiveSpansDisabled by registering(Test::class) {
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
display_name: JMS (Java Message Service)
2+
description: >
3+
This instrumentation enables messaging spans for Jakarta JMS (Java Message Service) message
4+
producers and consumers.
5+
semantic_conventions:
6+
- MESSAGING_SPANS
7+
library_link: https://jakarta.ee/specifications/messaging/3.0/
8+
configurations:
9+
- name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
10+
description: >
11+
Enables experimental receive telemetry, which will cause consumers to start a new trace, with
12+
only a span link connecting it to the producer trace.
13+
type: boolean
14+
default: false
15+
- name: otel.instrumentation.messaging.experimental.capture-headers
16+
description: >
17+
Enables capturing messaging headers as span attributes. Provide a comma-separated list of
18+
header names to capture.
19+
type: list
20+
default: ''
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
display_name: Jodd HTTP
2+
description: This instrumentation enables HTTP client spans and HTTP client metrics for Jodd HTTP.
3+
semantic_conventions:
4+
- HTTP_CLIENT_SPANS
5+
- HTTP_CLIENT_METRICS
6+
library_link: https://http.jodd.org/
7+
configurations:
8+
- name: otel.instrumentation.http.known-methods
9+
description: >
10+
Configures the instrumentation to recognize an alternative set of HTTP request methods. All
11+
other methods will be treated as `_OTHER`.
12+
type: list
13+
default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
14+
- name: otel.instrumentation.http.client.capture-request-headers
15+
description: List of HTTP request headers to capture in HTTP client telemetry.
16+
type: list
17+
default: ""
18+
- name: otel.instrumentation.http.client.capture-response-headers
19+
description: List of HTTP response headers to capture in HTTP client telemetry.
20+
type: list
21+
default: ""
22+
- name: otel.instrumentation.common.peer-service-mapping
23+
description: Used to specify a mapping from host names or IP addresses to peer services.
24+
type: map
25+
default: ""
26+
- name: otel.instrumentation.http.client.emit-experimental-telemetry
27+
description: >
28+
Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
29+
and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
30+
`http.client.response.size` metrics.
31+
type: boolean
32+
default: false
33+
- name: otel.instrumentation.http.client.experimental.redact-query-parameters
34+
description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
35+
type: boolean
36+
default: true

instrumentation/jsf/jsf-mojarra-1.2/javaagent/build.gradle.kts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,6 @@ tasks {
8686
}
8787
tasks.withType<Test>().configureEach {
8888
jvmArgs("-Dotel.instrumentation.common.experimental.controller-telemetry.enabled=true")
89+
systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
90+
systemProperty("metadataConfig", "otel.instrumentation.common.experimental.controller-telemetry.enabled=true")
8991
}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
display_name: JSF
2+
description: >
3+
This instrumentation enables controller spans for Mojarra JSF action listeners (controller spans
4+
are disabled by default).
5+
features:
6+
- CONTROLLER_SPANS
7+
library_link: https://github.com/eclipse-ee4j/mojarra
8+
configurations:
9+
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
10+
description: Enables the creation of experimental controller spans.
11+
type: boolean
12+
default: false

instrumentation/jsf/jsf-mojarra-3.0/javaagent/build.gradle.kts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,7 @@ dependencies {
4040
tasks {
4141
withType<Test>().configureEach {
4242
jvmArgs("-Dotel.instrumentation.common.experimental.controller-telemetry.enabled=true")
43+
systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
44+
systemProperty("metadataConfig", "otel.instrumentation.common.experimental.controller-telemetry.enabled=true")
4345
}
4446
}

0 commit comments

Comments
 (0)