Description
This template monitors the Producer 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 : Producer
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.producer.buffer.available.bytes
Metric Details
| Applicable for | Device |
| Description | The total amount of buffer memory that is not being used (either unallocated or in the free list). |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.batch.size.avg
Metric Details
| Applicable for | Device |
| Description | The average number of bytes sent per partition per-request. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.compression.rate.avg
Metric Details
| Applicable for | Device |
| Description | The average compression rate of record batches. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.bufferpool.wait.time
Metric Details
| Applicable for | Device |
| Description | The fraction of time an appender waits for space allocation. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer Monitor |
| Unit | ms |
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.producer.batch.size.max
Metric Details
| Applicable for | Device |
| Description | The max number of bytes sent per partition per-request. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.record.send.rate
Metric Details
| Applicable for | Device |
| Description | The average number of records sent per second for a topic. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.record.retry.rate
Metric Details
| Applicable for | Device |
| Description | The average per-second number of retried record sends for a topic. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.record.error.rate
Metric Details
| Applicable for | Device |
| Description | The average per-second number of retried record sends for a topic. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.records.perrequest.avg
Metric Details
| Applicable for | Device |
| Description | The average number of records sent per second. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.record.queue.time.avg
Metric Details
| Applicable for | Device |
| Description | The average time in ms record batches spent in the record accumulator. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer Monitor |
| Unit | ms |
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.producer.record.queue.time.max
Metric Details
| Applicable for | Device |
| Description | The maximum time in ms record batches spent in the record accumulator. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer Monitor |
| Unit | ms |
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.producer.record.size.avg
Metric Details
| Applicable for | Device |
| Description | The average record size. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.record.size.max
Metric Details
| Applicable for | Device |
| Description | The maximum record size. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.requests.in.flight
Metric Details
| Applicable for | Device |
| Description | The current number of in-flight requests awaiting a response. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.metadata.age
Metric Details
| Applicable for | Device |
| Description | The age in seconds of the current producer metadata being used. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer Monitor |
| Unit | s |
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.producer.buffer.bytes.total
Metric Details
| Applicable for | Device |
| Description | The maximum amount of buffer memory the client can use (whether or not it is currently used). |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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.producer.waiting.threads
Metric Details
| Applicable for | Device |
| Description | The number of user threads blocked waiting for buffer memory to enqueue their records. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Kafka Producer 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