Package io.opentelemetry.semconv.incubating

Class RpcIncubatingAttributes

java.lang.Object
io.opentelemetry.semconv.incubating.RpcIncubatingAttributes
public final class RpcIncubatingAttributes extends Object

  • Field Details

    • RPC_CONNECT_RPC_ERROR_CODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> RPC_CONNECT_RPC_ERROR_CODE
      Deprecated.
      Replaced by rpc.response.status_code.
      Deprecated, use rpc.response.status_code attribute instead.

    • RPC_CONNECT_RPC_REQUEST_METADATA

      @Deprecated public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_CONNECT_RPC_REQUEST_METADATA
      Deprecated.
      Replaced by rpc.request.metadata.
      Deprecated, use rpc.request.metadata instead.

    • RPC_CONNECT_RPC_RESPONSE_METADATA

      @Deprecated public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_CONNECT_RPC_RESPONSE_METADATA
      Deprecated.
      Replaced by rpc.response.metadata.
      Deprecated, use rpc.response.metadata instead.

    • RPC_GRPC_REQUEST_METADATA

      @Deprecated public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_GRPC_REQUEST_METADATA
      Deprecated.
      Replaced by rpc.request.metadata.
      Deprecated, use rpc.request.metadata instead.

    • RPC_GRPC_RESPONSE_METADATA

      @Deprecated public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_GRPC_RESPONSE_METADATA
      Deprecated.
      Replaced by rpc.response.metadata.
      Deprecated, use rpc.response.metadata instead.

    • RPC_GRPC_STATUS_CODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_GRPC_STATUS_CODE
      Deprecated.
      Use string representation of the gRPC status code on the rpc.response.status_code attribute.
      Deprecated, use string representation on the rpc.response.status_code attribute instead.

    • RPC_JSONRPC_ERROR_CODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_JSONRPC_ERROR_CODE
      Deprecated.
      Use string representation of the error code on the rpc.response.status_code attribute.
      Deprecated, use string representation on the rpc.response.status_code attribute instead.

    • RPC_JSONRPC_ERROR_MESSAGE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> RPC_JSONRPC_ERROR_MESSAGE
      Deprecated.
      Use the span status description when reporting JSON-RPC spans.
      Deprecated, use the span status description when reporting JSON-RPC spans.

    • RPC_JSONRPC_REQUEST_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> RPC_JSONRPC_REQUEST_ID
      Deprecated.
      Replaced by jsonrpc.request.id.
      Deprecated, use jsonrpc.request.id instead.

    • RPC_JSONRPC_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> RPC_JSONRPC_VERSION
      Deprecated.
      Replaced by jsonrpc.protocol.version.
      Deprecated, use jsonrpc.protocol.version instead.

    • RPC_MESSAGE_COMPRESSED_SIZE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_MESSAGE_COMPRESSED_SIZE
      Deprecated.
      Deprecated, no replacement at this time.
      Compressed size of the message in bytes.

    • RPC_MESSAGE_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_MESSAGE_ID
      Deprecated.
      Deprecated, no replacement at this time.
      MUST be calculated as two different counters starting from 1 one for sent messages and one for received message.

      Notes:

      This way we guarantee that the values will be consistent between different implementations.

    • RPC_MESSAGE_TYPE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> RPC_MESSAGE_TYPE
      Deprecated.
      Deprecated, no replacement at this time.
      Whether this is a received or sent message.

    • RPC_MESSAGE_UNCOMPRESSED_SIZE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_MESSAGE_UNCOMPRESSED_SIZE
      Deprecated.
      Deprecated, no replacement at this time.
      Uncompressed size of the message in bytes.

    • RPC_METHOD

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_METHOD
      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.

    • RPC_METHOD_ORIGINAL

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_METHOD_ORIGINAL
      The original name of the method used by the client.

    • RPC_REQUEST_METADATA

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_REQUEST_METADATA
      RPC request metadata, <key> being the normalized RPC metadata key (lowercase), the value being the metadata values.

      Notes:

      Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.

      For example, a property my-custom-key with value ["1.2.3.4", "1.2.3.5"] SHOULD be recorded as rpc.request.metadata.my-custom-key attribute with value ["1.2.3.4", "1.2.3.5"]

    • RPC_RESPONSE_METADATA

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_RESPONSE_METADATA
      RPC response metadata, <key> being the normalized RPC metadata key (lowercase), the value being the metadata values.

      Notes:

      Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.

      For example, a property my-custom-key with value ["attribute_value"] SHOULD be recorded as the rpc.response.metadata.my-custom-key attribute with value ["attribute_value"]

    • RPC_RESPONSE_STATUS_CODE

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_RESPONSE_STATUS_CODE
      Status code of the RPC returned by the RPC server or generated by the client

      Notes:

      Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes. Semantic conventions for individual RPC frameworks SHOULD document what rpc.response.status_code means in the context of that system and which values are considered to represent errors.

    • RPC_SERVICE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SERVICE
      Deprecated.
      Value should be included in rpc.method which is expected to be a fully-qualified name.
      Deprecated, use fully-qualified rpc.method instead.

    • RPC_SYSTEM

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SYSTEM
      Deprecated.
      Replaced by rpc.system.name.
      Deprecated, use rpc.system.name attribute instead.

    • RPC_SYSTEM_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SYSTEM_NAME
      The Remote Procedure Call (RPC) system.

      Notes:

      The client and server RPC systems may differ for the same RPC interaction. For example, a client may use Apache Dubbo or Connect RPC to communicate with a server that uses gRPC since both protocols provide compatibility with gRPC.