1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00

Doc updates for mc RELEASE.2023-10-04T06-52-56Z (#1044)

Doc updates for mc release
[2023-10-04T06-52-56Z](https://github.com/minio/docs/issues/1035)

- [x] `resource` type for Prometheus metrics
- [x] Doc `mc admin trace --request-query`, ~maybe it and some other
should be hidden from `mc --help`?~

Staged:

http://192.241.195.202:9000/staging/DOCS-1035/linux/operations/monitoring/collect-minio-metrics-using-prometheus.html

Fixes https://github.com/minio/docs/issues/1035
This commit is contained in:
Andrea Longo
2023-10-23 15:17:50 -06:00
committed by GitHub
parent ed963c6506
commit 1747558ffc
3 changed files with 51 additions and 7 deletions

View File

@ -15,7 +15,7 @@ Monitoring and Alerting using Prometheus
- `Monitoring with MinIO and Prometheus: Overview <https://youtu.be/A3vCDaFWNNs?ref=docs>`__
- `Monitoring with MinIO and Prometheus: Lab <https://youtu.be/Oix9iXndSUY?ref=docs>`__
MinIO publishes cluster, node, and bucket metrics using the :prometheus-docs:`Prometheus Data Model <concepts/data_model/#data-model>`.
MinIO publishes cluster, node, bucket, and resource metrics using the :prometheus-docs:`Prometheus Data Model <concepts/data_model/#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 <mc admin prometheus generate TARGET>` with the :mc:`alias <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 <mc admin prometheus generate TARGET>` with the :mc:`alias <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:

View File

@ -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.

View File

@ -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.