Update Kafka consumer integration documentation with configuration ecample #20745
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
rtrieu
requested changes
Jul 14, 2025
| @@ -15,7 +15,7 @@ This Agent integration collects message offset metrics from your Kafka consumers | |||
|
|
|||
| ### Installation | |||
|
|
|||
| The Agent's Kafka consumer check is included in the [Datadog Agent][2] package. No additional installation is needed on your Kafka nodes. | |||
| The Agent's Kafka consumer check is included in the [Datadog Agent][2] package. No additional installation is needed on your Kafka nodes, but configuration is still required. | |||
There was a problem hiding this comment.
Suggested change
| The Agent's Kafka consumer check is included in the [Datadog Agent][2] package. No additional installation is needed on your Kafka nodes, but configuration is still required. | |
| The Agent's Kafka consumer check is included in the [Datadog Agent][2] package. No additional installation is needed on your Kafka nodes. However, you still need to configure the integration. |
| @@ -30,6 +30,15 @@ To configure this check for an Agent running on a host running your Kafka consum | |||
|
|
|||
| 1. Edit the `kafka_consumer.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][3]. See the [sample kafka_consumer.d/conf.yaml][4] for all available configuration options. | |||
|
|
|||
| Here's a barebones example configuration: | |||
There was a problem hiding this comment.
Suggested change
| Here's a barebones example configuration: | |
| Here's a basic example configuration to help you get started: |
| - kafka_connect_str: kafka:29092 # Replace with your Kafka cluster address | ||
| monitor_unlisted_consumer_groups: true | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Suggested change
| You can find more detailed configuration options in the sample configuration file linked above. |
temporal-github-worker-1
bot
added
docs/requested-changes
and removed
docs/review-requested
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Updates docs to make it clear configuration is still needed and provides a quick example on how to get started
Motivation
We'll be linking to the Configuration section in DataDog/documentation#30389 and wanted to make sure it wasn't too burdensome when user lands there in figuring out what's needed to configure the kafka consumer integration
Review checklist (to be filled by reviewers)
qa/skip-qalabel if the PR doesn't need to be tested during QA.backport/<branch-name>label to the PR and it will automatically open a backport PR once this one is merged