1
0
mirror of https://github.com/minio/docs.git synced 2025-08-09 13:02:53 +03:00

rearrange more metrics v2 content

This commit is contained in:
Andrea Longo
2024-09-19 15:10:20 -06:00
parent 1ff838abed
commit 2e384342bf
6 changed files with 42 additions and 13 deletions

View File

@@ -59,7 +59,7 @@ MinIO Pre-requisites
- :ref:`Prometheus <minio-metrics-collect-using-prometheus>` or a Prometheus-compatible setup for monitoring and metrics
* - :octicon:`circle`
- :ref:`Grafana configured <minio-grafana>` for dashboards
- (optional) `Grafana <https://grafana.com/>`__ for custom dashboards
* - :octicon:`circle`
- (optional) :mc:`mc` installed on the local host system

View File

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

View File

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

View File

@@ -1,3 +1,4 @@
:orphan:
.. _minio-grafana:
===================================

View File

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

View File

@@ -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 <minio-metrics-and-alerts>`.
Omit to generate a :ref:`metrics version 2 <minio-metrics-v2>` configuration.
.. mc-cmd:: --bucket
:optional:
@@ -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 <mc 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 <mc admin prometheus generate 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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~