github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/docs/metrics/prometheus/list.md (about)

     1  # Cluster Metrics
     2  
     3  MinIO collects the following metrics at the cluster level.
     4  Metrics may include one or more labels, such as the server that calculated that metric.
     5  
     6  These metrics can be obtained from any MinIO server once per collection by using the following URL:
     7  
     8  ```shell
     9  https://HOSTNAME:PORT/minio/v2/metrics/cluster
    10  ```
    11  
    12  Replace ``HOSTNAME:PORT`` with the hostname of your MinIO deployment.
    13  For deployments behind a load balancer, use the load balancer hostname instead of a single node hostname.
    14  
    15  ## Audit Metrics
    16  
    17  | Name                              | Description                                               |
    18  |:----------------------------------|:----------------------------------------------------------|
    19  | `minio_audit_failed_messages`     | Total number of messages that failed to send since start. |
    20  | `minio_audit_target_queue_length` | Number of unsent messages in queue for target.            |
    21  | `minio_audit_total_messages`      | Total number of messages sent since start.                |
    22  
    23  ## Cluster Capacity Metrics
    24  
    25  | Name                                         | Description                                                    |
    26  |:---------------------------------------------|:---------------------------------------------------------------|
    27  | `minio_cluster_capacity_raw_free_bytes`      | Total free capacity online in the cluster.                     |
    28  | `minio_cluster_capacity_raw_total_bytes`     | Total capacity online in the cluster.                          |
    29  | `minio_cluster_capacity_usable_free_bytes`   | Total free usable capacity online in the cluster.              |
    30  | `minio_cluster_capacity_usable_total_bytes`  | Total usable capacity online in the cluster.                   |
    31  | `minio_cluster_objects_size_distribution`    | Distribution of object sizes across a cluster                  |
    32  | `minio_cluster_objects_version_distribution` | Distribution of object versions across a cluster               |
    33  | `minio_cluster_usage_object_total`           | Total number of objects in a cluster                           |
    34  | `minio_cluster_usage_total_bytes`            | Total cluster usage in bytes                                   |
    35  | `minio_cluster_usage_version_total`          | Total number of versions (includes delete marker) in a cluster |
    36  | `minio_cluster_usage_deletemarker_total`     | Total number of delete markers in a cluster                    |
    37  | `minio_cluster_usage_total_bytes`            | Total cluster usage in bytes                                   |
    38  | `minio_cluster_bucket_total`                 | Total number of buckets in the cluster                         |
    39  
    40  ## Cluster Drive Metrics
    41  
    42  | Name                                | Description                           |
    43  |:------------------------------------|:--------------------------------------|
    44  | `minio_cluster_drive_offline_total` | Total drives offline in this cluster. |
    45  | `minio_cluster_drive_online_total`  | Total drives online in this cluster.  |
    46  | `minio_cluster_drive_total`         | Total drives in this cluster.         |
    47  
    48  ## Cluster ILM Metrics
    49  
    50  | Name                                      | Description                                      |
    51  |:------------------------------------------|:-------------------------------------------------|
    52  | `minio_cluster_ilm_transitioned_bytes`    | Total bytes transitioned to a tier.              |
    53  | `minio_cluster_ilm_transitioned_objects`  | Total number of objects transitioned to a tier.  |
    54  | `minio_cluster_ilm_transitioned_versions` | Total number of versions transitioned to a tier. |
    55  
    56  ## Cluster KMS Metrics
    57  
    58  | Name                                | Description                                                                              |
    59  |:------------------------------------|:-----------------------------------------------------------------------------------------|
    60  | `minio_cluster_kms_online`          | Reports whether the KMS is online (1) or offline (0).                                    |
    61  | `minio_cluster_kms_request_error`   | Number of KMS requests that failed due to some error. (HTTP 4xx status code).            |
    62  | `minio_cluster_kms_request_failure` | Number of KMS requests that failed due to some internal failure. (HTTP 5xx status code). |
    63  | `minio_cluster_kms_request_success` | Number of KMS requests that succeeded.                                                   |
    64  | `minio_cluster_kms_uptime`          | The time the KMS has been up and running in seconds.                                     |
    65  
    66  ## Cluster Health Metrics
    67  
    68  | Name                                              | Description                                    |
    69  |:--------------------------------------------------|:-----------------------------------------------|
    70  | `minio_cluster_nodes_offline_total`               | Total number of MinIO nodes offline.           |
    71  | `minio_cluster_nodes_online_total`                | Total number of MinIO nodes online.            |
    72  | `minio_cluster_write_quorum`                      | Maximum write quorum across all pools and sets |
    73  | `minio_cluster_health_status`                     | Get current cluster health status              |
    74  | `minio_cluster_health_erasure_set_healing_drives` | Count of healing drives in the erasure set     |
    75  | `minio_cluster_health_erasure_set_online_drives`  | Count of online drives in the erasure set      |
    76  | `minio_cluster_health_erasure_set_read_quorum`    | Get read quorum of the erasure set             |
    77  | `minio_cluster_health_erasure_set_write_quorum`   | Get write quorum of the erasure set            |
    78  | `minio_cluster_health_erasure_set_status`         | Get current health status of the erasure set   |
    79  
    80  ## Cluster Replication Metrics
    81  
    82  Metrics marked as ``Site Replication Only`` only populate on deployments with [Site Replication](https://min.io/docs/minio/linux/operations/install-deploy-manage/multi-site-replication.html) configurations.
    83  For deployments with [bucket](https://min.io/docs/minio/linux/administration/bucket-replication.html) or [batch](https://min.io/docs/minio/linux/administration/batch-framework.html#replicate) configurations, these metrics populate instead under the [Bucket Metrics](#bucket-metrics) endpoint.
    84  
    85  | Name                                                       | Description                                                                                             
    86  |:-----------------------------------------------------------|:---------------------------------------------------------------------------------------------------------|
    87  | `minio_cluster_replication_last_hour_failed_bytes`         | (_Site Replication Only_) Total number of bytes failed at least once to replicate in the last full hour. |
    88  | `minio_cluster_replication_last_hour_failed_count`         | (_Site Replication Only_) Total number of objects which failed replication in the last full hour.        |
    89  | `minio_cluster_replication_last_minute_failed_bytes`       | Total number of bytes failed at least once to replicate in the last full minute.                         |
    90  | `minio_cluster_replication_last_minute_failed_count`       | Total number of objects which failed replication in the last full minute.                                |
    91  | `minio_cluster_replication_total_failed_bytes`             | (_Site Replication Only_) Total number of bytes failed at least once to replicate since server start.    |
    92  | `minio_cluster_replication_total_failed_count`             | (_Site Replication Only_) Total number of objects which failed replication since server start.           |
    93  | `minio_cluster_replication_received_bytes`                 | (_Site Replication Only_) Total number of bytes replicated to this cluster from another source cluster.  |
    94  | `minio_cluster_replication_received_count`                 | (_Site Replication Only_) Total number of objects received by this cluster from another source cluster.  |
    95  | `minio_cluster_replication_sent_bytes`                     | (_Site Replication Only_) Total number of bytes replicated to the target cluster.                        |
    96  | `minio_cluster_replication_sent_count`                     | (_Site Replication Only_) Total number of objects replicated to the target cluster.                      |
    97  | `minio_cluster_replication_credential_errors`              | (_Site Replication Only_) Total number of replication credential errors since server start               |
    98  | `minio_cluster_replication_proxied_get_requests_total` | (_Site Replication Only_)Number of GET requests proxied to replication target                          |
    99  | `minio_cluster_replication_proxied_head_requests_total` | (_Site Replication Only_)Number of HEAD requests proxied to replication target                          |
   100  | `minio_cluster_replication_proxied_delete_tagging_requests_total` | (_Site Replication Only_)Number of DELETE tagging requests proxied to replication target                          |
   101  | `minio_cluster_replication_proxied_get_tagging_requests_total` | (_Site Replication Only_)Number of GET tagging requests proxied to replication target                          |
   102  | `minio_cluster_replication_proxied_put_tagging_requests_total` | (_Site Replication Only_)Number of PUT tagging requests proxied to replication target                          |
   103  | `minio_cluster_replication_proxied_get_requests_failures` | (_Site Replication Only_)Number of failures in GET requests proxied to replication target                          |
   104  | `minio_cluster_replication_proxied_head_requests_failures` | (_Site Replication Only_)Number of failures in HEAD requests proxied to replication target                          |
   105  | `minio_cluster_replication_proxied_delete_tagging_requests_failures` | (_Site Replication Only_)Number of failures proxying DELETE tagging requests to replication target                          |
   106  | `minio_cluster_replication_proxied_get_tagging_requests_failures` | (_Site Replication Only_)Number of failures proxying GET tagging requests to replication target                          |
   107  | `minio_cluster_replication_proxied_put_tagging_requests_failures` | (_Site Replication Only_)Number of failures proxying PUT tagging requests to replication target                          |
   108  
   109  
   110  ## Node Replication Metrics
   111  
   112  Metrics marked as ``Site Replication Only`` only populate on deployments with [Site Replication](https://min.io/docs/minio/linux/operations/install-deploy-manage/multi-site-replication.html) configurations.
   113  For deployments with [bucket](https://min.io/docs/minio/linux/administration/bucket-replication.html) or [batch](https://min.io/docs/minio/linux/administration/batch-framework.html#replicate) configurations, these metrics populate instead under the [Bucket Metrics](#bucket-metrics) endpoint.
   114  
   115  | Name                                                       | Description
   116  |:-----------------------------------------------------------|:---------------------------------------------------------------------------------------------------------|
   117  | `minio_cluster_replication_current_active_workers`         | Total number of active replication workers                                                               |
   118  | `minio_cluster_replication_average_active_workers`         | Average number of active replication workers                                                             |
   119  | `minio_cluster_replication_max_active_workers`             | Maximum number of active replication workers seen since server start                                     |
   120  | `minio_cluster_replication_link_online`                    | Reports whether the replication link is online (1) or offline (0).                                       |
   121  | `minio_cluster_replication_link_offline_duration_seconds`  | Total duration of replication link being offline in seconds since last offline event                     |
   122  | `minio_cluster_replication_link_downtime_duration_seconds` | Total downtime of replication link in seconds since server start                                         |
   123  | `minio_cluster_replication_average_link_latency_ms`        | Average replication link latency in milliseconds                                                         |
   124  | `minio_cluster_replication_max_link_latency_ms`            | Maximum replication link latency in milliseconds seen since server start                                 |
   125  | `minio_cluster_replication_current_link_latency_ms`        | Current replication link latency in milliseconds                                                         |
   126  | `minio_cluster_replication_current_transfer_rate`          | Current replication transfer rate in bytes/sec                                                           |
   127  | `minio_cluster_replication_average_transfer_rate`          | Average replication transfer rate in bytes/sec                                                           |
   128  | `minio_cluster_replication_max_transfer_rate`              | Maximum replication transfer rate in bytes/sec seen since server start                                   |
   129  | `minio_cluster_replication_last_minute_queued_count`       | Total number of objects queued for replication in the last full minute                                   |
   130  | `minio_cluster_replication_last_minute_queued_bytes`       | Total number of bytes queued for replication in the last full minute                                     |
   131  | `minio_cluster_replication_average_queued_count`           | Average number of objects queued for replication since server start                                      |
   132  | `minio_cluster_replication_average_queued_bytes`           | Average number of bytes queued for replication since server start                                        |
   133  | `minio_cluster_replication_max_queued_bytes`               | Maximum number of bytes queued for replication seen since server start                                   |
   134  | `minio_cluster_replication_max_queued_count`               | Maximum number of objects queued for replication seen since server start                                 |
   135  | `minio_cluster_replication_recent_backlog_count`           | Total number of objects seen in replication backlog in the last 5 minutes                                |
   136  
   137  ## Healing Metrics
   138  
   139  | Name                                         | Description                                                      |
   140  |:---------------------------------------------|:-----------------------------------------------------------------|
   141  | `minio_heal_objects_errors_total`            | Objects for which healing failed in current self healing run.    |
   142  | `minio_heal_objects_heal_total`              | Objects healed in current self healing run.                      |
   143  | `minio_heal_objects_total`                   | Objects scanned in current self healing run.                     |
   144  | `minio_heal_time_last_activity_nano_seconds` | Time elapsed (in nano seconds) since last self healing activity. |
   145  
   146  ## Inter Node Metrics
   147  
   148  | Name                                      | Description                                             |
   149  |:------------------------------------------|:--------------------------------------------------------|
   150  | `minio_inter_node_traffic_dial_avg_time`  | Average time of internodes TCP dial calls.              |
   151  | `minio_inter_node_traffic_dial_errors`    | Total number of internode TCP dial timeouts and errors. |
   152  | `minio_inter_node_traffic_errors_total`   | Total number of failed internode calls.                 |
   153  | `minio_inter_node_traffic_received_bytes` | Total number of bytes received from other peer nodes.   |
   154  | `minio_inter_node_traffic_sent_bytes`     | Total number of bytes sent to the other peer nodes.     |
   155  
   156  ## Bucket Notification Metrics
   157  
   158  | Name                                           | Description                                                                                                                                 |
   159  |:-----------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
   160  | `minio_notify_current_send_in_progress`        | Number of concurrent async Send calls active to all targets (deprecated, please use 'minio_notify_target_current_send_in_progress' instead) |
   161  | `minio_notify_events_errors_total`             | Events that were failed to be sent to the targets (deprecated, please use 'minio_notify_target_failed_events' instead)                      |
   162  | `minio_notify_events_sent_total`               | Total number of events sent to the targets (deprecated, please use 'minio_notify_target_total_events' instead)                              |
   163  | `minio_notify_events_skipped_total`            | Events that were skipped to be sent to the targets due to the in-memory queue being full                                                    |
   164  | `minio_notify_target_current_send_in_progress` | Number of concurrent async Send calls active to the target                                                                                  |
   165  | `minio_notify_target_queue_length`             | Number of events currently staged in the queue_dir configured for the target.                                                               |
   166  | `minio_notify_target_total_events`             | Total number of events sent (or) queued to the target                                                                                       |
   167  
   168  ## S3 API Request Metrics
   169  
   170  | Name                                          | Description                                              |
   171  |:----------------------------------------------|:---------------------------------------------------------|
   172  | `minio_s3_requests_4xx_errors_total`          | Total number S3 requests with (4xx) errors.              |
   173  | `minio_s3_requests_5xx_errors_total`          | Total number S3 requests with (5xx) errors.              |
   174  | `minio_s3_requests_canceled_total`            | Total number S3 requests canceled by the client.         |
   175  | `minio_s3_requests_errors_total`              | Total number S3 requests with (4xx and 5xx) errors.      |
   176  | `minio_s3_requests_incoming_total`            | Volatile number of total incoming S3 requests.           |
   177  | `minio_s3_requests_inflight_total`            | Total number of S3 requests currently in flight.         |
   178  | `minio_s3_requests_rejected_auth_total`       | Total number S3 requests rejected for auth failure.      |
   179  | `minio_s3_requests_rejected_header_total`     | Total number S3 requests rejected for invalid header.    |
   180  | `minio_s3_requests_rejected_invalid_total`    | Total number S3 invalid requests.                        |
   181  | `minio_s3_requests_rejected_timestamp_total`  | Total number S3 requests rejected for invalid timestamp. |
   182  | `minio_s3_requests_total`                     | Total number S3 requests.                                |
   183  | `minio_s3_requests_waiting_total`             | Number of S3 requests in the waiting queue.              |
   184  | `minio_s3_requests_ttfb_seconds_distribution` | Distribution of the time to first byte across API calls. |
   185  | `minio_s3_traffic_received_bytes`             | Total number of s3 bytes received.                       |
   186  | `minio_s3_traffic_sent_bytes`                 | Total number of s3 bytes sent.                           |
   187  
   188  ## Software Metrics
   189  
   190  | Name                          | Description                            |
   191  |:------------------------------|:---------------------------------------|
   192  | `minio_software_commit_info`  | Git commit hash for the MinIO release. |
   193  | `minio_software_version_info` | MinIO Release tag for the server.      |
   194  
   195  ## Drive Metrics
   196  
   197  | Name                                   | Description                                                                         |
   198  |:---------------------------------------|:------------------------------------------------------------------------------------|
   199  | `minio_node_drive_free_bytes`          | Total storage available on a drive.                                                 |
   200  | `minio_node_drive_free_inodes`         | Total free inodes.                                                                  |
   201  | `minio_node_drive_latency_us`          | Average last minute latency in µs for drive API storage operations.                 |
   202  | `minio_node_drive_offline_total`       | Total drives offline in this node.                                                  |
   203  | `minio_node_drive_online_total`        | Total drives online in this node.                                                   |
   204  | `minio_node_drive_total`               | Total drives in this node.                                                          |
   205  | `minio_node_drive_total_bytes`         | Total storage on a drive.                                                           |
   206  | `minio_node_drive_used_bytes`          | Total storage used on a drive.                                                      |
   207  | `minio_node_drive_errors_timeout`      | Total number of drive timeout errors since server start                             |
   208  | `minio_node_drive_errors_availability` | Total number of drive I/O errors, permission denied and timeouts since server start |
   209  | `minio_node_drive_io_waiting`          | Total number I/O operations waiting on drive                                        |
   210  
   211  ## Identity and Access Management (IAM) Metrics
   212  
   213  | Name                                       | Description                                                 |
   214  |:-------------------------------------------|:------------------------------------------------------------|
   215  | `minio_node_iam_last_sync_duration_millis` | Last successful IAM data sync duration in milliseconds.     |
   216  | `minio_node_iam_since_last_sync_millis`    | Time (in milliseconds) since last successful IAM data sync. |
   217  | `minio_node_iam_sync_failures`             | Number of failed IAM data syncs since server start.         |
   218  | `minio_node_iam_sync_successes`            | Number of successful IAM data syncs since server start.     |
   219  
   220  ## Information Lifecycle Management (ILM) Metrics
   221  
   222  | Name                                                         | Description                                                                                                |
   223  |:-------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------|
   224  | `minio_node_ilm_expiry_pending_tasks`                        | Number of pending ILM expiry tasks in the queue.                                                           |
   225  | `minio_node_ilm_transition_active_tasks`                     | Number of active ILM transition tasks.                                                                     |
   226  | `minio_node_ilm_transition_pending_tasks`                    | Number of pending ILM transition tasks in the queue.                                                       |
   227  | `minio_node_ilm_transition_missed_immediate_tasks`           | Number of missed immediate ILM transition tasks.                                                           |
   228  | `minio_node_ilm_versions_scanned`                            | Total number of object versions checked for ilm actions since server start.                                |
   229  | `minio_node_ilm_action_count_delete_action`                  | Total action outcome of lifecycle checks since server start for deleting object                            |
   230  | `minio_node_ilm_action_count_delete_version_action`          | Total action outcome of lifecycle checks since server start for deleting a version                         |
   231  | `minio_node_ilm_action_count_transition_action`              | Total action outcome of lifecycle checks since server start for transition of an object                    |
   232  | `minio_node_ilm_action_count_transition_version_action`      | Total action outcome of lifecycle checks since server start for transition of a particular object version  |
   233  | `minio_node_ilm_action_count_delete_restored_action`         | Total action outcome of lifecycle checks since server start for deletion of temporarily restored object    |
   234  | `minio_node_ilm_action_count_delete_restored_version_action` | Total action outcome of lifecycle checks since server start for deletion of a temporarily restored version |
   235  | `minio_node_ilm_action_count_delete_all_versions_action`     | Total action outcome of lifecycle checks since server start for deletion of all versions                   |
   236  
   237  ## Tier Metrics
   238  
   239  | Name                                               | Description                                                                 |
   240  |:---------------------------------------------------|:----------------------------------------------------------------------------|
   241  | `minio_node_tier_tier_ttlb_seconds_distribution`   | Distribution of time to last byte for objects downloaded from warm tier     |
   242  | `minio_node_tier_requests_success`                 | Number of requests to download object from warm tier that were successful   | 
   243  | `minio_node_tier_requests_failure`                 | Number of requests to download object from warm tier that were failure      | 
   244  
   245  ## System Metrics
   246  
   247  | Name                                       | Description                                                                                                     |
   248  |:-------------------------------------------|:----------------------------------------------------------------------------------------------------------------|
   249  | `minio_node_file_descriptor_limit_total`   | Limit on total number of open file descriptors for the MinIO Server process.                                    |
   250  | `minio_node_file_descriptor_open_total`    | Total number of open file descriptors by the MinIO Server process.                                              |
   251  | `minio_node_go_routine_total`              | Total number of go routines running.                                                                            |
   252  | `minio_node_io_rchar_bytes`                | Total bytes read by the process from the underlying storage system including cache, /proc/[pid]/io rchar.       |
   253  | `minio_node_io_read_bytes`                 | Total bytes read by the process from the underlying storage system, /proc/[pid]/io read_bytes.                  |
   254  | `minio_node_io_wchar_bytes`                | Total bytes written by the process to the underlying storage system including page cache, /proc/[pid]/io wchar. |
   255  | `minio_node_io_write_bytes`                | Total bytes written by the process to the underlying storage system, /proc/[pid]/io write_bytes.                |
   256  | `minio_node_process_cpu_total_seconds`     | Total user and system CPU time spent in seconds.                                                                |
   257  | `minio_node_process_resident_memory_bytes` | Resident memory size in bytes.                                                                                  |
   258  | `minio_node_process_virtual_memory_bytes`  | Virtual memory size in bytes.                                                                                   |
   259  | `minio_node_process_starttime_seconds`     | Start time for MinIO process per node, time in seconds since Unix epoc.                                         |
   260  | `minio_node_process_uptime_seconds`        | Uptime for MinIO process per node in seconds.                                                                   |
   261  
   262  ## Scanner Metrics
   263  
   264  | Name                                       | Description                                                 |
   265  |:-------------------------------------------|:------------------------------------------------------------|
   266  | `minio_node_scanner_bucket_scans_finished` | Total number of bucket scans finished since server start.   |
   267  | `minio_node_scanner_bucket_scans_started`  | Total number of bucket scans started since server start.    |
   268  | `minio_node_scanner_directories_scanned`   | Total number of directories scanned since server start.     |
   269  | `minio_node_scanner_objects_scanned`       | Total number of unique objects scanned since server start.  |
   270  | `minio_node_scanner_versions_scanned`      | Total number of object versions scanned since server start. |
   271  | `minio_node_syscall_read_total`            | Total read SysCalls to the kernel. /proc/[pid]/io syscr.    |
   272  | `minio_node_syscall_write_total`           | Total write SysCalls to the kernel. /proc/[pid]/io syscw.   |
   273  | `minio_usage_last_activity_nano_seconds`   | Time elapsed (in nano seconds) since last scan activity.    |
   274  
   275  # Bucket Metrics
   276  
   277  MinIO collects the following metrics at the bucket level.
   278  Each metric includes the ``bucket`` label to identify the corresponding bucket.
   279  Metrics may include one or more additional labels, such as the server that calculated that metric.
   280  
   281  These metrics can be obtained from any MinIO server once per collection by using the following URL:
   282  
   283  ```shell
   284  https://HOSTNAME:PORT/minio/v2/metrics/bucket
   285  ```
   286  
   287  Replace ``HOSTNAME:PORT`` with the hostname of your MinIO deployment.
   288  For deployments behind a load balancer, use the load balancer hostname instead of a single node hostname.
   289  
   290  ## Distribution Metrics
   291  
   292  | Name                                        | Description                                                                     |
   293  |:--------------------------------------------|:--------------------------------------------------------------------------------|
   294  | `minio_bucket_objects_size_distribution`    | Distribution of object sizes in the bucket, includes label for the bucket name. |
   295  | `minio_bucket_objects_version_distribution` | Distribution of object sizes in a bucket, by number of versions                 |
   296  
   297  ## Replication Metrics
   298  
   299  These metrics only populate on deployments with [Bucket Replication](https://min.io/docs/minio/linux/administration/bucket-replication.html) or [Batch Replication](https://min.io/docs/minio/linux/administration/batch-framework.html) configurations.
   300  For deployments with [Site Replication](https://min.io/docs/minio/linux/operations/install-deploy-manage/multi-site-replication.html) configured, select metrics populate under the [Cluster Metrics](#cluster-metrics) endpoint.
   301  
   302  | Name                                                | Description                                                                      |
   303  |:----------------------------------------------------|:---------------------------------------------------------------------------------|
   304  | `minio_bucket_replication_last_minute_failed_bytes` | Total number of bytes failed at least once to replicate in the last full minute. |
   305  | `minio_bucket_replication_last_minute_failed_count` | Total number of objects which failed replication in the last full minute.        |
   306  | `minio_bucket_replication_last_hour_failed_bytes`   | Total number of bytes failed at least once to replicate in the last full hour.   |
   307  | `minio_bucket_replication_last_hour_failed_count`   | Total number of objects which failed replication in the last full hour.          |
   308  | `minio_bucket_replication_total_failed_bytes`       | Total number of bytes failed at least once to replicate since server start.      |
   309  | `minio_bucket_replication_total_failed_count`       | Total number of objects which failed replication since server start.             |
   310  | `minio_bucket_replication_latency_ms`               | Replication latency in milliseconds.                                             |
   311  | `minio_bucket_replication_received_bytes`           | Total number of bytes replicated to this bucket from another source bucket.      |
   312  | `minio_bucket_replication_received_count`           | Total number of objects received by this bucket from another source bucket.      |
   313  | `minio_bucket_replication_sent_bytes`               | Total number of bytes replicated to the target bucket.                           |
   314  | `minio_bucket_replication_sent_count`               | Total number of objects replicated to the target bucket.                         |
   315  | `minio_bucket_replication_credential_errors`        | Total number of replication credential errors since server start                 |
   316  | `minio_bucket_replication_proxied_get_requests_total` | Number of GET requests proxied to replication target                          |
   317  | `minio_bucket_replication_proxied_head_requests_total` | Number of HEAD requests proxied to replication target                          |
   318  | `minio_bucket_replication_proxied_delete_tagging_requests_total` | Number of DELETE tagging requests proxied to replication target                          |
   319  | `minio_bucket_replication_proxied_get_tagging_requests_total` | Number of GET tagging requests proxied to replication target                          |
   320  | `minio_bucket_replication_proxied_put_tagging_requests_total` | Number of PUT tagging requests proxied to replication target                          |
   321  | `minio_bucket_replication_proxied_get_requests_failures` | Number of failures in GET requests proxied to replication target                          |
   322  | `minio_bucket_replication_proxied_head_requests_failures` | Number of failures in HEAD requests proxied to replication target                          |
   323  | `minio_bucket_replication_proxied_delete_tagging_requests_failures` | Number of failures in DELETE tagging proxy requests to replication target                          |
   324  | `minio_bucket_replication_proxied_get_tagging_requests_failures` |Number of failures in GET tagging proxy requests to replication target                          |
   325  | `minio_bucket_replication_proxied_put_tagging_requests_failures` | Number of failures in PUT tagging proxy requests to replication target                          |
   326  
   327  ## Traffic Metrics
   328  
   329  | Name                                  | Description                                        |
   330  |:--------------------------------------|:---------------------------------------------------|
   331  | `minio_bucket_traffic_received_bytes` | Total number of S3 bytes received for this bucket. |
   332  | `minio_bucket_traffic_sent_bytes`     | Total number of S3 bytes sent for this bucket.     |
   333  	
   334  ## Usage Metrics
   335  
   336  | Name                                    | Description                                       |
   337  |:----------------------------------------|:--------------------------------------------------|
   338  | `minio_bucket_usage_object_total`       | Total number of objects.                          |
   339  | `minio_bucket_usage_version_total`      | Total number of versions (includes delete marker) |
   340  | `minio_bucket_usage_deletemarker_total` | Total number of delete markers.                   |
   341  | `minio_bucket_usage_total_bytes`        | Total bucket size in bytes.                       |
   342  | `minio_bucket_quota_total_bytes`        | Total bucket quota size in bytes.                 |
   343  
   344  ## Requests Metrics
   345  
   346  | Name                                              | Description                                                     |
   347  |:--------------------------------------------------|:----------------------------------------------------------------|
   348  | `minio_bucket_requests_4xx_errors_total`          | Total number of S3 requests with (4xx) errors on a bucket.      |
   349  | `minio_bucket_requests_5xx_errors_total`          | Total number of S3 requests with (5xx) errors on a bucket.      |
   350  | `minio_bucket_requests_inflight_total`            | Total number of S3 requests currently in flight on a bucket.    |
   351  | `minio_bucket_requests_total`                     | Total number of S3 requests on a bucket.                        |
   352  | `minio_bucket_requests_canceled_total`            | Total number S3 requests canceled by the client.                |
   353  | `minio_bucket_requests_ttfb_seconds_distribution` | Distribution of time to first byte across API calls per bucket. |
   354  
   355  # Resource Metrics
   356  
   357  MinIO collects the following resource metrics at the node level.
   358  Each metric includes the `server` label to identify the corresponding node.
   359  Metrics may include one or more additional labels, such as the drive path, interface name, etc.
   360  
   361  These metrics can be obtained from any MinIO server once per collection by using the following URL:
   362  
   363  ```shell
   364  https://HOSTNAME:PORT/minio/v2/metrics/resource
   365  ```
   366  
   367  Replace `HOSTNAME:PORT` with the hostname of your MinIO deployment.
   368  For deployments behind a load balancer, use the load balancer hostname instead of a single node hostname.
   369  
   370  ## Drive Resource Metrics
   371  
   372  | Name                                 | Description                                              |
   373  |:-------------------------------------|:---------------------------------------------------------|
   374  | `minio_node_drive_total_bytes`       | Total bytes on a drive.                                  |
   375  | `minio_node_drive_used_bytes`        | Used bytes on a drive.                                   |
   376  | `minio_node_drive_total_inodes`      | Total inodes on a drive.                                 |
   377  | `minio_node_drive_used_inodes`       | Total inodes used on a drive.                            |
   378  | `minio_node_drive_reads_per_sec`     | Reads per second on a drive.                             |
   379  | `minio_node_drive_reads_kb_per_sec`  | Kilobytes read per second on a drive.                    |
   380  | `minio_node_drive_reads_await`       | Average time for read requests to be served on a drive.  |
   381  | `minio_node_drive_writes_per_sec`    | Writes per second on a drive.                            |
   382  | `minio_node_drive_writes_kb_per_sec` | Kilobytes written per second on a drive.                 |
   383  | `minio_node_drive_writes_await`      | Average time for write requests to be served on a drive. |
   384  | `minio_node_drive_perc_util`         | Percentage of time the disk was busy since uptime.       |
   385  
   386  ## Network Interface Metrics
   387  
   388  | Name                          | Description                                                |
   389  |:------------------------------|:-----------------------------------------------------------|
   390  | `minio_node_if_rx_bytes`      | Bytes received on the interface in 60s.                    |
   391  | `minio_node_if_rx_bytes_avg`  | Bytes received on the interface in 60s (avg) since uptime. |
   392  | `minio_node_if_rx_bytes_max`  | Bytes received on the interface in 60s (max) since uptime. |
   393  | `minio_node_if_rx_errors`     | Receive errors in 60s.                                     |
   394  | `minio_node_if_rx_errors_avg` | Receive errors in 60s (avg).                               |
   395  | `minio_node_if_rx_errors_max` | Receive errors in 60s (max).                               |
   396  | `minio_node_if_tx_bytes`      | Bytes transmitted in 60s.                                  |
   397  | `minio_node_if_tx_bytes_avg`  | Bytes transmitted in 60s (avg).                            |
   398  | `minio_node_if_tx_bytes_max`  | Bytes transmitted in 60s (max).                            |
   399  | `minio_node_if_tx_errors`     | Transmit errors in 60s.                                    |
   400  | `minio_node_if_tx_errors_avg` | Transmit errors in 60s (avg).                              |
   401  | `minio_node_if_tx_errors_max` | Transmit errors in 60s (max).                              |
   402  
   403  ## CPU Metrics
   404  
   405  | Name                                 | Description                                |
   406  |:-------------------------------------|:-------------------------------------------|
   407  | `minio_node_cpu_avg_user`            | CPU user time.                             |
   408  | `minio_node_cpu_avg_user_avg`        | CPU user time (avg).                       |
   409  | `minio_node_cpu_avg_user_max`        | CPU user time (max).                       |
   410  | `minio_node_cpu_avg_system`          | CPU system time.                           |
   411  | `minio_node_cpu_avg_system_avg`      | CPU system time (avg).                     |
   412  | `minio_node_cpu_avg_system_max`      | CPU system time (max).                     |
   413  | `minio_node_cpu_avg_idle`            | CPU idle time.                             |
   414  | `minio_node_cpu_avg_idle_avg`        | CPU idle time (avg).                       |
   415  | `minio_node_cpu_avg_idle_max`        | CPU idle time (max).                       |
   416  | `minio_node_cpu_avg_iowait`          | CPU ioWait time.                           |
   417  | `minio_node_cpu_avg_iowait_avg`      | CPU ioWait time (avg).                     |
   418  | `minio_node_cpu_avg_iowait_max`      | CPU ioWait time (max).                     |
   419  | `minio_node_cpu_avg_nice`            | CPU nice time.                             |
   420  | `minio_node_cpu_avg_nice_avg`        | CPU nice time (avg).                       |
   421  | `minio_node_cpu_avg_nice_max`        | CPU nice time (max).                       |
   422  | `minio_node_cpu_avg_steal`           | CPU steam time.                            |
   423  | `minio_node_cpu_avg_steal_avg`       | CPU steam time (avg).                      |
   424  | `minio_node_cpu_avg_steal_max`       | CPU steam time (max).                      |
   425  | `minio_node_cpu_avg_load1`           | CPU load average 1min.                     |
   426  | `minio_node_cpu_avg_load1_avg`       | CPU load average 1min (avg).               |
   427  | `minio_node_cpu_avg_load1_max`       | CPU load average 1min (max).               |
   428  | `minio_node_cpu_avg_load1_perc`      | CPU load average 1min (percentage).        |
   429  | `minio_node_cpu_avg_load1_perc_avg`  | CPU load average 1min (percentage) (avg).  |
   430  | `minio_node_cpu_avg_load1_perc_max`  | CPU load average 1min (percentage) (max).  |
   431  | `minio_node_cpu_avg_load5`           | CPU load average 5min.                     |
   432  | `minio_node_cpu_avg_load5_avg`       | CPU load average 5min (avg).               |
   433  | `minio_node_cpu_avg_load5_max`       | CPU load average 5min (max).               |
   434  | `minio_node_cpu_avg_load5_perc`      | CPU load average 5min (percentage).        |
   435  | `minio_node_cpu_avg_load5_perc_avg`  | CPU load average 5min (percentage) (avg).  |
   436  | `minio_node_cpu_avg_load5_perc_max`  | CPU load average 5min (percentage) (max).  |
   437  | `minio_node_cpu_avg_load15`          | CPU load average 15min.                    |
   438  | `minio_node_cpu_avg_load15_avg`      | CPU load average 15min (avg).              |
   439  | `minio_node_cpu_avg_load15_max`      | CPU load average 15min (max).              |
   440  | `minio_node_cpu_avg_load15_perc`     | CPU load average 15min (percentage).       |
   441  | `minio_node_cpu_avg_load15_perc_avg` | CPU load average 15min (percentage) (avg). |
   442  | `minio_node_cpu_avg_load15_perc_max` | CPU load average 15min (percentage) (max). |
   443  
   444  ## Memory Metrics
   445  
   446  | Name                           | Description                               |
   447  |:-------------------------------|:------------------------------------------|
   448  | `minio_node_mem_available`     | Available memory on the node.             |
   449  | `minio_node_mem_available_avg` | Available memory on the node (avg).       |
   450  | `minio_node_mem_available_max` | Available memory on the node (max).       |
   451  | `minio_node_mem_buffers`       | Buffers memory on the node.               |
   452  | `minio_node_mem_buffers_avg`   | Buffers memory on the node (avg).         |
   453  | `minio_node_mem_buffers_max`   | Buffers memory on the node (max).         |
   454  | `minio_node_mem_cache`         | Cache memory on the node.                 |
   455  | `minio_node_mem_cache_avg`     | Cache memory on the node (avg).           |
   456  | `minio_node_mem_cache_max`     | Cache memory on the node (max).           |
   457  | `minio_node_mem_free`          | Free memory on the node.                  |
   458  | `minio_node_mem_free_avg`      | Free memory on the node (avg).            |
   459  | `minio_node_mem_free_max`      | Free memory on the node (max).            |
   460  | `minio_node_mem_shared`        | Shared memory on the node.                |
   461  | `minio_node_mem_shared_avg`    | Shared memory on the node (avg).          |
   462  | `minio_node_mem_shared_max`    | Shared memory on the node (max).          |
   463  | `minio_node_mem_total`         | Total memory on the node.                 |
   464  | `minio_node_mem_total_avg`     | Total memory on the node (avg).           |
   465  | `minio_node_mem_total_max`     | Total memory on the node (max).           |
   466  | `minio_node_mem_used`          | Used memory on the node.                  |
   467  | `minio_node_mem_used_avg`      | Used memory on the node (avg).            |
   468  | `minio_node_mem_used_max`      | Used memory on the node (max).            |
   469  | `minio_node_mem_used_perc`     | Used memory percentage on the node.       |
   470  | `minio_node_mem_used_perc_avg` | Used memory percentage on the node (avg). |
   471  | `minio_node_mem_used_perc_max` | Used memory percentage on the node (max). |