Skip to content

Commit 697b851

Browse files
feorlenravindk89
feorlen
and
ravindk89
authoredJun 28, 2024
Rework mc admin prometheus reference page (#1256)
Split the `mc admin prometheus` page into subpages and add missing docs for `mc admin prometheus metrics`. Staged http://192.241.195.202:9000/staging/DOCS-1255/linux/reference/minio-mc-admin/mc-admin-prometheus.html Fixes #1255 --------- Co-authored-by: Ravind Kumar <ravind@min.io>
1 parent af031f7 commit 697b851

File tree

4 files changed

+352
-47
lines changed

4 files changed

+352
-47
lines changed
 

‎source/reference/minio-mc-admin/mc-admin-policy-attach.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Exactly one :mc-cmd:`~mc admin policy attach --user` or one :mc-cmd:`~mc admin p
3030

3131
.. tab-item:: EXAMPLE
3232

33-
The following command displays the current in-progress S3 API calls on the :term:`alias` ``myminio``.
33+
The following command attaches the ``readonly`` policy to the user ``james`` on the deployment at :term:`alias` ``myminio``.
3434

3535
.. code-block:: shell
3636
:class: copyable
@@ -129,4 +129,4 @@ Attach the ``audit-policy`` and ``acct-policy`` policies to group ``legal`` on t
129129
.. code-block:: shell
130130
:class: copyable
131131
132-
mc admin policy attach myminio audit-policy acct-policy --group legal
132+
mc admin policy attach myminio audit-policy acct-policy --group legal

‎source/reference/minio-mc-admin/mc-admin-prometheus-generate.rst

+118
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
================================
2+
``mc admin prometheus generate``
3+
================================
4+
5+
.. default-domain:: minio
6+
7+
.. contents:: Table of Contents
8+
:local:
9+
:depth: 2
10+
11+
.. mc:: mc admin prometheus generate
12+
13+
Description
14+
-----------
15+
16+
.. start-mc-admin-prometheus-generate-desc
17+
18+
The :mc:`mc admin prometheus generate` command generates a metrics scraping configuration file for use with `Prometheus <https://prometheus.io/>`__.
19+
20+
.. end-mc-admin-prometheus-generate-desc
21+
22+
For more complete documentation on using MinIO with Prometheus, see :ref:`How to monitor MinIO server with Prometheus <minio-metrics-collect-using-prometheus>`
23+
24+
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
25+
:class: note
26+
27+
.. include:: /includes/facts-mc-admin.rst
28+
:start-after: start-minio-only
29+
:end-before: end-minio-only
30+
31+
.. tab-set::
32+
33+
.. tab-item:: EXAMPLE
34+
35+
The following command generates a Prometheus scrape configuration that collects bucket metrics from the deployment at :term:`alias` ``myminio``:
36+
37+
.. code-block:: shell
38+
:class: copyable
39+
40+
mc admin prometheus generate myminio bucket
41+
42+
.. tab-item:: SYNTAX
43+
44+
The command has the following syntax:
45+
46+
.. code-block:: shell
47+
:class: copyable
48+
49+
mc [GLOBALFLAGS] admin prometheus generate \
50+
ALIAS \
51+
[TYPE]
52+
53+
.. include:: /includes/common-minio-mc.rst
54+
:start-after: start-minio-syntax
55+
:end-before: end-minio-syntax
56+
57+
58+
Parameters
59+
~~~~~~~~~~
60+
61+
.. mc-cmd:: ALIAS
62+
:required:
63+
64+
The :mc:`alias <mc alias>` of a configured MinIO deployment for which the command generates a Prometheus-compatible configuration file.
65+
66+
.. mc-cmd:: TYPE
67+
:optional:
68+
69+
The type of metrics to scrape.
70+
71+
.. versionchanged:: RELEASE.2023-10-07T15-07-38Z
72+
73+
``resource`` metrics added
74+
75+
Valid values are:
76+
77+
- ``bucket``
78+
- ``cluster``
79+
- ``node``
80+
- ``resource``
81+
82+
If not specified, the command returns cluster metrics.
83+
Cluster metrics also include node metrics.
84+
85+
Global Flags
86+
~~~~~~~~~~~~
87+
88+
.. include:: /includes/common-minio-mc.rst
89+
:start-after: start-minio-mc-globals
90+
:end-before: end-minio-mc-globals
91+
92+
93+
Example
94+
-------
95+
96+
Generate a scrape config for bucket metrics
97+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98+
99+
Use :mc-cmd:`mc admin prometheus generate` to generate a scrape configuration that collects bucket metrics for a MinIO deployment:
100+
101+
.. code-block:: shell
102+
:class: copyable
103+
104+
mc admin prometheus generate ALIAS bucket
105+
106+
- Replace ``ALIAS`` with the :mc-cmd:`alias <mc alias>` of the MinIO deployment.
107+
108+
The output resembles the following:
109+
110+
.. code-block:: shell
111+
112+
scrape_configs:
113+
- job_name: minio-job-bucket
114+
bearer_token: [auth token]
115+
metrics_path: /minio/v2/metrics/bucket
116+
scheme: http
117+
static_configs:
118+
- targets: ['localhost:9000']

‎source/reference/minio-mc-admin/mc-admin-prometheus-metrics.rst

+208
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
===============================
2+
``mc admin prometheus metrics``
3+
===============================
4+
5+
.. default-domain:: minio
6+
7+
.. contents:: Table of Contents
8+
:local:
9+
:depth: 2
10+
11+
.. mc:: mc admin prometheus metrics
12+
13+
Description
14+
-----------
15+
16+
.. start-mc-admin-prometheus-metrics-desc
17+
18+
The :mc:`mc admin prometheus metrics` command prints Prometheus metrics for a cluster.
19+
20+
.. end-mc-admin-prometheus-metrics-desc
21+
22+
For more complete documentation on using MinIO with Prometheus, see :ref:`How to monitor MinIO server with Prometheus <minio-metrics-collect-using-prometheus>`
23+
24+
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
25+
:class: note
26+
27+
.. include:: /includes/facts-mc-admin.rst
28+
:start-after: start-minio-only
29+
:end-before: end-minio-only
30+
31+
.. tab-set::
32+
33+
.. tab-item:: EXAMPLE
34+
35+
The following command prints cluster metrics from the deployment at :term:`alias` ``myminio``:
36+
37+
.. code-block:: shell
38+
:class: copyable
39+
40+
mc admin prometheus metrics myminio cluster
41+
42+
.. tab-item:: SYNTAX
43+
44+
The command has the following syntax:
45+
46+
.. code-block:: shell
47+
:class: copyable
48+
49+
mc [GLOBALFLAGS] admin prometheus metrics \
50+
ALIAS \
51+
[TYPE]
52+
53+
.. include:: /includes/common-minio-mc.rst
54+
:start-after: start-minio-syntax
55+
:end-before: end-minio-syntax
56+
57+
58+
Parameters
59+
~~~~~~~~~~
60+
61+
.. mc-cmd:: ALIAS
62+
:required:
63+
64+
The :mc:`alias <mc alias>` of a configured MinIO deployment for which the command prints metrics.
65+
66+
.. mc-cmd:: TYPE
67+
:optional:
68+
69+
The type of metrics to print.
70+
71+
.. versionchanged:: RELEASE.2023-10-07T15-07-38Z
72+
73+
``resource`` metrics added
74+
75+
Valid values are:
76+
77+
- ``bucket``
78+
- ``cluster``
79+
- ``node``
80+
- ``resource``
81+
82+
If not specified, the command returns cluster metrics.
83+
Cluster metrics include rollups of certain node metrics.
84+
The output includes additional information about each metric, such as if its value is a ``counter`` or ``gauge``.
85+
86+
Global Flags
87+
~~~~~~~~~~~~
88+
89+
.. include:: /includes/common-minio-mc.rst
90+
:start-after: start-minio-mc-globals
91+
:end-before: end-minio-mc-globals
92+
93+
94+
Example
95+
-------
96+
97+
Print bucket metrics
98+
~~~~~~~~~~~~~~~~~~~~
99+
100+
Use :mc-cmd:`mc admin prometheus metrics` to print bucket metrics for a MinIO deployment:
101+
102+
.. code-block:: shell
103+
:class: copyable
104+
105+
mc admin prometheus metrics ALIAS bucket
106+
107+
- Replace ``ALIAS`` with the :mc-cmd:`alias <mc alias>` of the MinIO deployment.
108+
109+
The output resembles the following:
110+
111+
.. code-block:: shell
112+
113+
# HELP minio_bucket_objects_size_distribution Distribution of object sizes in the bucket, includes label for the bucket name
114+
# TYPE minio_bucket_objects_size_distribution gauge
115+
minio_bucket_objects_size_distribution{bucket="mybucket",range="BETWEEN_1024B_AND_1_MB",server="127.0.0.1:9000"} 0
116+
minio_bucket_objects_size_distribution{bucket="mybucket",range="BETWEEN_1024_B_AND_64_KB",server="127.0.0.1:9000"} 0
117+
minio_bucket_objects_size_distribution{bucket="mybucket",range="BETWEEN_10_MB_AND_64_MB",server="127.0.0.1:9000"} 0
118+
minio_bucket_objects_size_distribution{bucket="mybucket",range="BETWEEN_128_MB_AND_512_MB",server="127.0.0.1:9000"} 0
119+
minio_bucket_objects_size_distribution{bucket="mybucket",range="BETWEEN_1_MB_AND_10_MB",server="127.0.0.1:9000"} 0
120+
minio_bucket_objects_size_distribution{bucket="mybucket",range="BETWEEN_256_KB_AND_512_KB",server="127.0.0.1:9000"} 0
121+
minio_bucket_objects_size_distribution{bucket="mybucket",range="BETWEEN_512_KB_AND_1_MB",server="127.0.0.1:9000"} 0
122+
minio_bucket_objects_size_distribution{bucket="mybucket",range="BETWEEN_64_KB_AND_256_KB",server="127.0.0.1:9000"} 0
123+
minio_bucket_objects_size_distribution{bucket="mybucket",range="BETWEEN_64_MB_AND_128_MB",server="127.0.0.1:9000"} 0
124+
minio_bucket_objects_size_distribution{bucket="mybucket",range="GREATER_THAN_512_MB",server="127.0.0.1:9000"} 0
125+
minio_bucket_objects_size_distribution{bucket="mybucket",range="LESS_THAN_1024_B",server="127.0.0.1:9000"} 0
126+
# HELP minio_bucket_objects_version_distribution Distribution of object sizes in the bucket, includes label for the bucket name
127+
# TYPE minio_bucket_objects_version_distribution gauge
128+
minio_bucket_objects_version_distribution{bucket="mybucket",range="BETWEEN_1000_AND_10000",server="127.0.0.1:9000"} 0
129+
minio_bucket_objects_version_distribution{bucket="mybucket",range="BETWEEN_100_AND_1000",server="127.0.0.1:9000"} 0
130+
minio_bucket_objects_version_distribution{bucket="mybucket",range="BETWEEN_10_AND_100",server="127.0.0.1:9000"} 0
131+
minio_bucket_objects_version_distribution{bucket="mybucket",range="BETWEEN_2_AND_10",server="127.0.0.1:9000"} 0
132+
minio_bucket_objects_version_distribution{bucket="mybucket",range="GREATER_THAN_10000",server="127.0.0.1:9000"} 0
133+
minio_bucket_objects_version_distribution{bucket="mybucket",range="SINGLE_VERSION",server="127.0.0.1:9000"} 0
134+
minio_bucket_objects_version_distribution{bucket="mybucket",range="UNVERSIONED",server="127.0.0.1:9000"} 0
135+
# HELP minio_bucket_replication_proxied_delete_tagging_requests_failures Number of failures in DELETE tagging proxy requests to replication target
136+
# TYPE minio_bucket_replication_proxied_delete_tagging_requests_failures counter
137+
minio_bucket_replication_proxied_delete_tagging_requests_failures{server="127.0.0.1:9000"} 0
138+
# HELP minio_bucket_replication_proxied_delete_tagging_requests_total Number of DELETE tagging requests proxied to replication target
139+
# TYPE minio_bucket_replication_proxied_delete_tagging_requests_total counter
140+
minio_bucket_replication_proxied_delete_tagging_requests_total{bucket="mybucket",server="127.0.0.1:9000"} 0
141+
# HELP minio_bucket_replication_proxied_get_requests_failures Number of failures in GET requests proxied to replication target
142+
# TYPE minio_bucket_replication_proxied_get_requests_failures counter
143+
minio_bucket_replication_proxied_get_requests_failures{server="127.0.0.1:9000"} 0
144+
# HELP minio_bucket_replication_proxied_get_requests_total Number of GET requests proxied to replication target
145+
# TYPE minio_bucket_replication_proxied_get_requests_total counter
146+
minio_bucket_replication_proxied_get_requests_total{bucket="mybucket",server="127.0.0.1:9000"} 0
147+
# HELP minio_bucket_replication_proxied_get_tagging_requests_failures Number of failures in GET tagging proxy requests to replication target
148+
# TYPE minio_bucket_replication_proxied_get_tagging_requests_failures counter
149+
minio_bucket_replication_proxied_get_tagging_requests_failures{server="127.0.0.1:9000"} 0
150+
# HELP minio_bucket_replication_proxied_get_tagging_requests_total Number of GET tagging requests proxied to replication target
151+
# TYPE minio_bucket_replication_proxied_get_tagging_requests_total counter
152+
minio_bucket_replication_proxied_get_tagging_requests_total{bucket="mybucket",server="127.0.0.1:9000"} 0
153+
# HELP minio_bucket_replication_proxied_head_requests_failures Number of failures in HEAD requests proxied to replication target
154+
# TYPE minio_bucket_replication_proxied_head_requests_failures counter
155+
minio_bucket_replication_proxied_head_requests_failures{server="127.0.0.1:9000"} 0
156+
# HELP minio_bucket_replication_proxied_head_requests_total Number of HEAD requests proxied to replication target
157+
# TYPE minio_bucket_replication_proxied_head_requests_total counter
158+
minio_bucket_replication_proxied_head_requests_total{bucket="mybucket",server="127.0.0.1:9000"} 0
159+
# HELP minio_bucket_replication_proxied_put_tagging_requests_failures Number of failures in PUT tagging proxy requests to replication target
160+
# TYPE minio_bucket_replication_proxied_put_tagging_requests_failures counter
161+
minio_bucket_replication_proxied_put_tagging_requests_failures{server="127.0.0.1:9000"} 0
162+
# HELP minio_bucket_replication_proxied_put_tagging_requests_total Number of PUT tagging requests proxied to replication target
163+
# TYPE minio_bucket_replication_proxied_put_tagging_requests_total counter
164+
minio_bucket_replication_proxied_put_tagging_requests_total{bucket="mybucket",server="127.0.0.1:9000"} 0
165+
# HELP minio_bucket_replication_received_bytes Total number of bytes replicated to this bucket from another source bucket
166+
# TYPE minio_bucket_replication_received_bytes counter
167+
minio_bucket_replication_received_bytes{bucket="mybucket",server="127.0.0.1:9000"} 0
168+
# HELP minio_bucket_replication_received_count Total number of objects received by this bucket from another source bucket
169+
# TYPE minio_bucket_replication_received_count gauge
170+
minio_bucket_replication_received_count{bucket="mybucket",server="127.0.0.1:9000"} 0
171+
# HELP minio_bucket_requests_4xx_errors_total Total number of S3 requests with (4xx) errors on a bucket
172+
# TYPE minio_bucket_requests_4xx_errors_total counter
173+
minio_bucket_requests_4xx_errors_total{api="getbucketobjectlockconfig",bucket="mybucket",server="127.0.0.1:9000"} 1
174+
# HELP minio_bucket_requests_inflight_total Total number of S3 requests currently in flight on a bucket
175+
# TYPE minio_bucket_requests_inflight_total gauge
176+
minio_bucket_requests_inflight_total{api="getbucketlocation",bucket="mybucket",server="127.0.0.1:9000"} 0
177+
minio_bucket_requests_inflight_total{api="getbucketobjectlockconfig",bucket="mybucket",server="127.0.0.1:9000"} 0
178+
minio_bucket_requests_inflight_total{api="headbucket",bucket="mybucket",server="127.0.0.1:9000"} 0
179+
minio_bucket_requests_inflight_total{api="listobjectsv2",bucket="mybucket",server="127.0.0.1:9000"} 0
180+
minio_bucket_requests_inflight_total{api="putobject",bucket="mybucket",server="127.0.0.1:9000"} 0
181+
# HELP minio_bucket_requests_total Total number of S3 requests on a bucket
182+
# TYPE minio_bucket_requests_total counter
183+
minio_bucket_requests_total{api="getbucketlocation",bucket="mybucket",server="127.0.0.1:9000"} 2
184+
minio_bucket_requests_total{api="getbucketobjectlockconfig",bucket="mybucket",server="127.0.0.1:9000"} 1
185+
minio_bucket_requests_total{api="headbucket",bucket="mybucket",server="127.0.0.1:9000"} 2
186+
minio_bucket_requests_total{api="listobjectsv2",bucket="mybucket",server="127.0.0.1:9000"} 1
187+
minio_bucket_requests_total{api="putobject",bucket="mybucket",server="127.0.0.1:9000"} 1
188+
# HELP minio_bucket_traffic_received_bytes Total number of S3 bytes received for this bucket
189+
# TYPE minio_bucket_traffic_received_bytes gauge
190+
minio_bucket_traffic_received_bytes{bucket="mybucket",server="127.0.0.1:9000"} 178
191+
# HELP minio_bucket_traffic_sent_bytes Total number of S3 bytes sent for this bucket
192+
# TYPE minio_bucket_traffic_sent_bytes gauge
193+
minio_bucket_traffic_sent_bytes{bucket="mybucket",server="127.0.0.1:9000"} 1232
194+
# HELP minio_bucket_usage_deletemarker_total Total number of delete markers
195+
# TYPE minio_bucket_usage_deletemarker_total gauge
196+
minio_bucket_usage_deletemarker_total{bucket="mybucket",server="127.0.0.1:9000"} 0
197+
# HELP minio_bucket_usage_object_total Total number of objects
198+
# TYPE minio_bucket_usage_object_total gauge
199+
minio_bucket_usage_object_total{bucket="mybucket",server="127.0.0.1:9000"} 0
200+
# HELP minio_bucket_usage_total_bytes Total bucket size in bytes
201+
# TYPE minio_bucket_usage_total_bytes gauge
202+
minio_bucket_usage_total_bytes{bucket="mybucket",server="127.0.0.1:9000"} 0
203+
# HELP minio_bucket_usage_version_total Total number of versions (includes delete marker)
204+
# TYPE minio_bucket_usage_version_total gauge
205+
minio_bucket_usage_version_total{bucket="mybucket",server="127.0.0.1:9000"} 0
206+
# HELP minio_usage_last_activity_nano_seconds Time elapsed (in nano seconds) since last scan activity
207+
# TYPE minio_usage_last_activity_nano_seconds gauge
208+
minio_usage_last_activity_nano_seconds{server="127.0.0.1:9000"} 5.6046668864e+10

0 commit comments

Comments
 (0)
Please sign in to comment.