Skip to content

Add Kafka cluster ID and offset tags to producer/consumer spans #11107

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

Draft
piochelepiotr wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add Kafka cluster ID and offset tags to producer/consumer spans #11107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 2 deletions .../java/datadog/trace/instrumentation/kafka_clients/KafkaConsumerInstrumentationHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package datadog.trace.instrumentation.kafka_clients;

import datadog.trace.api.Config;
import datadog.trace.bootstrap.ContextStore;
import datadog.trace.instrumentation.kafka_common.MetadataState;
import org.apache.kafka.clients.Metadata;
Expand All @@ -16,7 +15,7 @@ public static String extractGroup(KafkaConsumerInfo kafkaConsumerInfo) {
public static String extractClusterId(
KafkaConsumerInfo kafkaConsumerInfo,
ContextStore<Metadata, MetadataState> metadataContextStore) {
if (Config.get().isDataStreamsEnabled() && kafkaConsumerInfo != null) {
if (kafkaConsumerInfo != null) {
Metadata consumerMetadata = kafkaConsumerInfo.getClientMetadata();
if (consumerMetadata != null) {
MetadataState state = metadataContextStore.get(consumerMetadata);
Expand Down
14 changes: 12 additions & 2 deletions ...lients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/KafkaDecorator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.CONSUMER_GROUP;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.KAFKA_BOOTSTRAP_SERVERS;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.KAFKA_CLUSTER_ID;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.MESSAGING_DESTINATION_NAME;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.OFFSET;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.PARTITION;
Expand Down Expand Up @@ -117,6 +118,7 @@ public void onConsume(
final AgentSpan span,
final ConsumerRecord record,
String consumerGroup,
String clusterId,
String bootstrapServers) {
if (record != null) {
final String topic = record.topic() == null ? "kafka" : record.topic();
Expand All @@ -127,7 +129,9 @@ public void onConsume(
if (consumerGroup != null) {
span.setTag(CONSUMER_GROUP, consumerGroup);
}

if (clusterId != null) {
span.setTag(KAFKA_CLUSTER_ID, clusterId);
}
if (bootstrapServers != null) {
span.setTag(KAFKA_BOOTSTRAP_SERVERS, bootstrapServers);
}
Expand All @@ -152,7 +156,10 @@ public void onTimeInQueue(final AgentSpan span, final ConsumerRecord record) {
}

public void onProduce(
final AgentSpan span, final ProducerRecord record, final ProducerConfig producerConfig) {
final AgentSpan span,
final ProducerRecord record,
final ProducerConfig producerConfig,
final String clusterId) {
if (record != null) {
if (record.partition() != null) {
span.setTag(PARTITION, record.partition());
Expand All @@ -163,6 +170,9 @@ public void onProduce(
PRODUCER_BOOSTRAP_SERVERS_CACHE.computeIfAbsent(
producerConfig, BOOTSTRAP_SERVERS_JOINER));
}
if (clusterId != null) {
span.setTag(KAFKA_CLUSTER_ID, clusterId);
}
final String topic = record.topic() == null ? "kafka" : record.topic();
span.setResourceName(PRODUCER_RESOURCE_NAME_CACHE.computeIfAbsent(topic, PRODUCER_PREFIX));
span.setTag(MESSAGING_DESTINATION_NAME, topic);
Expand Down
6 changes: 6 additions & 0 deletions ...0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/KafkaProducerCallback.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package datadog.trace.instrumentation.kafka_clients;

import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.OFFSET;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.PARTITION;
import static datadog.trace.instrumentation.kafka_clients.KafkaDecorator.PRODUCER_DECORATE;

import datadog.trace.api.datastreams.DataStreamsTags;
Expand Down Expand Up @@ -30,6 +32,10 @@ public KafkaProducerCallback(

@Override
public void onCompletion(final RecordMetadata metadata, final Exception exception) {
if (metadata != null) {
span.setTag(PARTITION, metadata.partition());
span.setTag(OFFSET, metadata.offset());
}
PRODUCER_DECORATE.onError(span, exception);
PRODUCER_DECORATE.beforeFinish(span);
span.finish();
Expand Down
8 changes: 4 additions & 4 deletions ...c/main/java/datadog/trace/instrumentation/kafka_clients/KafkaProducerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ public static AgentScope onEnter(
callbackParentSpan = localActiveSpan;
}
PRODUCER_DECORATE.afterStart(span);
PRODUCER_DECORATE.onProduce(span, record, producerConfig);
PRODUCER_DECORATE.onProduce(span, record, producerConfig, clusterId);

callback = new KafkaProducerCallback(callback, callbackParentSpan, span, clusterId);

Expand Down Expand Up @@ -267,10 +267,10 @@ public static class ProducerConstructorAdvice {
public static void captureConfiguration(
@Advice.FieldValue("metadata") Metadata metadata,
@Advice.Argument(0) ProducerConfig producerConfig) {
MetadataState state =
InstrumentationContext.get(Metadata.class, MetadataState.class)
.putIfAbsent(metadata, MetadataState::new);
if (Config.get().isDataStreamsEnabled()) {
MetadataState state =
InstrumentationContext.get(Metadata.class, MetadataState.class)
.putIfAbsent(metadata, MetadataState::new);
KafkaConfigHelper.storePendingProducerConfig(
state, KafkaConfigHelper.extractProducerConfig(producerConfig));
}
Expand Down
2 changes: 1 addition & 1 deletion ...ients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/TracingIterator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ protected void startNewRecordSpan(ConsumerRecord<?, ?> val) {
span.setTag(InstrumentationTags.TOMBSTONE, true);
}
decorator.afterStart(span);
decorator.onConsume(span, val, group, bootstrapServers);
decorator.onConsume(span, val, group, clusterId, bootstrapServers);
if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) {
activateNext(span);
} else {
Expand Down
3 changes: 1 addition & 2 deletions ...a17/datadog/trace/instrumentation/kafka_clients38/KafkaConsumerInstrumentationHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package datadog.trace.instrumentation.kafka_clients38;

import datadog.trace.api.Config;
import datadog.trace.bootstrap.ContextStore;
import datadog.trace.instrumentation.kafka_common.MetadataState;
import org.apache.kafka.clients.Metadata;
Expand All @@ -16,7 +15,7 @@ public static String extractGroup(KafkaConsumerInfo kafkaConsumerInfo) {
public static String extractClusterId(
KafkaConsumerInfo kafkaConsumerInfo,
ContextStore<Metadata, MetadataState> metadataContextStore) {
if (Config.get().isDataStreamsEnabled() && kafkaConsumerInfo != null) {
if (kafkaConsumerInfo != null) {
Metadata metadata = kafkaConsumerInfo.getmetadata().get();
if (metadata != null) {
MetadataState state = metadataContextStore.get(metadata);
Expand Down
14 changes: 12 additions & 2 deletions ...nts-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/KafkaDecorator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.CONSUMER_GROUP;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.KAFKA_BOOTSTRAP_SERVERS;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.KAFKA_CLUSTER_ID;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.MESSAGING_DESTINATION_NAME;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.OFFSET;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.PARTITION;
Expand Down Expand Up @@ -117,6 +118,7 @@ public void onConsume(
final AgentSpan span,
final ConsumerRecord record,
String consumerGroup,
String clusterId,
String bootstrapServers) {
if (record != null) {
final String topic = record.topic() == null ? "kafka" : record.topic();
Expand All @@ -127,7 +129,9 @@ public void onConsume(
if (consumerGroup != null) {
span.setTag(CONSUMER_GROUP, consumerGroup);
}

if (clusterId != null) {
span.setTag(KAFKA_CLUSTER_ID, clusterId);
}
if (bootstrapServers != null) {
span.setTag(KAFKA_BOOTSTRAP_SERVERS, bootstrapServers);
}
Expand All @@ -152,7 +156,10 @@ public void onTimeInQueue(final AgentSpan span, final ConsumerRecord record) {
}

public void onProduce(
final AgentSpan span, final ProducerRecord record, final ProducerConfig producerConfig) {
final AgentSpan span,
final ProducerRecord record,
final ProducerConfig producerConfig,
final String clusterId) {
if (record != null) {
if (record.partition() != null) {
span.setTag(PARTITION, record.partition());
Expand All @@ -163,6 +170,9 @@ public void onProduce(
PRODUCER_BOOSTRAP_SERVERS_CACHE.computeIfAbsent(
producerConfig, BOOTSTRAP_SERVERS_JOINER));
}
if (clusterId != null) {
span.setTag(KAFKA_CLUSTER_ID, clusterId);
}
final String topic = record.topic() == null ? "kafka" : record.topic();
span.setResourceName(PRODUCER_RESOURCE_NAME_CACHE.computeIfAbsent(topic, PRODUCER_PREFIX));
span.setTag(MESSAGING_DESTINATION_NAME, topic);
Expand Down
6 changes: 6 additions & 0 deletions .../src/main/java17/datadog/trace/instrumentation/kafka_clients38/KafkaProducerCallback.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package datadog.trace.instrumentation.kafka_clients38;

import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.OFFSET;
import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.PARTITION;
import static datadog.trace.instrumentation.kafka_clients38.KafkaDecorator.PRODUCER_DECORATE;

import datadog.trace.api.datastreams.DataStreamsTags;
Expand Down Expand Up @@ -29,6 +31,10 @@ public KafkaProducerCallback(

@Override
public void onCompletion(final RecordMetadata metadata, final Exception exception) {
if (metadata != null) {
span.setTag(PARTITION, metadata.partition());
span.setTag(OFFSET, metadata.offset());
}
PRODUCER_DECORATE.onError(span, exception);
PRODUCER_DECORATE.beforeFinish(span);
span.finish();
Expand Down
2 changes: 1 addition & 1 deletion ...nts-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/ProducerAdvice.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public static AgentScope onEnter(
callbackParentSpan = localActiveSpan;
}
PRODUCER_DECORATE.afterStart(span);
PRODUCER_DECORATE.onProduce(span, record, producerConfig);
PRODUCER_DECORATE.onProduce(span, record, producerConfig, clusterId);

callback = new KafkaProducerCallback(callback, callbackParentSpan, span, clusterId);

Expand Down
6 changes: 3 additions & 3 deletions .../main/java17/datadog/trace/instrumentation/kafka_clients38/ProducerConstructorAdvice.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ public class ProducerConstructorAdvice {
public static void captureConfiguration(
@Advice.FieldValue("metadata") Metadata metadata,
@Advice.Argument(0) ProducerConfig producerConfig) {
MetadataState state =
InstrumentationContext.get(Metadata.class, MetadataState.class)
.putIfAbsent(metadata, MetadataState::new);
if (Config.get().isDataStreamsEnabled()) {
MetadataState state =
InstrumentationContext.get(Metadata.class, MetadataState.class)
.putIfAbsent(metadata, MetadataState::new);
KafkaConfigHelper.storePendingProducerConfig(
state, KafkaConfigHelper.extractProducerConfig(producerConfig));
}
Expand Down
2 changes: 1 addition & 1 deletion ...ts-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/TracingIterator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ protected void startNewRecordSpan(ConsumerRecord<?, ?> val) {
span.setTag(InstrumentationTags.TOMBSTONE, true);
}
decorator.afterStart(span);
decorator.onConsume(span, val, group, bootstrapServers);
decorator.onConsume(span, val, group, clusterId, bootstrapServers);
if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) {
activateNext(span);
} else {
Expand Down
1 change: 1 addition & 0 deletions ...al-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/InstrumentationTags.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ public class InstrumentationTags {
public static final String MESSAGE = "message";
public static final String HANDLER_TYPE = "handler.type";
public static final String KAFKA_BOOTSTRAP_SERVERS = "messaging.kafka.bootstrap.servers";
public static final String KAFKA_CLUSTER_ID = "messaging.kafka.cluster.id";
public static final String MESSAGING_DESTINATION_NAME = "messaging.destination.name";
public static final String QUARTZ_JOB_NAME = "quartz.job.name";
public static final String QUARTZ_JOB_GROUP = "quartz.job.group";
Expand Down
Loading