Skip to content

Update Kafka consumer integration documentation with configuration ecample #20745

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

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

Update Kafka consumer integration documentation with configuration ecample #20745

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
11 changes: 10 additions & 1 deletion kafka_consumer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

### 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.


### Configuration

Expand All @@ -30,6 +30,15 @@

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:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Here's a barebones example configuration:
Here's a basic example configuration to help you get started:

```yaml
init_config:

instances:
- kafka_connect_str: kafka:29092 # Replace with your Kafka cluster address
monitor_unlisted_consumer_groups: true
```

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
You can find more detailed configuration options in the sample configuration file linked above.

2. [Restart the Agent][5].

##### Log collection
Expand Down Expand Up @@ -128,14 +137,14 @@
- [Monitoring Kafka with Datadog][15]

[1]: https://raw.githubusercontent.com/DataDog/integrations-core/master/kafka_consumer/images/kafka_dashboard.png
[2]: /account/settings/agent/latest

Check failure on line 140 in kafka_consumer/README.md

View check run for this annotation

datadog-assets / validate-documentation_readme

Error in documentation_readme 

The following Datadog docs page doesn't exist: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory
[3]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory
[4]: https://github.com/DataDog/integrations-core/blob/master/kafka_consumer/datadog_checks/kafka_consumer/data/conf.yaml.example

Check failure on line 142 in kafka_consumer/README.md

View check run for this annotation

datadog-assets / validate-documentation_readme

Error in documentation_readme 

The following Datadog docs page doesn't exist: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[6]: https://docs.datadoghq.com/integrations/kafka/#log-collection

Check failure on line 144 in kafka_consumer/README.md

View check run for this annotation

datadog-assets / validate-documentation_readme

Error in documentation_readme 

The following Datadog docs page doesn't exist: https://docs.datadoghq.com/agent/guide/autodiscovery-with-jmx/?tab=containerizedagent
[7]: https://docs.datadoghq.com/agent/guide/autodiscovery-with-jmx/?tab=containerizedagent

Check failure on line 145 in kafka_consumer/README.md

View check run for this annotation

datadog-assets / validate-documentation_readme

Error in documentation_readme 

The following Datadog docs page doesn't exist: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[8]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[9]: https://github.com/DataDog/integrations-core/blob/master/kafka_consumer/metadata.csv

Check failure on line 147 in kafka_consumer/README.md

View check run for this annotation

datadog-assets / validate-documentation_readme

Error in documentation_readme 

The following Datadog docs page doesn't exist: https://docs.datadoghq.com/integrations/faq/troubleshooting-and-deep-dive-for-kafka/
[10]: https://docs.datadoghq.com/integrations/faq/troubleshooting-and-deep-dive-for-kafka/
[11]: https://docs.datadoghq.com/integrations/guide/agent-failed-to-retrieve-rmiserver-stub/
[13]: https://www.datadoghq.com/blog/monitoring-kafka-performance-metrics
Expand Down
Loading