diff --git a/source/operations/checklists/software.rst b/source/operations/checklists/software.rst index 2201329b..9c9703b9 100644 --- a/source/operations/checklists/software.rst +++ b/source/operations/checklists/software.rst @@ -59,7 +59,7 @@ MinIO Pre-requisites - :ref:`Prometheus ` or a Prometheus-compatible setup for monitoring and metrics * - :octicon:`circle` - - :ref:`Grafana configured ` for dashboards + - (optional) `Grafana `__ for custom dashboards * - :octicon:`circle` - (optional) :mc:`mc` installed on the local host system diff --git a/source/operations/monitoring.rst b/source/operations/monitoring.rst index 1575a93c..50f117e5 100644 --- a/source/operations/monitoring.rst +++ b/source/operations/monitoring.rst @@ -68,4 +68,3 @@ See :ref:`minio-healthcheck-api` for more information. /operations/monitoring/metrics-and-alerts /operations/monitoring/minio-logging /operations/monitoring/healthcheck-probe - /operations/monitoring/grafana diff --git a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst index ce2fbd95..086c46fe 100644 --- a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst +++ b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst @@ -195,9 +195,3 @@ In the Prometheus configuration, specify the path to the alert file in the ``rul - minio-alerting.yml Once triggered, Prometheus sends the alert to the configured AlertManager service. - -Dashboards ----------- - -For v2 metrics, MinIO provides Grafana Dashboards to display metrics collected by Prometheus. -For more information, see :ref:`minio-grafana` diff --git a/source/operations/monitoring/grafana.rst b/source/operations/monitoring/grafana.rst index 6e1821b3..39787c0a 100644 --- a/source/operations/monitoring/grafana.rst +++ b/source/operations/monitoring/grafana.rst @@ -1,3 +1,4 @@ +:orphan: .. _minio-grafana: =================================== diff --git a/source/operations/monitoring/metrics-v2-deprecated.rst b/source/operations/monitoring/metrics-v2-deprecated.rst index 058258c1..3f23b655 100644 --- a/source/operations/monitoring/metrics-v2-deprecated.rst +++ b/source/operations/monitoring/metrics-v2-deprecated.rst @@ -364,6 +364,12 @@ In the Prometheus configuration, specify the path to the alert file in the ``rul Once triggered, Prometheus sends the alert to the configured AlertManager service. +Dashboards +---------- + +For v2 metrics, MinIO provides Grafana Dashboards to display the metrics collected by Prometheus. +For more information, see :ref:`minio-grafana` + Available metrics ----------------- diff --git a/source/reference/minio-mc-admin/mc-admin-prometheus-generate.rst b/source/reference/minio-mc-admin/mc-admin-prometheus-generate.rst index dcfaee03..9c8809ef 100644 --- a/source/reference/minio-mc-admin/mc-admin-prometheus-generate.rst +++ b/source/reference/minio-mc-admin/mc-admin-prometheus-generate.rst @@ -70,8 +70,8 @@ Parameters .. mc-cmd:: --api-version v3 :optional: - Generate a scrape configuration for metrics version 3. - Omit to generate a metrics version 2 configuration. + Generate a scrape configuration for :ref:`metrics version 3 `. + Omit to generate a :ref:`metrics version 2 ` configuration. .. mc-cmd:: --bucket :optional: @@ -140,7 +140,7 @@ Use :mc-cmd:`mc admin prometheus generate --api-version v3` to generate a scrape .. code-block:: shell :class: copyable - mc admin prometheus generate ALIAS --api-version v3 + mc admin prometheus generate ALIAS --api-version v3 - Replace ``ALIAS`` with the :mc-cmd:`alias ` of the MinIO deployment. @@ -157,6 +157,33 @@ The output resembles the following: - targets: ['localhost:9000'] +Generate a v3 cluster metrics config +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Use :mc-cmd:`mc admin prometheus generate --api-version v3` to generate a scrape configuration that collects v3 cluster metrics for a MinIO deployment: + +.. code-block:: shell + :class: copyable + + mc admin prometheus generate ALIAS cluster --api-version v3 + +- Replace ``ALIAS`` with the :mc-cmd:`alias ` of the MinIO deployment. + +The output resembles the following: + +.. code-block:: shell + + scrape_configs: + - job_name: minio-job-cluster + bearer_token: [auth token] + metrics_path: /minio/metrics/v3/cluster + scheme: http + static_configs: + - targets: ['localhost:9000'] + +To generate a configuration for a :mc-cmd:`different metric type `, replace ``cluster`` with the desired type. + + Generate a v3 bucket replication metrics config ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -181,6 +208,8 @@ The output resembles the following: static_configs: - targets: [`localhost:9000`] +To generate a configuration for API metrics for a bucket, replace ``replication`` with ``api``. + Generate a default metrics v2 config ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -190,7 +219,7 @@ By default, :mc-cmd:`mc admin prometheus generate` generates a scrape configurat .. code-block:: shell :class: copyable - mc admin prometheus generate ALIAS + mc admin prometheus generate ALIAS - Replace ``ALIAS`` with the :mc-cmd:`alias ` of the MinIO deployment. @@ -212,4 +241,4 @@ The following generates a scrape configuration for v2 bucket metrics: .. code-block:: shell :class: copyable - mc admin prometheus generate ALIAS bucket + mc admin prometheus generate ALIAS bucket