Skip to main content

RPC_METHOD

rama::telemetry::opentelemetry::semantic_conventions::attribute

Constant RPC_METHOD 

pub const RPC_METHOD: &'static str;
Available on crate features opentelemetry and semconv_experimental only.
Expand description

The fully-qualified logical name of the method from the RPC interface perspective.

§Notes

The method name MAY have unbounded cardinality in edge or error cases.

Some RPC frameworks or libraries provide a fixed set of recognized methods for client stubs and server implementations. Instrumentations for such frameworks MUST set this attribute to the original method name only when the method is recognized by the framework or library.

When the method is not recognized, for example, when the server receives a request for a method that is not predefined on the server, or when instrumentation is not able to reliably detect if the method is predefined, the attribute MUST be set to _OTHER. In such cases, tracing instrumentations MUST also set rpc.method_original attribute to the original method value.

If the RPC instrumentation could end up converting valid RPC methods to _OTHER, then it SHOULD provide a way to configure the list of recognized RPC methods.

The rpc.method can be different from the name of any implementing method/function. The code.function.name attribute may be used to record the fully-qualified method actually executing the call on the server side, or the RPC client stub method on the client side.

§Examples

  • "com.example.ExampleService/exampleMethod"
  • "EchoService/Echo"
  • "_OTHER"