Metrics
The ElastiFlow Unified Collectors expose the /metrics
endpoint to provide Prometheus-compatible statistics related to its performance and the resources it uses.
The endpoint returns data in a Prometheus text-based exposition format. Please refer to the Prometheus documentation to learn more.
Statistics
This section describes the statistics that can be retrieved from the /metrics
endpoint.
app_info
app_info
provides application details. The following is an example of an app_info
record:
The app_info
data provides the following labels:
Label | Description |
---|---|
| environment running application |
| number of cpus available |
| native install or Docker |
| name of machine |
| operating system running application |
| run id of application |
license_units
license_units
provides license details. The following is an example of a license_units
record:
The license_units
record provides the following labels:
Label | Description |
---|---|
| account id of license. |
| license expiration date. |
| license level. |
| is riskiq disabled for license. |
Flow UDP Server
The following statistics are provided for the UDP Server input.
udp_server_packet_queue_util
udp_server_packet_queue_util
provides the utilization of the packet queue, which stores received packets waiting to be processed.
The udp_server_packet_queue_util
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
udp_server_packets_received_total
udp_server_packets_received_total
provides the total count of packets received by the UDP Server.
The udp_server_packets_received_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The port on which the UDP server listens. |
udp_server_bytes_received_total
udp_server_bytes_received_total
provides the total count of bytes received by the UDP Server.
The udp_server_bytes_received_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The port on which the UDP server listens. |
Processor
record_queue_util
Ratio of the record queue size divided by its capacity.
The record_queue_util
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
Elasticsearch Output
outputs_records_received_total
outputs_records_received_total
provides the total count of records received by the output.
The outputs_records_received_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_records_sent_total
outputs_records_sent_total
provides the total count of records sent by the output.
The outputs_records_sent_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_bulk_requests_total
outputs_bulk_requests_total
provides the total count of bulk requests sent by the output.
The outputs_bulk_requests_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_bulk_requests_errored_total
outputs_bulk_requests_errored_total
provides the total count of errored bulk requests.
The outputs_bulk_requests_errored_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_records_errored_total
outputs_records_errored_total
provides the total count of errored records.
The outputs_records_errored_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
OpenSearch Output
outputs_records_received_total
outputs_records_received_total
provides the total count of records received by the output.
The outputs_records_received_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_records_sent_total
outputs_records_sent_total
provides the total count of records sent by the output.
The outputs_records_sent_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_bulk_requests_total
outputs_bulk_requests_total
provides the total count of bulk requests sent by the output.
The outputs_bulk_requests_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_bulk_requests_errored_total
outputs_bulk_requests_errored_total
provides the total count of errored bulk requests.
The outputs_bulk_requests_errored_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_records_errored_total
outputs_records_errored_total
provides the total count of errored records.
The outputs_records_errored_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
Cribl Output
outputs_records_received_total
outputs_records_received_total
provides the total count of records received by the output.
The outputs_records_received_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_records_sent_total
outputs_records_sent_total
provides the total count of records sent by the output.
The outputs_records_sent_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_bulk_requests_total
outputs_bulk_requests_total
provides the total count of bulk requests sent by the output.
The outputs_bulk_requests_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_bulk_requests_errored_total
outputs_bulk_requests_errored_total
provides the total count of errored bulk requests.
The outputs_bulk_requests_errored_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_records_errored_total
outputs_records_errored_total
provides the total count of errored records.
The outputs_records_errored_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
Kafka Output
kafka_producer_messages_errored_total
kafka_producer_messages_errored_total
provides the total count of errored messages.
The kafka_producer_messages_errored_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the kafka topic. |
| The Kafka producer client ID. |
| The type of message produced. |
| The name of the namespace. |
kafka_producer_messages_sent_total
kafka_producer_messages_sent_total
provides the total count of messages produced by the output.
The kafka_producer_messages_sent_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the kafka topic. |
| The Kafka producer client ID. |
| The type of message produced. |
| The name of the namespace. |
Splunk Output
outputs_records_received_total
outputs_records_received_total
provides the total count of records received by the output.
The outputs_records_received_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_records_sent_total
outputs_records_sent_total
provides the total count of records sent by the output.
The outputs_records_sent_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_bulk_requests_total
outputs_bulk_requests_total
provides the total count of bulk requests sent by the output.
The outputs_bulk_requests_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_bulk_requests_errored_total
outputs_bulk_requests_errored_total
provides the total count of errored bulk requests.
The outputs_bulk_requests_errored_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |
outputs_records_errored_total
outputs_records_errored_total
provides the total count of errored records.
The outputs_records_errored_total
record provides the following labels:
Label | Description |
---|---|
| The name of the application. |
| The name of the namespace. |
| The name of the output. |