You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification/trace/semantic_conventions/messaging.md
+35-23Lines changed: 35 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,16 +27,18 @@
27
27
28
28
Although messaging systems are not as standardized as, e.g., HTTP, it is assumed that the following definitions are applicable to most of them that have similar concepts at all (names borrowed mostly from JMS):
29
29
30
-
A *message* usually consists of headers (or properties, or meta information) and an optional body. It is sent by a single message *producer* to:
31
-
32
-
* Physically: some message *broker* (which can be e.g., a single server, or a cluster, or a local process reached via IPC). The broker handles the actual routing, delivery, re-delivery, persistence, etc. In some messaging systems the broker may be identical or co-located with (some) message consumers.
33
-
* Logically: some particular message *destination*.
30
+
A *message* is an envelope around a potentially empty payload.
31
+
This envelope may offer the possibility to convey additional metadata, often under the key/value form.
32
+
Messages can be delivered to 0, 1, or multiple consumers depending on the dispatching semantic of the protocol.
33
+
Traditional messaging brokers, such as JMS, use the concept of topics when a message is dispatched to potentially multiple consumers and queues when a message is dispatched to a single consumer.
34
+
In a messaging system such as Apache Kafka, consumer groups are used. Each record, or message, is sent to a single consumer per consumer group.
35
+
Whether a specific message is processed as if it was sent to a topic or queue entirely depends on the consumer groups and their composition.
34
36
35
37
### Destinations
36
38
37
-
A destination is usually identified by some name unique within the messaging system instance, which might look like an URL or a simple one-word identifier.
38
-
Two kinds of destinations are distinguished: *topic*s and *queue*s.
39
-
A message that is sent (the send-operation is often called "*publish*" in this context) to a *topic* is broadcasted to all *subscribers* of the topic.
39
+
A destination is usually identified by some name unique within the messaging system instance, which might look like a URL or a simple one-word identifier.
40
+
Traditional messaging involves two kinds of destinations: *topic*s and *queue*s.
41
+
A message that is sent (the send-operation is often called "*publish*" in this context) to a *topic* is broadcasted to all consumers that have *subscribed* to the topic.
40
42
A message submitted to a queue is processed by a message *consumer* (usually exactly once although some message systems support a more performant at-least-once mode for messages with [idempotent][] processing).
@@ -47,11 +49,10 @@ The consumption of a message can happen in multiple steps.
47
49
First, the lower-level receiving of a message at a consumer, and then the logical processing of the message.
48
50
Often, the waiting for a message is not particularly interesting and hidden away in a framework that only invokes some handler function to process a message once one is received
49
51
(in the same way that the listening on a TCP port for an incoming HTTP message is not particularly interesting).
50
-
However, in a synchronous conversation, the wait time for a message is important.
51
52
52
53
### Conversations
53
54
54
-
In some messaging systems, a message can receive a reply message that answers a particular other message that was sent earlier. All messages that are grouped together by such a reply-relationship are called a *conversation*.
55
+
In some messaging systems, a message can receive a reply message, or possibly multiple, that answers a particular other message that was sent earlier. All messages that are grouped together by such a reply-relationship are called a *conversation*.
55
56
The grouping usually happens through some sort of "In-Reply-To:" meta information or an explicit *conversation ID* (sometimes called *correlation ID*).
56
57
Sometimes a conversation can span multiple message destinations (e.g. initiated via a topic, continued on a temporary one-to-one queue).
57
58
@@ -74,6 +75,7 @@ The span name SHOULD be set to the message destination name and the operation be
74
75
75
76
The destination name SHOULD only be used for the span name if it is known to be of low cardinality (cf. [general span name guidelines](../api.md#span)).
76
77
This can be assumed if it is statically derived from application code or configuration.
78
+
Wherever possible, the preference is to use real destination names over logical or aliased names.
77
79
If the destination name is dynamic, such as a [conversation ID](#conversations) or a value obtained from a `Reply-To` header, it SHOULD NOT be used for the span name.
78
80
In these cases, an artificial destination name that best expresses the destination, or a generic, static fallback like `"(temporary)"` for [temporary destinations](#temporary-destinations) SHOULD be used instead.
79
81
@@ -118,14 +120,15 @@ The following operations related to messages are defined for these semantic conv
118
120
|`messaging.protocol`| string | The name of the transport protocol. |`AMQP`<br>`MQTT`| No |
119
121
|`messaging.protocol_version`| string | The version of the transport protocol. |`0.9.1`| No |
120
122
|`messaging.url`| string | Connection string. |`tibjmsnaming://localhost:7222`<br>`https://queue.amazonaws.com/80398EXAMPLE/MyQueue`| No |
123
+
|`messaging.service`| string | Name of the external broker, or name of the service being interacted with. See note below for a definition. | No |
121
124
|`messaging.message_id`| string | A value used by the messaging system as an identifier for the message, represented as a string. |`452a7c7c7c7048c2f887f61572b18fc2`| No |
122
125
|`messaging.conversation_id`| string | The [conversation ID](#conversations) identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". |`MyConversationId`| No |
123
126
|`messaging.message_payload_size_bytes`| number | The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported. |`2738`| No |
124
127
|`messaging.message_payload_compressed_size_bytes`| number | The compressed size of the message payload in bytes. |`2048`| No |
125
128
126
129
**[1]:** Required only if the message destination is either a `queue` or `topic`.
127
130
128
-
**Additional attribute requirements:** At least one of the following sets of attributes is required:
131
+
**Additional attribute recommendations:** At least one of the following sets of attributes is recommended:
129
132
130
133
*[`net.peer.name`](span-general.md)
131
134
*[`net.peer.ip`](span-general.md)
@@ -140,6 +143,7 @@ The following operations related to messages are defined for these semantic conv
140
143
141
144
Additionally `net.peer.port` from the [network attributes][] is recommended.
142
145
Furthermore, it is strongly recommended to add the [`net.transport`][] attribute and follow its guidelines, especially for in-process queueing systems (like [Hangfire][], for example).
146
+
`messaging.service` refers to the logical name of the external broker or messaging system where a message was sent to, or received from. In an environment such as Kubernetes, it would be the Kubernetes Service Name.
143
147
These attributes should be set to the broker to which the message is sent/from which it is received.
|`messaging.kafka.message_key`| Differs from `messaging.message_id` in that it's not unique, and can be `null`. The type is a String representation of the type of the actual value. |
190
+
|`messaging.kafka.consumer_group`| Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers. |
191
+
|`messaging.kafka.client_id`| Client Id for the Consumer or Producer that is handling the message. |
192
+
|`messaging.kafka.partition`| Partition the message is sent to. |
Given is a process P, that sends two messages to a queue Q on messaging system MS, and a process C, which receives both of them in one batch (Span Recv1) and processes each message separately (Spans Proc1 and Proc2).
224
+
Given is a process P, that sends two messages to a topic Q on messaging system MS, and a process C, which receives both of them in one batch (Span Recv1) and processes each message separately (Spans Proc1 and Proc2).
211
225
212
226
Since a span can only have one parent and the propagated trace and span IDs are not known when the receiving span is started, the receiving span will have no parent and the processing spans are correlated with the producing spans using links.
Given is a process P, that sends two messages to a queue Q on messaging system MS, and a process C, which receives both of them separately (Span Recv1 and Recv2) and processes both messages in one batch (Span Proc1).
252
+
Given is a process P, that sends two messages to a topic Q on messaging system MS, and a process C, which receives both of them separately (Span Recv1 and Recv2) and processes both messages in one batch (Span Proc1).
240
253
241
254
Since each span can only have one parent, C3 should not choose a random parent out of C1 and C2, but rather rely on the implicitly selected parent as defined by the [tracing API spec](../api.md).
242
255
Similarly, only one value can be set as `message_id`, so C3 cannot report both `a1` and `a2` and therefore attribute is left out.
0 commit comments