Metrics
NetObserv Flow exposes 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 |
|---|---|
account_id | account id of license |
application | name of the application |
expiration | license expiration date (unix time) |
instance_name | name of the collector instance |
level | license level |
license_flow_records_per_second
license_flow_records_per_second provides the maximum flow records per second that the collector is provisioned for according to the license and configurations. The following is an example of a license_flow_records_per_second record:
license_flow_records_per_second{application="snmpcoll",instance_name="default"} 4000
The license_flow_records_per_second record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
instance_name | name of the collector instance |
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.
udp_server_packet_queue_util{application="flowcoll"} 0
The udp_server_packet_queue_util record provides the following labels:
| Label | Description |
|---|---|
application | 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.
udp_server_packets_received_total{application="flowcoll",port="9995"} 0
The udp_server_packets_received_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
port | 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.
udp_server_bytes_received_total{application="flowcoll",port="9995"} 0
The udp_server_bytes_received_total record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |
port | port on which the UDP server listens |
Processor
record_queue_util
Ratio of the record queue size divided by its capacity.
record_queue_util{application="flowcoll"} 0
The record_queue_util record provides the following labels:
| Label | Description |
|---|---|
application | name of the application |