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

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_CONNECT_RPC_ERROR_CODE
      The error codes of the Connect request. Error codes are always string values.

    • RPC_CONNECT_RPC_REQUEST_METADATA

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_CONNECT_RPC_REQUEST_METADATA
      Connect request metadata, <key> being the normalized Connect 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 the rpc.connect_rpc.request.metadata.my-custom-key attribute with value ["1.2.3.4", "1.2.3.5"]

    • RPC_CONNECT_RPC_RESPONSE_METADATA

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_CONNECT_RPC_RESPONSE_METADATA
      Connect response metadata, <key> being the normalized Connect 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.connect_rpc.response.metadata.my-custom-key attribute with value ["attribute_value"]

    • RPC_GRPC_REQUEST_METADATA

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_GRPC_REQUEST_METADATA
      gRPC request metadata, <key> being the normalized gRPC 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.grpc.request.metadata.my-custom-key attribute with value ["1.2.3.4", "1.2.3.5"]

    • RPC_GRPC_RESPONSE_METADATA

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> RPC_GRPC_RESPONSE_METADATA
      gRPC response metadata, <key> being the normalized gRPC 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.grpc.response.metadata.my-custom-key attribute with value ["attribute_value"]

    • RPC_GRPC_STATUS_CODE

      public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_GRPC_STATUS_CODE
      The numeric status code of the gRPC request.

    • RPC_JSONRPC_ERROR_CODE

      public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_JSONRPC_ERROR_CODE
      error.code property of response if it is an error response.

    • RPC_JSONRPC_ERROR_MESSAGE

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_JSONRPC_ERROR_MESSAGE
      error.message property of response if it is an error response.

    • RPC_JSONRPC_REQUEST_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_JSONRPC_REQUEST_ID
      id property of request or response. Since protocol allows id to be int, string, null or missing (for notifications), value is expected to be cast to string for simplicity. Use empty string in case of null value. Omit entirely if this is a notification.

    • RPC_JSONRPC_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_JSONRPC_VERSION
      Protocol version as in jsonrpc property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted.

    • RPC_MESSAGE_COMPRESSED_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_MESSAGE_COMPRESSED_SIZE
      Compressed size of the message in bytes.

    • RPC_MESSAGE_ID

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

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_MESSAGE_TYPE
      Whether this is a received or sent message.

    • RPC_MESSAGE_UNCOMPRESSED_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_MESSAGE_UNCOMPRESSED_SIZE
      Uncompressed size of the message in bytes.

    • RPC_METHOD

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_METHOD
      The name of the (logical) method being called, must be equal to the $method part in the span name.

      Notes:

      This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

    • RPC_SERVICE

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SERVICE
      The full (logical) name of the service being called, including its package name, if applicable.

      Notes:

      This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

    • RPC_SYSTEM

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SYSTEM
      A string identifying the remoting system. See below for a list of well-known identifiers.