Metric exporters

SaunaFS Operator exposes a variety of Prometheus metrics that provide detailed insights into filesystem operations and resource usage. These metrics include performance indicators such as I/O throughput and latency, state information about the health and availability of filesystem components, and resource consumption metrics like memory usage. Together, these metrics enable comprehensive monitoring and alerting to ensure the reliability and efficiency of SaunaFS deployments. All metrics are exported via Prometheus exporters for seamless integration with standard observability tools.

SaunaFS Metrics

Labels

Metrics reported by exporters deployed via SaunaFS Operator use following labels:

Label	Description
`cluster_namespace`	SaunaFS Cluster's namespace. Set for all metrics related to SaunaFS Components.
`cluster_name`	SaunaFS Cluster's name. Set for all metrics related to SaunaFS Components.
`volume_name`	SaunaFS Chunk/Metadata volume name. Set for all Chunk/Metadata volume metrics.
`volume_evicting`	Whether SaunaFS Chunk volume is marked for eviction (removal). Set for SaunaFS Chunk Volume metrics.
`volume_damaged`	Whether SaunaFS Chunk volume is damaged. Set for SaunaFS Chunk Volume metrics.

Metrics

SaunaFS Cluster

Following metrics are exported by SaunaFS Operator for each SaunaFS Cluster:

Metric	Description
`saunafs_operator_cluster_reconciliation_timings`	Histogram of reconciliation timings for a given cluster in seconds.
`saunafs_operator_cluster_metadataservers_expected`	Count of expected deployed Metadata Servers.
`saunafs_operator_cluster_metadataservers_current`	Count of currently deployed Metadata Servers.
`saunafs_operator_cluster_chunkservers_expected`	Count of expected deployed Chunk Servers.
`saunafs_operator_cluster_chunkservers_current`	Count of currently deployed Chunk Servers.

SaunaFS Metadata Volume

Following metrics are exported by Metadata Server Metrics Exporter for it's SaunaFS Metadata Volume:

Metric	Description
`saunafs_metadata_volume_metadata_version`	Version of metadata stored on the volume.
`saunafs_metadata_volume_status`	Status of the server running with the volume. Values: 1 = Master; 2 = Connected Shadow; 3 = Disconnected Shadow.

Following metrics are exported by Metadata Server Metrics Exporter for it's SaunaFS Metadata Volume when corresponding metadata server is a leader:

Metric	Description
`saunafs_cluster_memory_usage_bytes`	Memory usage.
`saunafs_cluster_space_total_bytes`	Total space in the cluster.
`saunafs_cluster_space_available_bytes`	Available space in the cluster.
`saunafs_cluster_space_trash_bytes`	Space in the cluster used by trash.
`saunafs_cluster_space_reserved_bytes`	Reserved space in the cluster.
`saunafs_cluster_filesystem_objects_total`	Count of filesystem objects in the cluster.
`saunafs_cluster_files_total`	Count of files in the cluster.
`saunafs_cluster_files_reserved_total`	Count of reserved files in the cluster.
`saunafs_cluster_files_trash_total`	Count of trashed files in the cluster.
`saunafs_cluster_dirs_total`	Count of directories in the cluster.
`saunafs_cluster_chunks_total`	Count of chunks in the cluster.
`saunafs_cluster_chunks_copies`	Count of chunk copies in the cluster.
`saunafs_cluster_chunks_safe_total`	Count of safe chunks in the cluster.
`saunafs_cluster_chunks_endangered_total`	Count of endangered chunks in the cluster.
`saunafs_cluster_chunks_lost_total`	Count of lost chunks in the cluster.

SaunaFS Chunk Volume

Following metrics are exported by Chunk Server Metrics Exporter for it's SaunaFS Chunk Volumes:

Metric	Description
`saunafs_chunk_volume_chunks_total`	Count of chunks stored on the volume.
`saunafs_chunk_volume_read_bytes`	Bytes read in the last minute. Note that this value is re-calculated only once every minute.
`saunafs_chunk_volume_written_bytes`	Bytes written in the last minute. Note that this value is re-calculated only once every minute.
`saunafs_chunk_volume_read_bytes_per_second`	Bytes read per second (when reading) in the last minute. Note that this value is re-calculated only once every minute.
`saunafs_chunk_volume_written_bytes_per_second`	Bytes written per second (when writing) in the last minute. Note that this value is re-calculated only once every minute.
`saunafs_chunk_volume_operations_read_total`	Count of read operations in the last minute. Note that this value is re-calculated only once every minute.
`saunafs_chunk_volume_operations_write_total`	Count of write operations in the last minute. Note that this value is re-calculated only once every minute.
`saunafs_chunk_volume_space_used_bytes`	Used space on the volume.
`saunafs_chunk_volume_space_total_bytes`	Total space on the volume.

Elector Metrics

Elector exports following metrics:

Metric	Description
`saunafs_elector_term`	Incrementing number used to coordinate leader elections and maintain consistency among distributed nodes.
`saunafs_elector_metadata_version`	SaunaFS metadata version observed by elector. Is updated only on election.
`saunafs_elector_role`	Current elector role. 0 for follower, 1 for candidate, 2 for leader, 3 for custodian.