This section lists the names, types, labels, and descriptions for the metrics that Qumulo Core 5.3.0 (and 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 Suppor­ted from Qumulo Core Version Description
qumulo info
  • cluster_type
  • name
  • platform
  • service_model
  • uuid
  • version
5.3.0 Qumulo Core information, including the cluster name, cluster UUID, and the current Qumulo Core version.
qumulo_ad_netlogon_request
_errors		 counter 5.3.0 The total number of Active Directory (AD) NETLOGON requests that resulted in an error
qumulo_ad_netlogon_request
_latency_seconds		 histogram 5.3.0 The total latency for AD NETLOGON requests
qumulo_ad_netlogon_requests counter 5.3.0 The total number of completed AD NETLOGON operations
qumulo_fault_tolerance_metrics_current_remaining_disk_failures gauge — 7.5.2 The current number of disk failures that the cluster can tolerate.
qumulo_fault_tolerance_metrics_current_remaining_fault_domain_failures gauge — 7.5.2 The current number of fault domain failures that the cluster can tolerate.
qumulo_fault_tolerance_metrics_current_remaining_node_failures gauge — 7.5.2 The current number of node failures that the cluster can tolerate.
qumulo_fs_capacity_bytes gauge — 5.3.0 The total cluster space, in bytes
qumulo_fs_directory
_tree_entries		 gauge 5.3.0 The number of file system objects on the cluster, sorted by object type
qumulo_fs_directory
_used_bytes		 gauge 5.3.0 The amount of space that object types use, in bytes
qumulo_fs_free_bytes gauge — 5.3.0 The free space on the cluster, in bytes
qumulo_fs_portal_count gauge 7.4.2.1 The number of portals for each state, not including portals in Pending and Unlinked states
qumulo_fs_portal_root_shared_bytes gauge 7.5.3 The amount of data that a hub portal root directory shares with the cluster in a portal relationship with the current cluster.
qumulo_fs_snapshots gauge — 5.3.0 The number of snapshots on the cluster
qumulo_fs_used_bytes gauge 7.4.2.1 The amount of space that a file system uses, in bytes
qumulo_ldap_lookup
_request_errors		 counter 5.3.0 The total number of LDAP requests that resulted in an error
qumulo_ldap_lookup
_request_latency_seconds		 histogram 5.3.0 The total latency of LDAP requests
qumulo_ldap_lookup
_requests		 counter 5.3.0 The total number of completed LDAP requests
qumulo_ldap_operation
_errors		 counter domain_url 5.3.0 The total number of LDAP operations that resulted in an error
qumulo_ldap_operation
_latency_seconds		 histogram domain_url 5.3.0 The total latency for LDAP operations
qumulo_ldap_operations counter domain_url 5.3.0 The total number of completed LDAP operations
qumulo_protocol_client
_connections		 counter protocol 5.3.0 The total number of clients that have connected to the specified protocol
qumulo_protocol_client
_disconnections		 counter protocol 5.3.0 The total number of clients that have disconnected from the specified protocol
qumulo_protocol_operation
_bytes		 counter 5.3.0 The total bytes that protocol operations have transferred
qumulo_protocol_operation
_latency_seconds		 histogram 5.3.0 The total latency for protocol operations
qumulo_protocol_operations counter 5.3.0 The total number of completed protocol operations

Available Labels

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

Label Name Possible Values Description
cluster_type
  • protected_cluster
  • unprotected_edge
 The type of cluster
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 apply to neither the file data nor the metadata.
The data type that an operation transfers
domain_url An Active Directory domain (for example, my-domain.com) or an LDAP bind URI (for example, ldap://my-server.my-domain.com) The URL of the domain
entry_type
  • alternate_data_stream
  • directory
  • file
  • other
  • symlink
 The file system object type
fs_type
  • local: The portion of the file system used for persistent data, including data in hub portal root directories
  • spoke: The portion of the file system used for cached data on spoke portals
 File system type
fs_uuid A UUID that identifies a local file system. File system ID
hardware_detection_mode
  • chassis: Uses a predefined, static hardware layout (chassis files) for component identification
  • run_anywhere: Detects available hardware components automatically and adapts behavior dynamically
 The method for detecting and managing hardware
io_type
  • composite
  • none
  • read
  • wait: A blocking operation that takes an indeterminate amount of time
  • write
 The I/O that an operation performs
network_management_mode
  • host_managed: Network interfaces managed by the host system
  • qumulo_managed: Network interfaces managed by Qumulo Core
 The management mode for network interfaces
op_name Any operation name, including NFSv3, NFSv4.1, SMBv2, SMBv3, REST, S3, replication, or FTP The recorded operation
path Slash (/) The path to a directory in the file system
portal_state
  • authorized: A portal, ready for file system access, for which both clusters approved a portal relationship
  • deleting: A portal in process of synchronizing outstanding changes before being deleted
 The state of a spoke portal or a hub portal
portal_peer A version 4 UUID The UUID of the cluster in a portal relationship with the current cluster.
portal_root A QFSD API file ID string The file ID of the hub portal root directory.
portal_type
  • hub: Hub portal
  • spoke: Spoke portal
 The portal type
protocol
  • nfs: NFSv3 or NFSv4.1
  • smb: SMBv2 or SMBv3
  • rest
  • s3
  • replication
  • ftp
 The protocol of the recorded operation
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