Skip to content
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

Jump to bottom

Expose kafka client id #4418

Merged
merged 6 commits into from
Jul 13, 2018
Merged

Expose kafka client id #4418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
948e7da
expose client-id
Jun 19, 2018
23fe9fc
Update README.md
PhoenixRion Jul 12, 2018
f2cd6fe
Update README.md
PhoenixRion Jul 12, 2018
f20dce1
Update README.md
PhoenixRion Jul 12, 2018
c514940
add optional to comments
Jul 12, 2018
5143c01
Change example and default id to Telegraf, var name ClientId > ClientID
Jul 13, 2018
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 plugins/inputs/kafka_consumer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ and use the old zookeeper connection method.
## Offset (must be either "oldest" or "newest")
offset = "oldest"

## Optional client id
# client_id = "my_client"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's have the example ID be Telegraf? Perhaps this should be the default instead of "sarama"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default value of sarama is set by the underlying implementation used by both kafka plugins. I can add the logic to set the id to "Telegraf" when a value is not supplied.


## Optional TLS Config
# tls_ca = "/etc/telegraf/ca.pem"
# tls_cert = "/etc/telegraf/cert.pem"
Expand Down
10 changes: 10 additions & 0 deletions plugins/inputs/kafka_consumer/kafka_consumer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (

type Kafka struct {
ConsumerGroup string
ClientID string `toml:"client_id"`
Topics []string
Brokers []string
MaxMessageLen int
Expand Down Expand Up @@ -59,6 +60,9 @@ var sampleConfig = `
brokers = ["localhost:9092"]
## topic(s) to consume
topics = ["telegraf"]

## Optional Client id
# client_id = "Telegraf"

## Optional TLS Config
# tls_ca = "/etc/telegraf/ca.pem"
Expand Down Expand Up @@ -114,6 +118,12 @@ func (k *Kafka) Start(acc telegraf.Accumulator) error {
return err
}

if k.ClientID != "" {
config.ClientID = k.ClientID
} else {
config.ClientID = "Telegraf"
}

if tlsConfig != nil {
log.Printf("D! TLS Enabled")
config.Net.TLS.Config = tlsConfig
Expand Down
3 changes: 3 additions & 0 deletions plugins/outputs/kafka/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ This plugin writes to a [Kafka Broker](http://kafka.apache.org/07/quickstart.htm
## Kafka topic for producer messages
topic = "telegraf"

## Optional client id
# client_id = "my_client"

## Optional topic suffix configuration.
## If the section is omitted, no suffix is used.
## Following topic suffix methods are supported:
Expand Down
11 changes: 11 additions & 0 deletions plugins/outputs/kafka/kafka.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ type (
Brokers []string
// Kafka topic
Topic string
// Kafka client id
ClientID string `toml:"client_id"`
// Kafka topic suffix option
TopicSuffix TopicSuffix `toml:"topic_suffix"`
// Routing Key Tag
Expand Down Expand Up @@ -68,6 +70,9 @@ var sampleConfig = `
brokers = ["localhost:9092"]
## Kafka topic for producer messages
topic = "telegraf"

## Optional Client id
# client_id = "Telegraf"

## Optional topic suffix configuration.
## If the section is omitted, no suffix is used.
Expand Down Expand Up @@ -186,6 +191,12 @@ func (k *Kafka) Connect() error {
}
config := sarama.NewConfig()

if k.ClientID != "" {
config.ClientID = k.ClientID
} else {
config.ClientID = "Telegraf"
}

config.Producer.RequiredAcks = sarama.RequiredAcks(k.RequiredAcks)
config.Producer.Compression = sarama.CompressionCodec(k.CompressionCodec)
config.Producer.Retry.Max = k.MaxRetry
Expand Down