{
  "configurations": [
    {
      "declarative_name": "java.common.messaging.capture_headers/development",
      "default": "",
      "description": "A comma-separated list of header names to capture as span attributes.",
      "name": "otel.instrumentation.messaging.experimental.capture-headers",
      "type": "list"
    },
    {
      "declarative_name": "java.kafka.experimental_span_attributes/development",
      "default": false,
      "description": "Enables the capture of the experimental consumer attributes `kafka.record.queue_time_ms` and `messaging.kafka.bootstrap.servers`.",
      "name": "otel.instrumentation.kafka.experimental-span-attributes",
      "type": "boolean"
    },
    {
      "declarative_name": "java.kafka.producer_propagation.enabled",
      "default": true,
      "description": "Enable context propagation for Kafka message producers.",
      "name": "otel.instrumentation.kafka.producer-propagation.enabled",
      "type": "boolean"
    },
    {
      "declarative_name": "java.common.messaging.receive_telemetry/development.enabled",
      "default": false,
      "description": "Enables experimental receive telemetry, which will cause consumers to start a new trace, with only a span link connecting it to the producer trace.",
      "name": "otel.instrumentation.messaging.experimental.receive-telemetry.enabled",
      "type": "boolean"
    }
  ],
  "description": "This instrumentation enables messaging spans for Kafka producers and consumers, and collects internal Kafka client metrics.",
  "display_name": "Apache Kafka Client",
  "has_javaagent": true,
  "javaagent_target_versions": [
    "org.apache.kafka:kafka-clients:[0.11.0.0,)"
  ],
  "library_link": "https://kafka.apache.org/",
  "name": "kafka-clients-0.11",
  "scope": {
    "name": "io.opentelemetry.kafka-clients-0.11"
  },
  "semantic_conventions": [
    "MESSAGING_SPANS"
  ],
  "source_path": "instrumentation/kafka/kafka-clients/kafka-clients-0.11",
  "telemetry": [
    {
      "spans": [
        {
          "attributes": [
            {
              "name": "messaging.batch.message_count",
              "type": "LONG"
            },
            {
              "name": "messaging.client_id",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.name",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.partition.id",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.consumer.group",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.key",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.offset",
              "type": "LONG"
            },
            {
              "name": "messaging.kafka.message.tombstone",
              "type": "BOOLEAN"
            },
            {
              "name": "messaging.message.body.size",
              "type": "LONG"
            },
            {
              "name": "messaging.operation",
              "type": "STRING"
            },
            {
              "name": "messaging.system",
              "type": "STRING"
            }
          ],
          "span_kind": "CONSUMER"
        },
        {
          "attributes": [
            {
              "name": "messaging.client_id",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.name",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.partition.id",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.key",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.offset",
              "type": "LONG"
            },
            {
              "name": "messaging.kafka.message.tombstone",
              "type": "BOOLEAN"
            },
            {
              "name": "messaging.operation",
              "type": "STRING"
            },
            {
              "name": "messaging.system",
              "type": "STRING"
            }
          ],
          "span_kind": "PRODUCER"
        }
      ],
      "when": "default"
    },
    {
      "spans": [
        {
          "attributes": [
            {
              "name": "kafka.record.queue_time_ms",
              "type": "LONG"
            },
            {
              "name": "messaging.batch.message_count",
              "type": "LONG"
            },
            {
              "name": "messaging.client_id",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.name",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.partition.id",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.consumer.group",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.key",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.offset",
              "type": "LONG"
            },
            {
              "name": "messaging.kafka.message.tombstone",
              "type": "BOOLEAN"
            },
            {
              "name": "messaging.message.body.size",
              "type": "LONG"
            },
            {
              "name": "messaging.operation",
              "type": "STRING"
            },
            {
              "name": "messaging.system",
              "type": "STRING"
            }
          ],
          "span_kind": "CONSUMER"
        },
        {
          "attributes": [
            {
              "name": "messaging.client_id",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.name",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.partition.id",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.bootstrap.servers",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.key",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.offset",
              "type": "LONG"
            },
            {
              "name": "messaging.kafka.message.tombstone",
              "type": "BOOLEAN"
            },
            {
              "name": "messaging.operation",
              "type": "STRING"
            },
            {
              "name": "messaging.system",
              "type": "STRING"
            }
          ],
          "span_kind": "PRODUCER"
        }
      ],
      "when": "otel.instrumentation.kafka.experimental-span-attributes=true"
    },
    {
      "spans": [
        {
          "attributes": [
            {
              "name": "messaging.batch.message_count",
              "type": "LONG"
            },
            {
              "name": "messaging.client_id",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.name",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.partition.id",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.key",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.tombstone",
              "type": "BOOLEAN"
            },
            {
              "name": "messaging.kafka.offset",
              "type": "LONG"
            },
            {
              "name": "messaging.message.body.size",
              "type": "LONG"
            },
            {
              "name": "messaging.operation",
              "type": "STRING"
            },
            {
              "name": "messaging.system",
              "type": "STRING"
            }
          ],
          "span_kind": "CONSUMER"
        },
        {
          "attributes": [
            {
              "name": "messaging.client_id",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.name",
              "type": "STRING"
            },
            {
              "name": "messaging.destination.partition.id",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.key",
              "type": "STRING"
            },
            {
              "name": "messaging.kafka.message.tombstone",
              "type": "BOOLEAN"
            },
            {
              "name": "messaging.kafka.offset",
              "type": "LONG"
            },
            {
              "name": "messaging.operation",
              "type": "STRING"
            },
            {
              "name": "messaging.system",
              "type": "STRING"
            }
          ],
          "span_kind": "PRODUCER"
        }
      ],
      "when": "otel.semconv-stability.opt-in=messaging"
    }
  ]
}