diff --git a/source/operations/monitoring.rst b/source/operations/monitoring.rst index 63bdac1c..d5a152e0 100644 --- a/source/operations/monitoring.rst +++ b/source/operations/monitoring.rst @@ -71,5 +71,4 @@ See :ref:`minio-healthcheck-api` for more information. /operations/monitoring/metrics-and-alerts /operations/monitoring/minio-logging /operations/monitoring/healthcheck-probe - /operations/monitoring/grafana - \ No newline at end of file + /operations/monitoring/grafana \ No newline at end of file diff --git a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst index bb3cf3f1..9c3d1157 100644 --- a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst +++ b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst @@ -55,7 +55,7 @@ Use the :mc-cmd:`mc admin prometheus generate` command to generate the scrape co .. tab-item:: Nodes - The following command scrapes metrics for a nodes on the MinIO Server. + The following command scrapes metrics for a node on the MinIO Server. .. code-block:: shell :class: copyable diff --git a/source/operations/monitoring/grafana.rst b/source/operations/monitoring/grafana.rst index 6444e711..307cf386 100644 --- a/source/operations/monitoring/grafana.rst +++ b/source/operations/monitoring/grafana.rst @@ -32,6 +32,10 @@ To track changes to the Grafana dashboard, introspect the JSON files for the `se .. _minio-server-grafana-metrics: +To track changes to the Grafana dashboard, introspect the JSON files for the `server `__ or `bucket `__ dashboards in the MinIO Server GitHub repository. + +.. _minio-server-grafana-metrics: + MinIO Server Metrics Dashboard ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/operations/monitoring/metrics-and-alerts.rst b/source/operations/monitoring/metrics-and-alerts.rst index 91d60845..cd4ec871 100644 --- a/source/operations/monitoring/metrics-and-alerts.rst +++ b/source/operations/monitoring/metrics-and-alerts.rst @@ -10,7 +10,7 @@ Metrics and Alerts .. contents:: Table of Contents :local: - :depth: 2 + :depth: 3 MinIO publishes cluster and node metrics using the :prometheus-docs:`Prometheus Data Model `. You can use any scraping tool to pull metrics data from MinIO for further analysis and alerting. @@ -159,14 +159,14 @@ Cluster Usage Metrics Drive Metrics +++++++++++++ -``minio_cluster_disk_offline_total`` - Total drives offline. +``minio_cluster_drive_offline_total`` + Total drives offline in this cluster. -``minio_cluster_disk_online_total`` - Total drives online. +``minio_cluster_drive_online_total`` + Total drives online in this cluster. -``minio_cluster_disk_total`` - Total drives. +``minio_cluster_drive_total`` + Total drives in this cluster. ILM Metrics +++++++++++ @@ -352,29 +352,35 @@ These metrics can be obtained from any MinIO server once per collection. Drive Metrics +++++++++++++ -``minio_node_disk_free_bytes`` - Total storage available on a drive. +``minio_node_drive_free_bytes`` + Total storage available on a drive in this node. -``minio_node_disk_free_inodes`` - Total free inodes. +``minio_node_drive_free_inodes`` + Total free inodes in this node. -``minio_node_disk_latency_us`` +``minio_node_drive_latency_us`` Average last minute latency in µs for drive API storage operations. -``minio_node_disk_offline_total`` - Total drives offline. +``minio_node_drive_offline_total`` + Total drives offline in this node. -``minio_node_disk_online_total`` - Total drives online. +``minio_node_drive_online_total`` + Total drives online in this node. -``minio_node_disk_total`` - Total drives. +``minio_node_drive_total`` + Total drives in this node. -``minio_node_disk_total_bytes`` - Total storage on a drive. +``minio_node_drive_total_bytes`` + Total storage on a drive in this node. -``minio_node_disk_used_bytes`` - Total storage used on a drive. +``minio_node_drive_used_bytes`` + Total storage used on a drive in this node. + +``minio_node_drive_errors_timeout`` + Total number of timeout errors since server start in this node. + +``minio_node_drive_errors_availability`` + Total number of I/O errors, permission denied, and timeouts since server start in this node. File Metrics ++++++++++++ diff --git a/source/reference/minio-mc/mc-support-perf.rst b/source/reference/minio-mc/mc-support-perf.rst index 99afd391..1d5ad259 100644 --- a/source/reference/minio-mc/mc-support-perf.rst +++ b/source/reference/minio-mc/mc-support-perf.rst @@ -40,6 +40,10 @@ For more complete performance testing, consider using a combination of load-test Measure the network throughput of all nodes. +#. :mc-cmd:`~mc support perf client` + + Measure the network throughput to a client. + .. include:: /includes/common-mc-support.rst :start-after: start-minio-only :end-before: end-minio-only @@ -148,6 +152,19 @@ Syntax [--airgap] \ ALIAS +.. mc-cmd:: client + :fullpath: + + Measure the network throughput from the local device running the MinIO Client to the server. + + .. code-block:: shell + + mc [GLOBAL FLAGS] support perf client \ + --duration \ + [--verbose, -v] \ + [--airgap] \ + ALIAS + Parameters ~~~~~~~~~~ @@ -220,9 +237,17 @@ Parameters .. mc-cmd:: ALIAS :required: - Applies to the :mc-cmd:`~mc support perf drive`, :mc-cmd:`~mc support perf object`, and :mc-cmd:`~mc support perf net` commands. + Applies to the :mc-cmd:`~mc support perf drive`, :mc-cmd:`~mc support perf object`, :mc-cmd:`~mc support perf net`, and :mc-cmd:`~mc support perf client` commands. The :ref:`alias ` of the MinIO deployment. + +.. mc-cmd:: --duration + :required: + + Applies to the :mc-cmd:`~mc support perf client` command. + + Length of time in seconds to perform the test. + Time cannot be `0` or negative. Global Flags