open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update kafka spring example to align with the spec (#1155) 

Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com>
This commit is contained in:
Liudmila Molkova 2024-06-26 10:19:45 +01:00 committed by GitHub
parent db1b84d45d
commit 5a2836bbea
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 45 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.chloggen/1155.yaml Normal file
View File

@ -0,0 +1,4 @@
change_type: bug_fix
component: messaging
note: Update Kafka Spring example to align with the messaging spec
issues: [ 1155 ]

73
docs/messaging/kafka.md
View File

@ -138,41 +138,50 @@ If an intermediary broker is present, `service.name` and `peer.service` will not
### Apache Kafka with Quarkus or Spring Boot Example ### Apache Kafka with Quarkus or Spring Boot Example
Given is a process P, that publishes a message to a topic T1 on Apache Kafka. In this example, the producer publishes a message to a topic T on Apache Kafka.
One process, CA, receives the message and publishes a new message to a topic T2 that is then received and processed by CB. Consumer receives the message, processes it and commits the offset.
Frameworks such as Quarkus and Spring Boot separate processing of a received message from producing subsequent messages out. Frameworks such as Quarkus and Spring Boot provide integrations with Kafka allowing to
For this reason, receiving (Span Rcv1) is the parent of both processing (Span Proc1) and producing a new message (Span Prod2). configure and instrument processing callbacks, so corresponding instrumentations should create "Process"
The span representing message receiving (Span Rcv1) should set `messaging.operation.type` to `process`, spans in addition to "Receive" spans created by Kafka instrumentations for polling calls.
as it does not only receive the message but also converts the input message to something suitable for the processing operation to consume and creates the output message from the result of processing.
``` ```mermaid
Process P: | Span Prod1 | flowchart LR;
-- subgraph PRODUCER
Process CA: | Span Rcv1 | P[Span Send]
| Span Proc1 | end
| Span Prod2 | subgraph CONSUMER
-- direction TB
Process CB: | Span Rcv2 | R1[Span Poll]
R2[Span Process]
R3[Span Commit]
end
P-. link .-R1;
P-. link .-R2;
R2-- parent ---R3;
classDef normal fill:green
class P,R1,R2,R3 normal
linkStyle 0 color:green,stroke:green
linkStyle 1 color:green,stroke:green
``` ```
| Field or Attribute | Span Prod1 | Span Rcv1 | Span Proc1 | Span Prod2 | Span Rcv2 | | Field or Attribute | Span Send | Span Poll | Span Process | Span Commit T |
|-|-|-|-|-|-| |-|-|-|-|-|
| Span name | `"send T1"` | `"send T1"` | `"process T1"` | `"send T2"` | `"poll T2`" | | Span name | `"send T"` | `"poll T"` | `"process T"` | `"commit T"` |
| Parent | | Span Prod1 | Span Rcv1 | Span Rcv1 | Span Prod2 | | Parent | | | (optional) Span Send | Span Process |
| Links | | | | | | | Links | | Span Send | Span Send | |
| SpanKind | `PRODUCER` | `CONSUMER` | `CONSUMER` | `PRODUCER` | `CONSUMER` | | SpanKind | `PRODUCER` | `CONSUMER` | `SERVER` | `CLIENT` |
| Status | `Ok` | `Ok` | `Ok` | `Ok` | `Ok` | | Status | `UNSET` | `UNSET` | `UNSET` | `UNSET` |
| `peer.service` | `"myKafka"` | | | `"myKafka"` | | | `messaging.system` | `"kafka"` | `"kafka"` | `"kafka"` | `"kafka"` |
| `service.name` | | `"myConsumer1"` | `"myConsumer1"` | | `"myConsumer2"` | | `messaging.destination.name` | `"T"` | `"T"` | `"T"` | `"T"` |
| `messaging.system` | `"kafka"` | `"kafka"` | `"kafka"` | `"kafka"` | `"kafka"` | | `messaging.destination.consumer.group` | | `"my-group"` | `"my-group"` | `"my-group"` |
| `messaging.destination.name` | `"T1"` | `"T1"` | `"T1"` | `"T2"` | `"T2"` | | `messaging.destination.partition.id` | `"1"` | `"1"` | `"1"` | `"1"` |
| `messaging.operation.name` | `send` | `send` | `"process"` | `send` | `"poll"` | | `messaging.operation.name` | `"send"` | `"poll"` | `"process"` | `"commit"` |
| `messaging.operation.type` | `publish` | `publish` | `"process"` | `publish` | `"receive"` | | `messaging.operation.type` | `"publish"` | `"receive"` | `"process"` | `"settle"` |
| `messaging.client.id` | | `"5"` | `"5"` | `"5"` | `"8"` | | `messaging.client.id` | `"5"` | `"8"` | `"8"` | `"8"` |
| `messaging.kafka.message.key` | `"myKey"` | `"myKey"` | `"myKey"` | `"anotherKey"` | `"anotherKey"` | | `messaging.kafka.message.key` | `"myKey"` | `"myKey"` | `"myKey"` | |
| `messaging.kafka.consumer.group` | | `"my-group"` | `"my-group"` | | `"another-group"` | | `messaging.kafka.message.offset` | | `"12"` | `"12"` | `"12"` |
| `messaging.kafka.destination.partition` | `"1"` | `"1"` | `"1"` | `"3"` | `"3"` |
| `messaging.kafka.message.offset` | `"12"` | `"12"` | `"12"` | `"32"` | `"32"` |
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status