open-telemetry / opentelemetry-java-instrumentation

OpenTelemetry auto-instrumentation and instrumentation libraries for Java
https://opentelemetry.io
Apache License 2.0
1.92k stars 839 forks source link

`rpc.server.duration` metric description is incorrect #9478

Open puckpuck opened 1 year ago

puckpuck commented 1 year ago

Describe the bug

The rpc.server.duration metric has a description that does not conform with the OpenTelemetry semantic convention. This creates an issue when used with OpenTelemetry instrumented services that emit the same metric from a different language SDK (ie: Go). The OpenTelemetry Collector's, Prometheus exporter will specifically drop a metric if received that has the same name but a different description from a metric previously received.

We have run into this issue on the OpenTelemetry Demo project, our workaround is to write a special transform rule to remove descriptions from offending metrics.

Steps to reproduce

Using the gRPC auto instrumentation library with metrics being exported.

Expected behavior

The description for the rpc.server.duration metric should be: Measures the duration of inbound RPC.

This is defined in the OpenTelemetry semantic convention for this metric.

Actual behavior

The description for the rpc.server.duration metric is: The duration of an inbound RPC invocation

Javaagent or library instrumentation version

1.30.0

Environment

No response

Additional context

https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/rpc/RpcServerMetrics.java#L42

trask commented 1 year ago

hey @puckpuck! I think this will be resolved by #9264, we missed getting this into 1.30.0, I just tagged it for 1.31.0 so we will make sure to get it in before then

puckpuck commented 1 year ago

Do you know how to tag this issue so it will close when #9264 is merged?

laurit commented 1 year ago

@puckpuck I have update the pr so that merging it will close this issue