Skip to content

feat(stg): add OTel semconv messaging.kafka.cluster.id relationship rules #3088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mborroni merged 3 commits into from
Jul 23, 2026
+75 −6
Merged

feat(stg): add OTel semconv messaging.kafka.cluster.id relationship rules #3088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5dc86b3
feat(stg): add OTel semconv messaging.kafka.cluster.id relationship r…
shashank-reddy-nr Jul 23, 2026
c1f01d7
fix(stg): correct span attribute in ClusterId relationship rules
shashank-reddy-nr Jul 23, 2026
6d56a36
feat(stg): add metric-based relationship rules for messaging.kafka.cl…
shashank-reddy-nr Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions entity-types/infra-kafkatopic/definition.stg.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ synthesis:
tags:
instrumentation.provider:
kafka.cluster.name:
kafka.cluster.id:
topic:

- ruleName: infra_kafkatopic_otel_jmxscraper_stg
Expand Down Expand Up @@ -59,6 +60,7 @@ synthesis:
tags:
instrumentation.provider:
kafka.cluster.name:
kafka.cluster.id:
topic:

- ruleName: infra_kafkatopic_otel_kafkametrics_stg
Expand Down Expand Up @@ -114,6 +116,7 @@ synthesis:
tags:
instrumentation.provider:
kafka.cluster.name:
kafka.cluster.id:
topic:

# Log-based rule: OTel kafkareceiver logs carry topic, kafka.cluster.name, and producer.service.name.
Expand Down
78 changes: 72 additions & 6 deletions relationships/synthesis/EXT-SERVICE-to-KAFKATOPIC.stg.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ relationships:
- field: producerServiceName
attribute: producer.service.name

# Self-hosted Kafka producer span → KAFKATOPIC via kafka.cluster.id + messaging.destination.name
# OTel producer span → KAFKATOPIC via messaging.kafka.cluster.id (OTel incubating semconv)
- name: extServiceProducesSelfHostKafkaTopicClusterIdStg
version: "1"
origins:
Expand All @@ -442,7 +442,7 @@ relationships:
anyOf: [ "producer", "client" ]
- attribute: messaging.destination.name
present: true
- attribute: kafka.cluster.id
- attribute: messaging.kafka.cluster.id
present: true
relationship:
expires: PT75M
Expand All @@ -455,11 +455,11 @@ relationships:
candidateCategory: KAFKATOPIC
fields:
- field: clusterId
attribute: kafka.cluster.id
attribute: messaging.kafka.cluster.id
- field: topic
attribute: messaging.destination.name

# Self-hosted Kafka consumer span → KAFKATOPIC via kafka.cluster.id + messaging.destination.name
# OTel consumer span → KAFKATOPIC via messaging.kafka.cluster.id (OTel incubating semconv)
- name: extServiceConsumesSelfHostKafkaTopicClusterIdStg
version: "1"
origins:
Expand All @@ -476,7 +476,7 @@ relationships:
anyOf: [ "consumer", "server" ]
- attribute: messaging.destination.name
present: true
- attribute: kafka.cluster.id
- attribute: messaging.kafka.cluster.id
present: true
relationship:
expires: PT75M
Expand All @@ -489,7 +489,73 @@ relationships:
candidateCategory: KAFKATOPIC
fields:
- field: clusterId
attribute: kafka.cluster.id
attribute: messaging.kafka.cluster.id
- field: topic
attribute: messaging.destination.name

# Java kafka-clients-cluster-metrics producer metrics → KAFKATOPIC via messaging.kafka.cluster.id + topic
- name: extServiceProducesKafkaClientMetricsTopicClusterIdStg
version: "1"
origins:
- OpenTelemetry
conditions:
- attribute: eventType
anyOf: [ "Metric" ]
- attribute: instrumentation.provider
anyOf: [ "opentelemetry" ]
- attribute: metricName
startsWith: "kafka.producer"
- attribute: entity.type
anyOf: [ "SERVICE" ]
- attribute: messaging.kafka.cluster.id
present: true
- attribute: topic
present: true
relationship:
expires: PT75M
relationshipType: PRODUCES
source:
extractGuid:
attribute: entity.guid
target:
lookupGuid:
candidateCategory: KAFKATOPIC
fields:
- field: clusterId
attribute: messaging.kafka.cluster.id
- field: topic
attribute: topic

# Java kafka-clients-cluster-metrics consumer metrics → KAFKATOPIC via messaging.kafka.cluster.id + topic
- name: extServiceConsumesKafkaClientMetricsTopicClusterIdStg
version: "1"
origins:
- OpenTelemetry
conditions:
- attribute: eventType
anyOf: [ "Metric" ]
- attribute: instrumentation.provider
anyOf: [ "opentelemetry" ]
- attribute: metricName
startsWith: "kafka.consumer"
- attribute: entity.type
anyOf: [ "SERVICE" ]
- attribute: messaging.kafka.cluster.id
present: true
- attribute: topic
present: true
relationship:
expires: PT75M
relationshipType: CONSUMES
source:
extractGuid:
attribute: entity.guid
target:
lookupGuid:
candidateCategory: KAFKATOPIC
fields:
- field: clusterId
attribute: messaging.kafka.cluster.id
- field: topic
attribute: topic

Loading