You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: kafka_consumer/README.md
+29-24Lines changed: 29 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,54 +20,57 @@ The Agent's Kafka consumer check is included in the [Datadog Agent][2] package.
20
20
### Configuration
21
21
22
22
<!-- xxx tabs xxx -->
23
-
<!-- xxx tab "Host" xxx -->
24
-
25
-
#### Host
26
-
27
-
To configure this check for an Agent running on a host running your Kafka consumers:
28
-
29
-
##### Metric collection
30
-
31
-
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.
32
-
33
-
2.[Restart the Agent][5].
34
-
35
-
##### Log collection
36
-
37
-
This check does not collect additional logs. To collect logs from Kafka brokers, see [log collection instructions for Kafka][6].
38
-
39
-
<!-- xxz tab xxx -->
40
23
<!-- xxx tab "Containerized" xxx -->
41
24
42
25
#### Containerized
43
26
44
-
For containerized environments, see the [Autodiscovery Integration Templates][17] for guidance on applying the parameters below.
45
-
46
-
##### Metric collection
27
+
Configure this check on a container running the Kafka Consumer.
28
+
See the [Autodiscovery Integration Templates][17] for guidance on applying the parameters below.
29
+
In Kubernetes, if a single consumers is running on many containers, you can setup this check as a [Cluster Check][20] to avoid having multiple checks collecting the same metrics.
Configure this check on a host running the Kafka Consumer.
41
+
Avoid having multiple Agents running with the same check configuration, as this puts additional pressure on your Kafka cluster.
42
+
43
+
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. A minimal setup is:
44
+
45
+
```
46
+
instances:
47
+
- kafka_connect_str: <KAFKA_CONNECT_STR>
48
+
consumer_groups:
49
+
# Monitor all topics for consumer <CONSUMER_NAME>
50
+
<CONSUMER_NAME>: {}
51
+
```
52
+
53
+
2.[Restart the Agent][5].
55
54
56
-
This check does not collect additional logs. To collect logs from Kafka brokers, see [log collection instructions for Kafka][6].
57
55
58
56
<!-- xxz tab xxx -->
59
57
<!-- xxz tabs xxx -->
60
58
61
59
### Validation
62
60
63
-
[Run the Agent's status subcommand][8] and look for `kafka_consumer` under the Checks section.
61
+
1.[Run the Agent's status subcommand][8] and look for `kafka_consumer` under the Checks section.
62
+
2. Ensure the metric `kafka.consumer_lag` is generated for the appropriate `consumer_group`.
64
63
65
64
## Data Collected
66
65
67
66
### Metrics
68
67
69
68
See [metadata.csv][9] for a list of metrics provided by this check.
70
69
70
+
### Kafka messages
71
+
72
+
This integration is used by [Data Streams Monitoring][18] to [retrieve messages from Kafka on demand][21].
73
+
71
74
### Events
72
75
73
76
**consumer_lag**:<br>
@@ -144,3 +147,5 @@ sudo service datadog-agent restart
0 commit comments