This section lists the names, types, labels, and descriptions for the metrics that Qumulo Core 5.3.0 (ans higher) emits in OpenMetrics API format.

The Qumulo OpenMetrics API has a single endpoint that provides a complete view of point-in-time telemetry from Qumulo Core to monitoring systems. These systems, such as Prometheus, can consume the OpenMetrics data format that the Qumulo REST API emits without custom code or a monitoring agent. For more information about data formats, see your monitoring system’s documentation.

Accessing Qumulo Metrics

Qumulo metrics are available at the following endpoint.

https://<my-cluster-hostname>:8000/v2/metrics/endpoints/default/data

You can configure a monitoring system that supports the OpenMetrics Specification to use bearer token authentication to access this endpoint.

Metric Types

All Qumulo metrics belong to one of the following OpenMetrics types.

Metric Type Description
counter An integer that increases monotonically from zero, stored in <metric_name>_count.
gauge A value that represents a single integer (similar to counter), stored in <metric_name>.
histogram

A representation of a series of buckets, where each bucket tracks values within a specific range.

A histogram has a count field and a sum field, stored in <metric_name>_count (the total number of samples) and <metric_name>_sum (the sum of all samples). Qumulo Core emits a single bucket that contains all samples.

info Informational text about the system, stored in <metric_name>_info. An info metric always has a value of 1 and labels that contain detailed information.

For more information, see Metric Types in the OpenMetrics Specification.

Metric Labels

The OpenMetrics format allows for metric labeling for communicating additional information. To provide context for metrics, Qumulo Core emits metric-specific labels. For example, the name of a protocol operation or the url of a remote server. For more information, see Available Labels.

Available Metrics

The following table lists metric names, types, labels, and descriptions.

Metric Name Metric Type Labels Description
qumulo info
  • name
  • uuid
  • version
Qumulo Core information, including the cluster name, cluster UUID, and the current Qumulo Core version
qumulo_ad_netlogon_request_errors counter The total number Active Directory (AD) NETLOGON requests that resulted in an error
qumulo_ad_netlogon_request_latency_seconds histogram The total latency for AD NETLOGON requests
qumulo_ad_netlogon_requests counter The total number of completed AD NETLOGON operations
qumulo_cpu_max_temperature_celsius gauge The maximum temperature threshold for each physical CPU
qumulo_disk_endurance_percent gauge The remaining disk endurance value for each disk in the cluster, ranging 100 (no disk wear) to 0 (disk is worn fully)
qumulo_disk_transport_errors counter The total number of communication errors between the specified drive and its host.
qumulo_disk_uncorrectable_media_errors counter The total number of uncorrectable errors on the specified drive's physical media.
qumulo_cpu_temperature_celsius gauge The temperature for each physical CPU, in degrees Celsius
qumulo_disk_is_unhealthy gauge The health of each disk in the cluster, ranging from 0 (the disk is healthy) to 1 (the disk is unhealthy)
qumulo_disk_operation_latency_seconds histogram The total latency for disk I/O operations
qumulo_fan_speed_rpm gauge The fan speed, in RPM
qumulo_fs_capacity_bytes gauge The total cluster space, in bytes
qumulo_fs_directory_tree_entries gauge The number of file system objects on the cluster, sorted by object type
qumulo_fs_directory_used_bytes gauge The amount of space that object types use, in bytes
qumulo_fs_free_bytes gauge The free space on the cluster, in bytes
qumulo_fs_snapshots gauge The number of snapshots on the cluster
qumulo_ldap_lookup_request_errors counter The total number of LDAP requests that resulted in an error
qumulo_ldap_lookup_request_latency_seconds histogram The total latency of LDAP requests
qumulo_ldap_lookup_requests counter The total number of completed LDAP requests
qumulo_ldap_operation_errors counter The total number of LDAP operations that resulted in an error
qumulo_ldap_operation_latency_seconds histogram The total latency for LDAP operations
qumulo_ldap_operations counter The total number of completed LDAP operations
qumulo_memory_correctable_ecc_errors counter The total number of memory errors that Qumulo Core corrected automatically
qumulo_network_interface_is_down gauge The interface status, 0 (interface is up) or 1 (interface is down)
qumulo_network_interface_link_speed_bits_per_second gauge The negotiated link speed for the specified interface
qumulo_network_interface_receive_errors counter The total number of receive errors on the specified interface
qumulo_network_interface_received_bytes counter The total bytes received on the specified interface
qumulo_network_interface_received_packets counter The total number of packets received on the specified interface
qumulo_network_interface_transmit_errors counter The total number of transmission errors on the specified interface
qumulo_network_interface_transmitted_bytes counter The total number of bytes transmitted on the specified interface
qumulo_network_interface_transmitted_packets counter The total number of packets transmitted on the specified interface
qumulo_power_supply_is_unhealthy gauge PSU health, 0 (healthy) or 1 (unplugged, removed, or unresponsive)
qumulo_protocol_client_connections counter The total number of clients that have connected to the specified protocol
qumulo_protocol_client_disconnections counter The total number of clients that have disconnected from the specified protocol
qumulo_protocol_operation_bytes counter The total bytes that protocol operations have transferred
qumulo_protocol_operation_latency_seconds histogram The total latency for protocol operations
qumulo_protocol_operations counter The total number of completed protocol operations
qumulo_quorum_node_is_offline gauge The online status for each node in the cluster, 0 (node online) or 1 (node offline)
qumulo_time_is_not_synchronizing gauge The time synchronization status for each node in the cluster, 0 (time is synchronized) or 1 (time isn't synchronized)

Available Labels

The following table lists metric label names, possible values, and descriptions.

Label Name Possible Values Description
bond
  • bond0
  • bond1
The bond to which a network interface belongs
cpu A non-negative integer The CPU index in the node
data_type
  • data: Read or write operations on the data of a file.
  • metadata: Operations (such as lookup, stat, or getattr) unrelated to a file's data
  • none: Operations that operate on neither the file data nor the metadata.
The data type that an operation transfers
disk_type
  • hdd: Hard Disk Drive
  • ssd: Solid-State Drive
The underlying storage type
drive_bay A drive bay name. For example: b3, 1.1 The physical drive bay in the chassis.
entry_type
  • alternate_data_stream
  • directory
  • file
  • other
  • symlink
The file system object type
fan A fan name, for example system fan 1 The fan name
interface An interface name, for example eth0 The interface name
io_type
  • none
  • read
  • wait: A blocking operation that takes an indeterminate amount of time
  • write
The I/O that an operation performs
location A location on the chassis, for example left or right The location on the chassis.
node_id A positive integer that represents a node ID in the cluster. A value that differentiates between the different nodes in a cluster
op_name Any operation name, including NFSv3, NFSv4.1, SMBv2, SMBv3 or FTP The recorded operation
path Slash (/) The path to a directory in the file system
protocol
  • nfs: NFSv3 or NFSv4.1
  • smb2: SMBv2 or SMBv3
  • ftp
The protocol of the recorded operation
role
  • frontend
  • backend
The role of the interface
server_url A hostname (for example, ad.my-domain.com) or an IP address The URL of a remote server
usage_type
  • data
  • metadata
  • snapshot
The data type that uses space