Description
This template is applicable on devices that contain the Apache Flume application. This template monitors both the Channel and Sink related metrics.
Prerequisites
Java should be installed on the device.
How to Apply:
For Flume we have Instance Based Monitoring or Component Discovery Monitoring . In order to do that, we should add the following custom parameter:
application.component.name : Channel
application.component.name : Sink
application.component.name : Source
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
flume.channel.channel_capacity
Metric Details
| Applicable for | Device |
| Description | The maximum number of events that can be queued in the channel at any time. For channel types without a capacity limit, the value will be zero. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Channel Monitor |
| Unit | count |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.channel.channel_fill_percentage
Metric Details
| Applicable for | Device |
| Description | Channel Fill Percentage |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Channel Monitor |
| Unit | % |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.channel.channel_size
Metric Details
| Applicable for | Device |
| Description | The number of events currently queued in the channel. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Channel Monitor |
| Unit | NULL |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.channel.event_put_attempt_count
Metric Details
| Applicable for | Device |
| Description | The total number of events that have been attempted to be put into the channel. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Channel Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.channel.event_put_success_count
Metric Details
| Applicable for | Device |
| Description | The total number of events that have successfully been put into the channel. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Channel Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.channel.event_take_attempt_count
Metric Details
| Applicable for | Device |
| Description | The total number of attempts that have been made to take an event from the channel. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Channel Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.channel.event_take_success_count
Metric Details
| Applicable for | Device |
| Description | The total number of events that have successfully been taken from the channel. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Channel Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.sink.batch_complete_count
Metric Details
| Applicable for | Device |
| Description | The number of append batches attempted containing the maximum number of events supported by the next hop. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Sink Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.sink.batch_empty_count
Metric Details
| Applicable for | Device |
| Description | The number of append batches attempted containing zero events. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Sink Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.sink.batch_underflow_count
Metric Details
| Applicable for | Device |
| Description | The number of append batches attempted containing less than the maximum number of events supported by the next hop. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Sink Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.sink.connection_closed_count
Metric Details
| Applicable for | Device |
| Description | The number of connections closed by this sink. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Sink Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.sink.connection_created_count
Metric Details
| Applicable for | Device |
| Description | The number of connections created by this sink. Only applicable to some sink types. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Sink Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.sink.connection_failed_count
Metric Details
| Applicable for | Device |
| Description | The number of failed connections. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Sink Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.sink.event_drain_attempt_count
Metric Details
| Applicable for | Device |
| Description | The total number of events that have been attempted to be drained to the next hop. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Sink Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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
flume.sink.event_drain_success_count
Metric Details
| Applicable for | Device |
| Description | The total number of events that have successfully been drained to the next hop. |
| Category | Application |
| Collector Type | Gateway |
| Monitor Name | Apache Flume Sink Monitor |
| Unit | psec |
Possible Inputs
| Metric | Input Value | Range of Values |
|---|---|---|
| Frequency | 1 | 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