Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

Metrics

The Apstra Flow collector 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. See the Prometheus documentation to learn more.

This topic describes the type of statistics you can retrieve from the /metrics endpoint in Apstra Flow.

app_info

The app_info statistic shows the application details. For example: This record contains the following labels:
Table 1: Application Labels
Label Description
arch The environment running the application.
cpus The number of available CPUs.
env Native install or Docker install.
hostname The name of machine.
os The operating system running the application.
run_id The application ID.

License Units

The license_units statistic shows details on your Apstra license. For example:

This record contains the following labels:

Table 2: License Units Labels
Label Description
account_id The license account ID.
expiration The license expiration date.
level The license level.
riskiq_disabled riskiq is disabled for the license.

Flow UDP Server

The following statistics show the options for UDP server input.

udp_server_packet_queue_util

The udp_server_packet_queue_util statistic shows the utilization of the packet queue that stores received packets waiting to be processed. For example:

This record contains the following label:

Table 3: udp_server_packet_queue_util Label
Label Description
application The name of the application.

udp_server_packets_received_total

The udp_server_packets_received_total statistic shows the total count of packets received by the UDP server. For example:

This record contains the following labels:

Table 4: udp_server_packets_received_total Labels
Label Description
application The name of the application.
port The port on which the UDP server listens.

udp_server_bytes_received_total

The udp_server_bytes_received_total statistic provides the total count of bytes received by the UDP server.

This record contains the following labels:

Table 5: udp_server_bytes_received_total Labels
Label Description
application Name of the application.
port Port on which the UDP server listens.

Processor

record_queue_util

The record_queue_util statistic shows the ratio of the record queue size divided by its capacity. For example:

This record contains the following label:

Table 6: record_queue_util Label
Label Description
application The name of the application.

OpenSearch Output

outputs_records_received_total

The outputs_records_received_total statistic shows the total number of records received by the output. For example:

This record contains the following labels:

Table 7: outputs_records_received_total Labels
Label Description
application The name of the application.
namespace The name of the namespace.
output The name of the output.

outputs_records_sent_total

The outputs_records_sent_total statistic shows the total number of records sent by the output. For example:

This record contains the following labels:

Table 8: outputs_records_sent_total Labels
Label Description
application The name of the application.
namespace The name of the namespace.
output The name of the output.

outputs_bulk_requests_total

The outputs_bulk_requests_total statistic shows the total count of bulk requests sent by the output. For example:

This record contains the following labels:

Table 9: outputs_bulk_request_total Labels
Label Description
application The name of the application.
namespace The name of the namespace.
output The name of the output.

outputs_bulk_requests_errored_total

The outputs_bulk_requests_errored_total statistic shows the total count of errored bulk requests. For example:

This record contains the following labels:

Table 10: outputs_bulk_request_errored_total Labels
Label Description
application The name of the application.
namespace The name of the namespace.
output The name of the output.

outputs_records_errored_total

The outputs_records_errored_total statistic shows the total count of errored records. For example:

This record contains the following labels:

Table 11: outputs_records_errored_total Labels
Label Description
application The name of the application.
namespace The name of the namespace.
output The name of the output.