Description
This template monitors the Consumer related metrics. It is applicable for the devices containing Kafka application.
Prerequisites
Java must be installed on the device. Gateway should be up and running. The device should be reachable from Gateway. The device should be in managed state.
How to Apply:
For Kafka we have Instance Based Monitoring or Component Discovery Monitoring. In order to do that, we should add the following custom parameter:
application.component.name : Consumer
Create different monitors for different components in Instance based monitoring.
Only one component is allowed per monitor in Instance based monitoring.
We have three different types of Component Discovery Monitoring. They are:
For a single component :
ALL : ALL your instances will be monitored.
Expression : The Instance Names that match the expression will be monitored.
Manual Selection : With this option, you can select the desired instances while applying templates to the device.
Metric Parameters
| Parameter | Description |
|---|---|
| Frequency | Warning Threshold | If the metric value satisfies the condition defined along with Warning Threshold value, then a notification is sent to the user. |
| Critical Threshold | If the metric value satisfies the condition defined along with Critical Threshold value, then a notification is sent to the user. |
| Alert | The alert value can be set to either Yes or No. If it is Yes, then an alert message is sent to the user. |
Metrics
kafka.topic.consumer.fetch.size.avg
Metric Details
| Applicable for | Device |
| Description | The average number of bytes fetched per request for a specific topic. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Consumer Monitor |
| Unit | Req per Sec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 5 | 1 – 1440 (mins) |
| Filter | ||
| Warning Operator | ||
| Warning Threshold | ||
| Warning Repeat Count | ||
| Critical Operator | ||
| Critical Threshold | ||
| Critical Repeat Count | ||
| Alert | No | Yes/No |
| Graph (Yes/No) | Yes | Yes/No |
Sample Output
No graph
kafka.topic.consumer.bytes.consumed
Metric Details
| Applicable for | Device |
| Description | The average number of bytes consumed per second for a specific topic. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Consumer Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 5 | 1 – 1440 (mins) |
| Filter | ||
| Warning Operator | ||
| Warning Threshold | ||
| Warning Repeat Count | ||
| Critical Operator | ||
| Critical Threshold | ||
| Critical Repeat Count | ||
| Alert | No | Yes/No |
| Graph (Yes/No) | Yes | Yes/No |
Sample Output
No graph
kafka.topic.consumer.records.consumed
Metric Details
| Applicable for | Device |
| Description | The average number of records consumed per second for a specific topic. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Consumer Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 5 | 1 – 1440 (mins) |
| Filter | ||
| Warning Operator | ||
| Warning Threshold | ||
| Warning Repeat Count | ||
| Critical Operator | ||
| Critical Threshold | ||
| Critical Repeat Count | ||
| Alert | No | Yes/No |
| Graph (Yes/No) | Yes | Yes/No |
Sample Output
No graph
kafka.topic.consumer.records.perrequest.avg
Metric Details
| Applicable for | Device |
| Description | The average number of records in each request for a specific topic. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Consumer Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 5 | 1 – 1440 (mins) |
| Filter | ||
| Warning Operator | ||
| Warning Threshold | ||
| Warning Repeat Count | ||
| Critical Operator | ||
| Critical Threshold | ||
| Critical Repeat Count | ||
| Alert | No | Yes/No |
| Graph (Yes/No) | Yes | Yes/No |
Sample Output
No graph
kafka.overall.consumer.records.lag.max
Metric Details
| Applicable for | Device |
| Description | Maximum consumer lag of that particular consumer. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Consumer Monitor |
| Unit | count |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 5 | 1 – 1440 (mins) |
| Filter | ||
| Warning Operator | ||
| Warning Threshold | ||
| Warning Repeat Count | ||
| Critical Operator | ||
| Critical Threshold | ||
| Critical Repeat Count | ||
| Alert | No | Yes/No |
| Graph (Yes/No) | Yes | Yes/No |
Sample Output
No graph
kafka.overall.consumer.fetch.rate
Metric Details
| Applicable for | Device |
| Description | The minimum rate at which that particular consumer sends fetch requests to a broker. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Consumer Monitor |
| Unit | Req per Sec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 5 | 1 – 1440 (mins) |
| Filter | ||
| Warning Operator | ||
| Warning Threshold | ||
| Warning Repeat Count | ||
| Critical Operator | ||
| Critical Threshold | ||
| Critical Repeat Count | ||
| Alert | No | Yes/No |
| Graph (Yes/No) | Yes | Yes/No |
Sample Output
No graph