Skip to main content
Version: 7.3

Metrics

NetObserv SNMP 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.

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:

app_info{arch="arm64",cpus="8",env="native",hostname="M1-MacBook-Pro.local",os="darwin",run_id="b1214e11-198f-43e7-81f1-c9986e9b3ff7"} 1

The app_info data provides the following labels:

LabelDescription
archenvironment running application
cpusnumber of cpus available
envnative install or Docker
hostnamename of machine
instance_namename of the collector instance
osoperating system running application
run_idrun id of application

license_units

license_units provides license details. The following is an example of a license_units record:

license_units{account_id="",expiration="0",level="0"} 1

The license_units record provides the following labels:

LabelDescription
account_idaccount id of license.
expirationlicense expiration date.
instance_namename of the collector instance
levellicense level.

Polling

The following metrics are provided by the device poller.

snmp_input_poll_total

snmp_input_poll_total provides the total count of device polls.

snmp_input_poll_total{application="snmpcoll",instance_name="default",poll_type="get"} 1

The snmp_input_poll_total record provides the following labels:

LabelDescription
applicationname of the application.
instance_namename of the collector instance
poll_typeSNMP poll operation type

snmp_input_poll_err_total

snmp_input_poll_err_total provides the total count of device poll errors.

snmp_input_poll_err_total{application="snmpcoll",instance_name="default",err="GenErr"} 1

The snmp_input_poll_err_total record provides the following labels:

LabelDescription
applicationname of the application.
instance_namename of the collector instance
errSNMP poll error

snmp_input_devices_scheduled_total

snmp_input_devices_scheduled_total provides the total count of devices that are currently scheduled to be polled.

snmp_input_devices_scheduled_total{application="snmpcoll",instance_name="default"} 1

The snmp_input_devices_scheduled_total record provides the following labels:

LabelDescription
applicationname of the application.
instance_namename of the collector instance

snmp_input_objects_scheduled_total

snmp_input_objects_scheduled_total provides the total count of objects that are currently scheduled to be polled.

snmp_input_objects_scheduled_total{application="snmpcoll",instance_name="default"} 2

The snmp_input_objects_scheduled_total record provides the following labels:

LabelDescription
applicationname of the application.
instance_namename of the collector instance

Processing

The following metrics are provided by the record processor.

snmp_processor_records_total

snmp_processor_records_total provides the total count of records processed.

snmp_processor_records_total{application="snmpcoll",instance_name="default"} 2

The snmp_processor_records_total record provides the following labels:

LabelDescription
applicationname of the application.
instance_namename of the collector instance

snmp_processor_records_err_total

snmp_processor_records_err_total provides the total count of records that errored during processing.

snmp_processor_records_err_total{application="snmpcoll",instance_name="default"} 0

The snmp_processor_records_err_total record provides the following labels:

LabelDescription
applicationname of the application.
instance_namename of the collector instance

snmp_processor_record_queue_util

snmp_processor_record_queue_util provides the record queue size to capacity ratio (queue utilization).

snmp_processor_record_queue_util{application="snmpcoll",instance_name="default"} 0

The snmp_processor_record_queue_util record provides the following labels:

LabelDescription
applicationname of the application.
instance_namename of the collector instance