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: docs/messaging/messaging-spans.md
+12-4
Original file line number
Diff line number
Diff line change
@@ -184,18 +184,19 @@ If the destination name is dynamic, such as a [conversation ID](#conversations)
184
184
In these cases, an artificial destination name that best expresses the destination, or a generic, static fallback like `"(anonymous)"` for [anonymous destinations](#temporary-and-anonymous-destinations) SHOULD be used instead.
185
185
186
186
The values allowed for `<operation name>` are defined in the section [Operation names](#operation-names) below.
187
-
If the format above is used, the operation name MUST match the `messaging.operation` attribute defined for message consumer spans below.
188
187
189
188
Examples:
190
189
191
190
*`shop.orders publish`
192
191
*`shop.orders receive`
193
-
*`shop.orders process`
192
+
*`shop.orders settle`
194
193
*`print_jobs publish`
195
-
*`topic with spaces process`
196
-
*`AuthenticationRequest-Conversations process`
194
+
*`topic with spaces deliver`
195
+
*`AuthenticationRequest-Conversations settle`
197
196
*`(anonymous) publish` (`(anonymous)` being a stable identifier for an unnamed destination)
198
197
198
+
Messaging system specific adaptions to span naming MUST be documented in [semantic conventions for specific messaging technologies](#semantic-conventions-for-specific-messaging-technologies).
199
+
199
200
### Operation names
200
201
201
202
The following operations related to messages are defined for these semantic conventions:
@@ -206,6 +207,7 @@ The following operations related to messages are defined for these semantic conv
206
207
|`create`| A message is created. "Create" spans always refer to a single message and are used to provide a unique creation context for messages in batch publishing scenarios. |
207
208
|`receive`| One or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages. |
208
209
|`deliver`| One or more messages are passed to a consumer. This operation refers to push-based scenarios, where consumer register callbacks which get called by messaging SDKs. |
210
+
|`settle`| One or more messages are settled. |
209
211
210
212
### Span kind
211
213
@@ -269,6 +271,12 @@ batch of messages, or for no message at all (if it is signalled that no
269
271
messages were received). For each message it accounts for, the "Deliver" or
270
272
"Receive" span SHOULD link to the message's creation context.
271
273
274
+
"Settle" spans SHOULD be created for every manually or automatically triggered
275
+
settlement operation. A single "Settle" span can account for a single message
276
+
or for multiple messages (in case messages are passed for settling as batches).
277
+
For each message it accounts for, the "Settle" span MAY link to the creation
278
+
context of the message.
279
+
272
280
## Messaging attributes
273
281
274
282
Messaging attributes are organized into the following namespaces:
0 commit comments