Skip to content

Commit 5006f1f

Browse files
djwfyidjwfyi
authored
MC updates for two releases. (#1382)
- Adds mc support top rpc command - Adds information about new mc support inspect file names Closes #1361 - Updates healing color meaning. Closes #1371
1 parent ace03e6 commit 5006f1f

File tree

5 files changed

+140
-29
lines changed

5 files changed

+140
-29
lines changed

‎source/operations/concepts/healing.rst‎

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -87,30 +87,3 @@ Healing metrics
8787
MinIO provides several `healing metrics <https://min.io/docs/minio/linux/operations/monitoring/metrics-and-alerts.html#healing-metrics>`__ to monitor the status of healing processes on a deployment.
8888

8989
Refer to the :ref:`minio-metrics-and-alerts` for more information on available endpoints and configuration.
90-
91-
.. _minio-concepts-healing-colors:
92-
93-
Healing Output Color Key
94-
------------------------
95-
96-
Earlier MinIO versions generated a table with green, yellow, red, and gray colors to indicate the healing status of individual objects.
97-
These colors have been deprecated in favor of more detailed :ref:`healing metrics available at the cluster level <minio-metrics-and-alerts-available-metrics>`.
98-
99-
The following table describes the meaning of the now-deprecated status colors.
100-
101-
.. list-table::
102-
:widths: 25 75
103-
:width: 100%
104-
105-
* - **Green**
106-
- *Healthy*, the object has all data and parity shards available as required to serve the object
107-
108-
* - **Yellow**
109-
- *Healing*, the object is still in the process of healing, and there are sufficient data or parity shards available to complete the healing
110-
111-
* - **Red**
112-
- *Unhealthy*, the object has lost one or more shards and requires healing
113-
114-
* - **Grey**
115-
- *Unrecoverable*, the object has lost too many data and/or parity shards and cannot be healed or recovered
116-

‎source/reference/minio-mc-admin/mc-admin-heal.rst‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,18 @@ Syntax
8181
Show information about offline and faulty healing drives.
8282

8383

84+
.. _minio-concepts-healing-colors:
85+
8486
Healing Colors
8587
--------------
8688

8789
Some versions of MinIO used a color key as a way to differentiate objects with different healing statuses.
88-
For details of this key, see the :ref:`Healing <minio-concepts-healing-colors>` concept page.
90+
91+
.. versionchanged:: mc RELEASE.2024-11-17T19-35-25Z
92+
93+
The color meaning has been updated.
94+
95+
- Green indicates the bucket is healthy.
96+
- Yellow indicates the bucket requires healing on one or more drives.
97+
- Red indicates one or more drives are unhealthy.
98+
- Grey indicates an indeterminate healing state.

‎source/reference/minio-mc/mc-support-inspect.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,12 @@ Exercise caution before sending a report to a third party or posting the report
3838
.. versionchanged:: RELEASE.2022-12-12T19-27-27Z
3939

4040
When writing the zip archive, MinIO also encrypts the zip index of file names included in the archive.
41+
42+
.. versionchanged:: RELEASE.2024-10-29T15-34-59Z
4143

44+
Inspect now generates unique file names to help distinguish one inspect file from another.
45+
The file name reflects the inspected path.
46+
4247
.. important::
4348

4449
:mc:`mc support inspect` requires a MinIO deployment server from October 2021 or later.

‎source/reference/minio-mc/mc-support-top-rpc.rst‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
=======================
2+
``mc support top rpc``
3+
=======================
4+
5+
.. default-domain:: minio
6+
7+
.. contents:: Table of Contents
8+
:local:
9+
:depth: 2
10+
11+
.. mc:: mc support top rpc
12+
13+
.. include:: /includes/common-mc-support.rst
14+
:start-after: start-minio-only
15+
:end-before: end-minio-only
16+
17+
Syntax
18+
------
19+
20+
.. start-mc-support-top-rpc-desc
21+
22+
The :mc:`mc support top rpc` command displays metrics for remote procedure calls (RPC).
23+
24+
.. end-mc-support-top-rpc-desc
25+
26+
.. tab-set::
27+
28+
.. tab-item:: EXAMPLE
29+
30+
The following command displays the current remote procedure call metrics for the :term:`alias` ``myminio`` deployment.
31+
32+
.. code-block:: shell
33+
:class: copyable
34+
35+
mc support top rpc myminio/
36+
37+
The output returns information such as the server, number of connections, length of ping, time since last ping (``pong``), reconnections, string in, string out, messages in, and messages out.
38+
39+
The output resembles
40+
41+
.. code-block:: bash
42+
43+
λ mc support top rpc myminio
44+
SERVER CONCTD PING PONG OUT.Q RECONNS STR.IN STR.OUT MSG.IN MSG.OUT
45+
To 127.0.0.1:9002 5 0.7ms 1s ago 0 0 ->0 0-> 3269 3212
46+
From 127.0.0.1:9002 5 1.1ms 1s ago 0 0 ->0 0-> 3213 3269
47+
To 127.0.0.1:9003 5 0.6ms 1s ago 0 0 ->0 0-> 6001 6076
48+
From 127.0.0.1:9003 5 0.6ms 1s ago 0 0 ->0 0-> 6077 6001
49+
To 127.0.0.1:9004 5 0.6ms 1s ago 0 0 ->0 0-> 3243 3160
50+
From 127.0.0.1:9004 5 0.4ms 1s ago 0 0 ->0 0-> 3161 3243
51+
To 127.0.0.1:9005 5 0.6ms 1s ago 0 0 ->0 0-> 3150 3094
52+
From 127.0.0.1:9005 5 0.3ms 1s ago 0 0 ->0 0-> 3095 3150
53+
To 127.0.0.1:9006 5 0.3ms 1s ago 0 0 ->0 0-> 3185 3221
54+
From 127.0.0.1:9006 5 0.6ms 1s ago 0 0 ->0 0-> 3222 3185
55+
56+
.. tab-item:: SYNTAX
57+
58+
The command has the following syntax:
59+
60+
.. code-block:: shell
61+
:class: copyable
62+
63+
mc [GLOBALFLAGS] support top rpc \
64+
[--airgap] \
65+
[--in value] \
66+
[--interval value] \
67+
[-n value] \
68+
[--nodes value] \
69+
TARGET
70+
71+
.. include:: /includes/common-minio-mc.rst
72+
:start-after: start-minio-syntax
73+
:end-before: end-minio-syntax
74+
75+
Parameters
76+
~~~~~~~~~~
77+
78+
.. mc-cmd:: TARGET
79+
:required:
80+
81+
The full path to the :ref:`alias <minio-mc-alias>` or :term:`prefix` where the command should run.
82+
83+
.. mc-cmd:: --airgap
84+
:optional:
85+
86+
Use in environments without network access to SUBNET.
87+
88+
.. mc-cmd:: --in
89+
:optional:
90+
91+
Replay a previously saved JSON file.
92+
Specify the path to the JSON file to replay, such as one generated by a previous run of this command.
93+
94+
.. mc-cmd:: --interval
95+
:optional:
96+
97+
The interval in seconds between metric requests.
98+
99+
By default, the command requests metrics every second.
100+
101+
.. mc-cmd:: -n
102+
:optional:
103+
104+
The number of requests to run before existing.
105+
Use ``0`` for endless.
106+
107+
If not specified, the command does not automatically exit.
108+
109+
.. mc-cmd:: --nodes
110+
:optional:
111+
112+
Comma-separated list of the node or nodes from which to collect metrics.
113+
114+
115+
Global Flags
116+
~~~~~~~~~~~~
117+
118+
.. include:: /includes/common-minio-mc.rst
119+
:start-after: start-minio-mc-globals
120+
:end-before: end-minio-mc-globals
121+

‎source/reference/minio-mc/mc-support-top.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ MinIO deployments, similar to the output of the ``top`` command in a shell.
4040
- :mc-cmd:`~mc support top locks`
4141
- :mc-cmd:`~mc support top disk`
4242
- :mc-cmd:`~mc support top net`
43+
- :mc-cmd:`~mc support top rpc`
4344

4445
Refer to the pages linked above for each subcommand for details.
4546

@@ -59,4 +60,5 @@ The command has the following syntax:
5960
/reference/minio-mc/mc-support-top-api
6061
/reference/minio-mc/mc-support-top-locks
6162
/reference/minio-mc/mc-support-top-disk
62-
/reference/minio-mc/mc-support-top-net
63+
/reference/minio-mc/mc-support-top-net
64+
/reference/minio-mc/mc-support-top-rpc

0 commit comments

Comments
 (0)