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.
Information
This section describes the information metrics 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:
app_info{arch="arm64",cpus="8",env="native",hostname="M1-MacBook-Pro.local",os="darwin",run_id="b1214e11-198f-43e7-81f1-c9986e9b3ff7",version="7.5"} 1
The app_info data provides the following labels:
| Label | Description |
|---|---|
arch | environment running application |
cpus | number of cpus available |
env | native install or Docker |
hostname | name of machine |
os | operating system running application |
run_id | run id of application |
version | version of the collector |
license_info
license_info provides license details. The following is an example of a license_info record:
license_info{account_id="account_id",application="flowcoll",expiration="1772150400",instance_name="default",level="7"} 1
The license_info record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
account_id | account id of license |
expiration | license expiration date (unix time) |
level | license level |
Elasticsearch Output
outputs_records_received_total
outputs_records_received_total provides the total count of records received by the output.
outputs_records_received_total{application="flowcoll",instance_name="default",namespace="default",output="elasticsearch",record_type="flow"} 2
The outputs_records_received_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
outputs_records_sent_total
outputs_records_sent_total provides the total count of records sent by the output.
outputs_records_sent_total{application="flowcoll",instance_name="default",namespace="default",output="elasticsearch",record_type="flow"} 2
The outputs_records_sent_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
outputs_bulk_requests_total
outputs_bulk_requests_total provides the total count of bulk requests sent by the output.
outputs_bulk_requests_total{application="flowcoll",instance_name="default",namespace="default",output="elasticsearch"} 2
The outputs_bulk_requests_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
outputs_bulk_requests_errored_total
outputs_bulk_requests_errored_total provides the total count of errored bulk requests.
outputs_bulk_requests_errored_total{application="flowcoll",instance_name="default",namespace="default",output="elasticsearch"} 0
The outputs_bulk_requests_errored_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
outputs_records_errored_total
outputs_records_errored_total provides the total count of errored records.
outputs_records_errored_total{application="flowcoll",instance_name="default",namespace="default",output="elasticsearch",record_type="flow"} 1
The outputs_records_errored_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
OpenSearch Output
outputs_records_received_total
outputs_records_received_total provides the total count of records received by the output.
outputs_records_received_total{application="flowcoll",instance_name="default",namespace="default",output="opensearch",record_type="flow"} 2
The outputs_records_received_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
outputs_records_sent_total
outputs_records_sent_total provides the total count of records sent by the output.
outputs_records_sent_total{application="flowcoll",instance_name="default",namespace="default",output="opensearch",record_type="flow"} 2
The outputs_records_sent_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
outputs_bulk_requests_total
outputs_bulk_requests_total provides the total count of bulk requests sent by the output.
outputs_bulk_requests_total{application="flowcoll",instance_name="default",namespace="default",output="opensearch"} 2
The outputs_bulk_requests_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
outputs_bulk_requests_errored_total
outputs_bulk_requests_errored_total provides the total count of errored bulk requests.
outputs_bulk_requests_errored_total{application="flowcoll",instance_name="default",namespace="default",output="opensearch"} 0
The outputs_bulk_requests_errored_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
outputs_records_errored_total
outputs_records_errored_total provides the total count of errored records.
outputs_records_errored_total{application="flowcoll",instance_name="default",namespace="default",output="opensearch",record_type="flow"} 1
The outputs_records_errored_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
Cribl Output
outputs_records_received_total
outputs_records_received_total provides the total count of records received by the output.
outputs_records_received_total{application="flowcoll",instance_name="default",namespace="default",output="cribl",record_type="flow"} 2
The outputs_records_received_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
outputs_records_sent_total
outputs_records_sent_total provides the total count of records sent by the output.
outputs_records_sent_total{application="flowcoll",instance_name="default",namespace="default",output="cribl",record_type="flow"} 2
The outputs_records_sent_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
outputs_bulk_requests_total
outputs_bulk_requests_total provides the total count of bulk requests sent by the output.
outputs_bulk_requests_total{application="flowcoll",instance_name="default",namespace="default",output="cribl"} 2
The outputs_bulk_requests_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
outputs_bulk_requests_errored_total
outputs_bulk_requests_errored_total provides the total count of errored bulk requests.
outputs_bulk_requests_errored_total{application="flowcoll",instance_name="default",namespace="default",output="cribl"} 0
The outputs_bulk_requests_errored_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
outputs_records_errored_total
outputs_records_errored_total provides the total count of errored records.
outputs_records_errored_total{application="flowcoll",instance_name="default",namespace="default",output="cribl",record_type="flow"} 1
The outputs_records_errored_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
Kafka Output
kafka_producer_messages_errored_total
kafka_producer_messages_errored_total provides the total count of errored messages.
kafka_producer_messages_errored_total{application="flowcoll",client_id="elastiflow-flowcoll",message_type="record",namespace="default",topic="elastiflow-flow-codex-1.0"} 0
The kafka_producer_messages_errored_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
topic | name of the kafka topic |
client_id | client ID of the Kafka producer |
message_type | type of message produced |
namespace | name of the namespace |
kafka_producer_messages_sent_total
kafka_producer_messages_sent_total provides the total count of messages produced by the output.
kafka_producer_messages_sent_total{application="flowcoll",client_id="elastiflow-flowcoll",message_type="record",namespace="default",topic="elastiflow-flow-codex-1.0"} 0
The kafka_producer_messages_sent_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
topic | name of the kafka topic |
client_id | client ID of the Kafka producer |
message_type | type of message produced |
namespace | name of the namespace |
Splunk Output
outputs_records_received_total
outputs_records_received_total provides the total count of records received by the output.
outputs_records_received_total{application="flowcoll",instance_name="default",namespace="default",output="splunk",record_type="flow"} 2
The outputs_records_received_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
outputs_records_sent_total
outputs_records_sent_total provides the total count of records sent by the output.
outputs_records_sent_total{application="flowcoll",instance_name="default",namespace="default",output="splunk",record_type="flow"} 2
The outputs_records_sent_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |
outputs_bulk_requests_total
outputs_bulk_requests_total provides the total count of bulk requests sent by the output.
outputs_bulk_requests_total{application="flowcoll",instance_name="default",namespace="default",output="splunk"} 2
The outputs_bulk_requests_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
outputs_bulk_requests_errored_total
outputs_bulk_requests_errored_total provides the total count of errored bulk requests.
outputs_bulk_requests_errored_total{application="flowcoll",instance_name="default",namespace="default",output="splunk"} 0
The outputs_bulk_requests_errored_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
outputs_records_errored_total
outputs_records_errored_total provides the total count of errored records.
outputs_records_errored_total{application="flowcoll",instance_name="default",namespace="default",output="splunk",record_type="flow"} 1
The outputs_records_errored_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
namespace | name of the namespace |
output | name of the output |
record_type | type of the data contained in the record |