Skip to content

Update metric descriptions to match semantic conventions and add automated verification #14874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

Update metric descriptions to match semantic conventions and add automated verification #14874

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
69b33b6
Initial plan
Copilot Oct 3, 2025
2a7c731
Update RPC metric descriptions to match semantic conventions
Copilot Oct 3, 2025
6ce81c3
Fix GenAI and DB pool metric descriptions to match semantic conventions
Copilot Oct 3, 2025
f191807
Add metric description assertions to RPC tests
Copilot Oct 3, 2025
366bf42
Update GenAI test descriptions to match semantic conventions
Copilot Oct 3, 2025
965881e
Fix DB connection pool test assertion for state attribute description
Copilot Oct 3, 2025
180482c
Add daily workflow to verify metric descriptions match semantic conve…
Copilot Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...va/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbConnectionPoolMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public ObservableLongMeasurement connections() {
.upDownCounterBuilder(metricName)
.setUnit(emitStableDatabaseSemconv() ? "{connection}" : "{connections}")
.setDescription(
"The number of connections that are currently in state described by the state attribute.")
"The number of connections that are currently in state described by the `state` attribute.")
.buildObserver();
}

Expand Down
2 changes: 1 addition & 1 deletion ...java/io/opentelemetry/instrumentation/api/incubator/semconv/genai/GenAiClientMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ private GenAiClientMetrics(Meter meter) {
.histogramBuilder("gen_ai.client.token.usage")
.ofLongs()
.setUnit("{token}")
.setDescription("Measures number of input and output tokens used.")
.setDescription("Number of input and output tokens used.")
.setExplicitBucketBoundariesAdvice(GenAiMetricsAdvice.CLIENT_TOKEN_USAGE_BUCKETS);
GenAiMetricsAdvice.applyClientTokenUsageAdvice(tokenUsageBuilder);
this.tokenUsage = tokenUsageBuilder.build();
Expand Down
2 changes: 1 addition & 1 deletion ...ain/java/io/opentelemetry/instrumentation/api/incubator/semconv/rpc/RpcClientMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ private RpcClientMetrics(Meter meter) {
DoubleHistogramBuilder durationBuilder =
meter
.histogramBuilder("rpc.client.duration")
.setDescription("The duration of an outbound RPC invocation.")
.setDescription("Measures the duration of outbound RPC.")
.setUnit("ms");
RpcMetricsAdvice.applyClientDurationAdvice(durationBuilder);
clientDurationHistogram = durationBuilder.build();
Expand Down
2 changes: 1 addition & 1 deletion ...ain/java/io/opentelemetry/instrumentation/api/incubator/semconv/rpc/RpcServerMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ private RpcServerMetrics(Meter meter) {
DoubleHistogramBuilder durationBuilder =
meter
.histogramBuilder("rpc.server.duration")
.setDescription("The duration of an inbound RPC invocation.")
.setDescription("Measures the duration of inbound RPC.")
.setUnit("ms");
RpcMetricsAdvice.applyServerDurationAdvice(durationBuilder);
serverDurationHistogram = durationBuilder.build();
Expand Down
2 changes: 2 additions & 0 deletions ...java/io/opentelemetry/instrumentation/api/incubator/semconv/rpc/RpcClientMetricsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ void collectsMetrics() {
assertThat(metric)
.hasName("rpc.client.duration")
.hasUnit("ms")
.hasDescription("Measures the duration of outbound RPC.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -112,6 +113,7 @@ void collectsMetrics() {
assertThat(metric)
.hasName("rpc.client.duration")
.hasUnit("ms")
.hasDescription("Measures the duration of outbound RPC.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down
2 changes: 2 additions & 0 deletions ...java/io/opentelemetry/instrumentation/api/incubator/semconv/rpc/RpcServerMetricsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ void collectsMetrics() {
assertThat(metric)
.hasName("rpc.server.duration")
.hasUnit("ms")
.hasDescription("Measures the duration of inbound RPC.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -113,6 +114,7 @@ void collectsMetrics() {
assertThat(metric)
.hasName("rpc.server.duration")
.hasUnit("ms")
.hasDescription("Measures the duration of inbound RPC.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down
24 changes: 12 additions & 12 deletions ...me/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/Aws2BedrockRuntimeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ void testConverseToolCallNoMessageContent() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -333,7 +333,7 @@ void testConverseToolCallNoMessageContent() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -562,7 +562,7 @@ void testConverseToolCallStreamNoMessageContent()
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -735,7 +735,7 @@ void testConverseToolCallStreamNoMessageContent()
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1011,7 +1011,7 @@ void testInvokeModelToolCallAmazonNovaNoMessageContent() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1193,7 +1193,7 @@ void testInvokeModelToolCallAmazonNovaNoMessageContent() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1489,7 +1489,7 @@ public void accept(PayloadPart chunk) {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1714,7 +1714,7 @@ public void accept(PayloadPart chunk) {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1941,7 +1941,7 @@ void testInvokeModelToolCallAnthropicClaudeNoMessageContent() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -2101,7 +2101,7 @@ void testInvokeModelToolCallAnthropicClaudeNoMessageContent() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -2400,7 +2400,7 @@ public void accept(PayloadPart chunk) {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -2600,7 +2600,7 @@ public void accept(PayloadPart chunk) {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down
42 changes: 21 additions & 21 deletions ...ain/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2BedrockRuntimeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ void testConverseBasic() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -289,7 +289,7 @@ void testConverseOptions() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -433,7 +433,7 @@ void testConverseToolCall() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -601,7 +601,7 @@ void testConverseToolCall() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -850,7 +850,7 @@ void testConverseToolCallStream() throws InterruptedException, ExecutionExceptio
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1037,7 +1037,7 @@ void testConverseToolCallStream() throws InterruptedException, ExecutionExceptio
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1265,7 +1265,7 @@ void testConverseStream() throws InterruptedException, ExecutionException {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1501,7 +1501,7 @@ void testInvokeModelAmazonTitan() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1666,7 +1666,7 @@ void testInvokeModelWithResponseStreamAmazonTitan()
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -1840,7 +1840,7 @@ void testInvokeModelAmazonNova() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -2022,7 +2022,7 @@ void testInvokeModelWithResponseStreamAmazonNova()
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -2180,7 +2180,7 @@ void testInvokeModelAnthropicClaude() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -2601,7 +2601,7 @@ void testInvokeModelWithResponseStreamAnthropicClaude()
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -2811,7 +2811,7 @@ void testInvokeModelToolCallAmazonNova() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -3007,7 +3007,7 @@ void testInvokeModelToolCallAmazonNova() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -3324,7 +3324,7 @@ public void accept(PayloadPart chunk) {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -3563,7 +3563,7 @@ public void accept(PayloadPart chunk) {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -3812,7 +3812,7 @@ void testInvokeModelToolCallAnthropicClaude() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -3986,7 +3986,7 @@ void testInvokeModelToolCallAnthropicClaude() {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -4309,7 +4309,7 @@ public void accept(PayloadPart chunk) {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down Expand Up @@ -4523,7 +4523,7 @@ public void accept(PayloadPart chunk) {
metric
.hasName("gen_ai.client.token.usage")
.hasUnit("{token}")
.hasDescription("Measures number of input and output tokens used.")
.hasDescription("Number of input and output tokens used.")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
Expand Down
Loading