diff --git a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst index 9c3d1157..fb1988bb 100644 --- a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst +++ b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst @@ -15,7 +15,7 @@ Monitoring and Alerting using Prometheus - `Monitoring with MinIO and Prometheus: Overview `__ - `Monitoring with MinIO and Prometheus: Lab `__ -MinIO publishes cluster, node, and bucket metrics using the :prometheus-docs:`Prometheus Data Model `. +MinIO publishes cluster, node, bucket, and resource metrics using the :prometheus-docs:`Prometheus Data Model `. The procedure on this page documents the following: - Configuring a Prometheus service to scrape and display metrics from a MinIO deployment @@ -75,6 +75,20 @@ Use the :mc-cmd:`mc admin prometheus generate` command to generate the scrape co Replace :mc-cmd:`ALIAS ` with the :mc:`alias ` of the MinIO deployment. + + .. tab-item:: Resources + + .. versionadded:: RELEASE.2023-10-07T15-07-38Z + + The following command scrapes metrics for resources on the MinIO Server. + + .. code-block:: shell + :class: copyable + + mc admin prometheus generate ALIAS resource + + Replace :mc-cmd:`ALIAS ` with the :mc:`alias ` of the MinIO deployment. + The command returns output similar to the following: .. code-block:: yaml @@ -113,10 +127,11 @@ Append the desired ``scrape_configs`` job generated in the previous step to the .. tab-set:: - .. tab-item:: Cluster metrics + .. tab-item:: Cluster + + Cluster metrics aggregate node-level metrics and, where appropriate, attach labels to metrics for the originating node. + If you are already collecting ``cluster`` metrics, you do not need to add an additional ``scrape_configs`` job for ``node``. - For server metrics: - .. code-block:: yaml :class: copyable @@ -131,7 +146,7 @@ Append the desired ``scrape_configs`` job generated in the previous step to the static_configs: - targets: [minio.example.net] - .. tab-item:: Bucket metrics: + .. tab-item:: Bucket .. code-block:: yaml :class: copyable @@ -147,6 +162,21 @@ Append the desired ``scrape_configs`` job generated in the previous step to the static_configs: - targets: [minio.example.net] + .. tab-item:: Resource + + .. code-block:: yaml + :class: copyable + + global: + scrape_interval: 15s + + scrape_configs: + - job_name: minio-job-resource + bearer_token: TOKEN + metrics_path: /minio/v2/metrics/resource + scheme: https + static_configs: + - targets: [minio.example.net] Start the Prometheus cluster using the configuration file: diff --git a/source/reference/minio-mc-admin/mc-admin-prometheus.rst b/source/reference/minio-mc-admin/mc-admin-prometheus.rst index 172f696f..9e2fa263 100644 --- a/source/reference/minio-mc-admin/mc-admin-prometheus.rst +++ b/source/reference/minio-mc-admin/mc-admin-prometheus.rst @@ -56,7 +56,16 @@ Syntax The type of metrics to scrape. - Valid values are ``cluster``, ``node``, or ``bucket``. + .. versionchanged:: RELEASE.2023-10-07T15-07-38Z + + ``resource`` metrics added + + Valid values are: + + - ``bucket`` + - ``cluster`` + - ``node`` + - ``resource`` If not specified, the command returns cluster metrics. - + Cluster metrics also include node metrics. diff --git a/source/reference/minio-mc-admin/mc-admin-trace.rst b/source/reference/minio-mc-admin/mc-admin-trace.rst index ae0b5780..caa7e98e 100644 --- a/source/reference/minio-mc-admin/mc-admin-trace.rst +++ b/source/reference/minio-mc-admin/mc-admin-trace.rst @@ -213,6 +213,11 @@ Syntax Returns calls matching the supplied request header. +.. mc-cmd:: --request-query + + Returns calls matching the supplied request query parameter. + This debug option should only be used at the direction of MinIO Support. + .. mc-cmd:: --response-duration Trace calls with response duration greater than the specified value.