StorageGrid Metrics

This document describes which StorageGRID metrics are collected and what those metrics are named in Harvest, including:

Details about which Harvest metrics each dashboard uses. These can be generated on demand by running bin/harvest grafana metrics. See #1577 for details.

Creation Date : 2025-Aug-02
StorageGrid Version: 11.6.0

Navigate to Grafana dashboards

Add your Grafana instance to the following form and save it. When you click on dashboard links on this page, a link to your dashboard will be opened. NAbox hosts Grafana on a subdomain like so: https://localhost/grafana/

Grafana Host

Understanding the structure¶

Below is an annotated example of how to interpret the structure of each of the metrics.

storagegrid_tenant_usage_data_bytes Name of the metric exported by Harvest

The logical size of all objects for the tenant. Description of the StorageGrid metric

API will be REST depending on which protocol is used to collect the metric
Endpoint name of the REST api used to collect this metric
Metric name of the StorageGrid metric
Template path of the template that collects the metric

API	Endpoint	Metric	Template
REST	`api/grid/accounts-cache`	dataBytes	conf/storagegrid/11.6.0/tenant.yaml

Metrics¶

storagegrid_ilm_awaiting_client_objects¶

Total number of objects on this node awaiting ILM evaluation because of client operation (for example, ingest)

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_ilm_awaiting_client_objects`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_ilm_awaiting_client_objects metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Information Lifecycle Management (ILM)	timeseries	ILM queue (Objects)

storagegrid_ilm_objects_processed¶

Objects processed by ILM that actually had work done

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_ilm_objects_processed`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_ilm_objects_processed metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Information Lifecycle Management (ILM)	timeseries	ILM evaluation rate (objects/second)

storagegrid_network_received_bytes¶

Total amount of data received

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_network_received_bytes`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_network_received_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Performance	timeseries	Network traffic

storagegrid_network_transmitted_bytes¶

Total amount of data sent

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_network_transmitted_bytes`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_network_transmitted_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Performance	timeseries	Network traffic

storagegrid_node_cpu_utilization_percentage¶

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_node_cpu_utilization_percentage`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_node_cpu_utilization_percentage metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Nodes	timeseries	Top $TopResources nodes by CPU usage

storagegrid_private_ilm_awaiting_delete_objects¶

The total number of objects on this node awaiting deletion

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_private_ilm_awaiting_delete_objects`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_private_ilm_awaiting_delete_objects metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Information Lifecycle Management (ILM)	timeseries	ILM queue (Objects)

storagegrid_private_load_balancer_storage_request_body_bytes_bucket¶

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_private_load_balancer_storage_request_body_bytes_bucket`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_private_load_balancer_storage_request_body_bytes_bucket metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Traffic Classification	heatmap	Write Request Rate by Object Size and Policy
StorageGrid: Overview	Traffic Classification	heatmap	Read Request Rate by Object Size and Policy

storagegrid_private_load_balancer_storage_request_count¶

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_private_load_balancer_storage_request_count`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_private_load_balancer_storage_request_count metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
ONTAP: StorageGrid FabricPool	Highlights	timeseries	Top $TopResources Load Balancer Request Completion Rates by Policy
StorageGrid: Overview	Performance	timeseries	Error rate (requests/second)
StorageGrid: Overview	Performance	timeseries	Average request duration (non-error)
StorageGrid: Overview	Traffic Classification	timeseries	Top $TopResources Load Balancer Request Completion Rates by Policy
StorageGrid: Overview	Traffic Classification	timeseries	Top $TopResources Error Response Rates by Policy
StorageGrid: Overview	Traffic Classification	timeseries	Top $TopResources Average Request Durations (Non-Error) By Policy

storagegrid_private_load_balancer_storage_request_time¶

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_private_load_balancer_storage_request_time`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_private_load_balancer_storage_request_time metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Performance	timeseries	Average request duration (non-error)
StorageGrid: Overview	Traffic Classification	timeseries	Top $TopResources Average Request Durations (Non-Error) By Policy

storagegrid_private_load_balancer_storage_rx_bytes¶

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_private_load_balancer_storage_rx_bytes`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_private_load_balancer_storage_rx_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
ONTAP: StorageGrid FabricPool	Highlights	timeseries	Top $TopResources Load Balancer Request Traffic by Policy
StorageGrid: Overview	Traffic Classification	timeseries	Top $TopResources Load Balancer Request Traffic by Policy

storagegrid_private_load_balancer_storage_tx_bytes¶

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_private_load_balancer_storage_tx_bytes`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_private_load_balancer_storage_tx_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
ONTAP: StorageGrid FabricPool	Highlights	timeseries	Top $TopResources Load Balancer Request Traffic by Policy
StorageGrid: Overview	Traffic Classification	timeseries	Top $TopResources Load Balancer Request Traffic by Policy

storagegrid_private_s3_total_requests¶

Number of S3 requests.

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_private_s3_total_requests`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_private_s3_total_requests metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Performance	timeseries	S3 operations

storagegrid_s3_operations_failed¶

The total number of failed S3 operations (HTTP status codes 4xx and 5xx), excluding those caused by S3 authorization failure

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_s3_operations_failed`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_s3_operations_failed metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Performance	timeseries	S3 API requests

storagegrid_s3_operations_successful¶

The total number of successful S3 operations (HTTP status code 2xx)

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_s3_operations_successful`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_s3_operations_successful metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Performance	timeseries	S3 API requests

storagegrid_s3_operations_unauthorized¶

The total number of failed S3 operations that are the result of an authorization failure (HTTP status codes 4xx)

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_s3_operations_unauthorized`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_s3_operations_unauthorized metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Performance	timeseries	S3 API requests

storagegrid_storage_utilization_data_bytes¶

An estimate of the total size of replicated and erasure coded object data on the Storage Node

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_storage_utilization_data_bytes`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_storage_utilization_data_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Highlights	table	Data space usage breakdown
StorageGrid: Overview	Highlights	timeseries	Data storage over time
StorageGrid: Overview	Nodes	timeseries	Top $TopResources nodes by data usage

storagegrid_storage_utilization_metadata_allowed_bytes¶

The total space available on storage volume 0 for object metadata

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_storage_utilization_metadata_allowed_bytes`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_storage_utilization_metadata_allowed_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Highlights	table	Metadata allowed space usage breakdown

storagegrid_storage_utilization_metadata_bytes¶

The amount of object metadata on storage volume 0, in bytes

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_storage_utilization_metadata_bytes`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_storage_utilization_metadata_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Highlights	table	Metadata allowed space usage breakdown

storagegrid_storage_utilization_usable_space_bytes¶

The total amount of object storage space remaining

API	Endpoint	Metric	Template
REST	`prometheus`	`storagegrid_storage_utilization_usable_space_bytes`	conf/storagegrid/11.6.0/storagegrid_metrics.yaml

The storagegrid_storage_utilization_usable_space_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Highlights	table	Data space usage breakdown
StorageGrid: Overview	Nodes	timeseries	Top $TopResources nodes by data usage

storagegrid_tenant_usage_data_bytes¶

The logical size of all objects for the tenant

API	Endpoint	Metric	Template
REST	`grid/accounts-cache`	`dataBytes`	conf/storagegrid/11.6.0/tenant.yaml

The storagegrid_tenant_usage_data_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Storage	timeseries	Top $TopResources tenants by logical space used
StorageGrid: Overview	Storage	timeseries	Top $TopResources tenants by quota usage

storagegrid_tenant_usage_quota_bytes¶

The maximum amount of logical space available for the tenant's object. If a quota metric is not provided, an unlimited amount of space is available

API	Endpoint	Metric	Template
REST	`grid/accounts-cache`	`policy.quotaObjectBytes`	conf/storagegrid/11.6.0/tenant.yaml

The storagegrid_tenant_usage_quota_bytes metric is visualized in the following Grafana dashboards:

Dashboard	Row	Type	Panel
StorageGrid: Overview	Storage	timeseries	Top $TopResources tenants by quota usage