[exporter/kafka] Add ability to specifiy Kafka Client ID

.chloggen/ra_add-support-client-id.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: "enhancement"
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: "kafkaexporter"
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "Adds the ability to configure the Kafka client's Client ID."
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [30144]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [user, api]

exporter/kafkaexporter/README.md

@@ -26,6 +26,7 @@ The following settings are required:
 The following settings can be optionally configured:
 - `brokers` (default = localhost:9092): The list of kafka brokers.
 - `resolve_canonical_bootstrap_servers_only` (default = false): Whether to resolve then reverse-lookup broker IPs during startup.
+- `client_id` (default = "sarama"): The client ID to configure the Sarama Kafka client with. The client ID will be used for all produce requests.
 - `topic` (default = otlp_spans for traces, otlp_metrics for metrics, otlp_logs for logs): The name of the kafka topic to export to.
 - `encoding` (default = otlp_proto): The encoding of the traces sent to kafka. All available encodings:
  - `otlp_proto`: payload is Protobuf serialized from `ExportTraceServiceRequest` if set as a traces exporter or `ExportMetricsServiceRequest` for metrics or `ExportLogsServiceRequest` for logs.

exporter/kafkaexporter/config.go

@@ -32,6 +32,10 @@ type Config struct {
  // Kafka protocol version
  ProtocolVersion string `mapstructure:"protocol_version"`
 
+ // ClientID to configure the Kafka client with. This can be leveraged by
+ // Kafka to enforce ACLs, throttling quotas, and more.
+ ClientID string `mapstructure:"client_id"`
+
  // The name of the kafka topic to export to (default otlp_spans for traces, otlp_metrics for metrics)
  Topic string `mapstructure:"topic"`
 

exporter/kafkaexporter/config_test.go

@@ -58,6 +58,7 @@ func TestLoadConfig(t *testing.T) {
  Encoding: "otlp_proto",
  PartitionTracesByID: true,
  Brokers: []string{"foo:123", "bar:456"},
+ ClientID: "test_client_id",
  Authentication: kafka.Authentication{
  PlainText: &kafka.PlainTextConfig{
  Username: "jdoe",
@@ -111,6 +112,7 @@ func TestLoadConfig(t *testing.T) {
  Encoding: "otlp_proto",
  PartitionTracesByID: true,
  Brokers: []string{"foo:123", "bar:456"},
+ ClientID: "test_client_id",
  Authentication: kafka.Authentication{
  PlainText: &kafka.PlainTextConfig{
  Username: "jdoe",
@@ -163,6 +165,7 @@ func TestLoadConfig(t *testing.T) {
  Encoding: "otlp_proto",
  PartitionTracesByID: true,
  Brokers: []string{"foo:123", "bar:456"},
+ ClientID: "test_client_id",
  ResolveCanonicalBootstrapServersOnly: true,
  Authentication: kafka.Authentication{
  PlainText: &kafka.PlainTextConfig{

exporter/kafkaexporter/factory.go

@@ -22,6 +22,7 @@ const (
  defaultLogsTopic = "otlp_logs"
  defaultEncoding = "otlp_proto"
  defaultBroker = "localhost:9092"
+ defaultClientID = "sarama"
  // default from sarama.NewConfig()
  defaultMetadataRetryMax = 3
  // default from sarama.NewConfig()
@@ -93,6 +94,7 @@ func createDefaultConfig() component.Config {
  RetrySettings: exporterhelper.NewDefaultRetrySettings(),
  QueueSettings: exporterhelper.NewDefaultQueueSettings(),
  Brokers: []string{defaultBroker},
+ ClientID: defaultClientID,
  // using an empty topic to track when it has not been set by user, default is based on traces or metrics.
  Topic: "",
  Encoding: defaultEncoding,

exporter/kafkaexporter/factory_test.go

@@ -58,6 +58,7 @@ func TestCreateDefaultConfig(t *testing.T) {
  assert.NoError(t, componenttest.CheckConfigStruct(cfg))
  assert.Equal(t, []string{defaultBroker}, cfg.Brokers)
  assert.Equal(t, "", cfg.Topic)
+ assert.Equal(t, "sarama", cfg.ClientID)
 }
 
 func TestCreateMetricExporter(t *testing.T) {

exporter/kafkaexporter/kafka_exporter.go

@@ -122,6 +122,9 @@ func (e *kafkaLogsProducer) Close(context.Context) error {
 
 func newSaramaProducer(config Config) (sarama.SyncProducer, error) {
  c := sarama.NewConfig()
+
+ c.ClientID = config.ClientID
+
  // These setting are required by the sarama.SyncProducer implementation.
  c.Producer.Return.Successes = true
  c.Producer.Return.Errors = true

exporter/kafkaexporter/testdata/config.yaml

@@ -3,6 +3,7 @@ kafka:
  brokers:
  - "foo:123"
  - "bar:456"
+ client_id: "test_client_id"
  metadata:
  full: false
  retry: