Package io.opentelemetry.semconv.incubating

Class MessagingIncubatingAttributes

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

  • Field Details

    • MESSAGING_BATCH_MESSAGE_COUNT

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_BATCH_MESSAGE_COUNT
      The number of messages sent, received, or processed in the scope of the batching operation.

      Notes:

      Instrumentations SHOULD NOT set messaging.batch.message_count on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use messaging.batch.message_count for batching APIs and SHOULD NOT use it for single-message APIs.

    • MESSAGING_CLIENT_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_CLIENT_ID
      A unique identifier for the client that consumes or produces a message.

    • MESSAGING_CONSUMER_GROUP_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_CONSUMER_GROUP_NAME
      The name of the consumer group with which a consumer is associated.

      Notes:

      Semantic conventions for individual messaging systems SHOULD document whether messaging.consumer.group.name is applicable and what it means in the context of that system.

    • MESSAGING_DESTINATION_ANONYMOUS

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_DESTINATION_ANONYMOUS
      A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name).

    • MESSAGING_DESTINATION_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION_NAME
      The message destination name

      Notes:

      Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.

    • MESSAGING_DESTINATION_PARTITION_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION_PARTITION_ID
      The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name.

    • MESSAGING_DESTINATION_SUBSCRIPTION_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION_SUBSCRIPTION_NAME
      The name of the destination subscription from which a message is consumed.

      Notes:

      Semantic conventions for individual messaging systems SHOULD document whether messaging.destination.subscription.name is applicable and what it means in the context of that system.

    • MESSAGING_DESTINATION_TEMPLATE

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION_TEMPLATE
      Low cardinality representation of the messaging destination name

      Notes:

      Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.

    • MESSAGING_DESTINATION_TEMPORARY

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_DESTINATION_TEMPORARY
      A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed.

    • MESSAGING_DESTINATION_PUBLISH_ANONYMOUS

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_DESTINATION_PUBLISH_ANONYMOUS
      Deprecated.
      No replacement at this time.
      Deprecated, no replacement at this time.

    • MESSAGING_DESTINATION_PUBLISH_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION_PUBLISH_NAME
      Deprecated.
      No replacement at this time.
      Deprecated, no replacement at this time.

    • MESSAGING_EVENTHUBS_CONSUMER_GROUP

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_EVENTHUBS_CONSUMER_GROUP
      Deprecated.
      Replaced by messaging.consumer.group.name.
      Deprecated, use messaging.consumer.group.name instead.

    • MESSAGING_EVENTHUBS_MESSAGE_ENQUEUED_TIME

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_EVENTHUBS_MESSAGE_ENQUEUED_TIME
      The UTC epoch seconds at which the message has been accepted and stored in the entity.

    • MESSAGING_GCP_PUBSUB_MESSAGE_ACK_DEADLINE

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_GCP_PUBSUB_MESSAGE_ACK_DEADLINE
      The ack deadline in seconds set for the modify ack deadline request.

    • MESSAGING_GCP_PUBSUB_MESSAGE_ACK_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_GCP_PUBSUB_MESSAGE_ACK_ID
      The ack id for a given message.

    • MESSAGING_GCP_PUBSUB_MESSAGE_DELIVERY_ATTEMPT

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_GCP_PUBSUB_MESSAGE_DELIVERY_ATTEMPT
      The delivery attempt for a given message.

    • MESSAGING_GCP_PUBSUB_MESSAGE_ORDERING_KEY

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_GCP_PUBSUB_MESSAGE_ORDERING_KEY
      The ordering key for a given message. If the attribute is not present, the message does not have an ordering key.

    • MESSAGING_KAFKA_CONSUMER_GROUP

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_KAFKA_CONSUMER_GROUP
      Deprecated.
      Replaced by messaging.consumer.group.name.
      Deprecated, use messaging.consumer.group.name instead.

    • MESSAGING_KAFKA_DESTINATION_PARTITION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_KAFKA_DESTINATION_PARTITION
      Deprecated.
      Replaced by messaging.destination.partition.id.
      Deprecated, use messaging.destination.partition.id instead.

    • MESSAGING_KAFKA_MESSAGE_KEY

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_KAFKA_MESSAGE_KEY
      Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from messaging.message.id in that they're not unique. If the key is null, the attribute MUST NOT be set.

      Notes:

      If the key type is not string, it's string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value.

    • MESSAGING_KAFKA_MESSAGE_OFFSET

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_KAFKA_MESSAGE_OFFSET
      Deprecated.
      Replaced by messaging.kafka.offset.
      Deprecated, use messaging.kafka.offset instead.

    • MESSAGING_KAFKA_MESSAGE_TOMBSTONE

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_KAFKA_MESSAGE_TOMBSTONE
      A boolean that is true if the message is a tombstone.

    • MESSAGING_KAFKA_OFFSET

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_KAFKA_OFFSET
      The offset of a record in the corresponding Kafka partition.

    • MESSAGING_MESSAGE_BODY_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_MESSAGE_BODY_SIZE
      The size of the message body in bytes.

      Notes:

      This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed body size should be used.

    • MESSAGING_MESSAGE_CONVERSATION_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_MESSAGE_CONVERSATION_ID
      The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID".

    • MESSAGING_MESSAGE_ENVELOPE_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_MESSAGE_ENVELOPE_SIZE
      The size of the message body and metadata in bytes.

      Notes:

      This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed size should be used.

    • MESSAGING_MESSAGE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_MESSAGE_ID
      A value used by the messaging system as an identifier for the message, represented as a string.

    • MESSAGING_OPERATION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_OPERATION
      Deprecated.
      Replaced by messaging.operation.type.
      Deprecated, use messaging.operation.type instead.

    • MESSAGING_OPERATION_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_OPERATION_NAME
      The system-specific name of the messaging operation.

    • MESSAGING_OPERATION_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_OPERATION_TYPE
      A string identifying the type of the messaging operation.

      Notes:

      If a custom value is used, it MUST be of low cardinality.

    • MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY
      RabbitMQ message routing key.

    • MESSAGING_RABBITMQ_MESSAGE_DELIVERY_TAG

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_RABBITMQ_MESSAGE_DELIVERY_TAG
      RabbitMQ message delivery tag

    • MESSAGING_ROCKETMQ_CLIENT_GROUP

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_CLIENT_GROUP
      Deprecated.
      Replaced by messaging.consumer.group.name on the consumer spans. No replacement for producer spans.
      Deprecated, use messaging.consumer.group.name instead.

    • MESSAGING_ROCKETMQ_CONSUMPTION_MODEL

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_CONSUMPTION_MODEL
      Model of message consumption. This only applies to consumer spans.

    • MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL
      The delay time level for delay message, which determines the message delay time.

    • MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP
      The timestamp in milliseconds that the delay message is expected to be delivered to consumer.

    • MESSAGING_ROCKETMQ_MESSAGE_GROUP

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_MESSAGE_GROUP
      It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group.

    • MESSAGING_ROCKETMQ_MESSAGE_KEYS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> MESSAGING_ROCKETMQ_MESSAGE_KEYS
      Key(s) of message, another way to mark message besides message id.

    • MESSAGING_ROCKETMQ_MESSAGE_TAG

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_MESSAGE_TAG
      The secondary classifier of message besides topic.

    • MESSAGING_ROCKETMQ_MESSAGE_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_MESSAGE_TYPE
      Type of message.

    • MESSAGING_ROCKETMQ_NAMESPACE

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_NAMESPACE
      Namespace of RocketMQ resources, resources in different namespaces are individual.

    • MESSAGING_SERVICEBUS_DESTINATION_SUBSCRIPTION_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_SERVICEBUS_DESTINATION_SUBSCRIPTION_NAME
      Deprecated.
      Replaced by messaging.destination.subscription.name.
      Deprecated, use messaging.destination.subscription.name instead.

    • MESSAGING_SERVICEBUS_DISPOSITION_STATUS

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_SERVICEBUS_DISPOSITION_STATUS
      Describes the settlement type.

    • MESSAGING_SERVICEBUS_MESSAGE_DELIVERY_COUNT

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_SERVICEBUS_MESSAGE_DELIVERY_COUNT
      Number of deliveries that have been attempted for this message.

    • MESSAGING_SERVICEBUS_MESSAGE_ENQUEUED_TIME

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_SERVICEBUS_MESSAGE_ENQUEUED_TIME
      The UTC epoch seconds at which the message has been accepted and stored in the entity.

    • MESSAGING_SYSTEM

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_SYSTEM
      The messaging system as identified by the client instrumentation.

      Notes:

      The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the messaging.system is set to kafka based on the instrumentation's best knowledge.