mirror of
https://github.com/minio/docs.git
synced 2025-07-31 18:04:52 +03:00
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
This commit is contained in:
@ -87,30 +87,3 @@ Healing metrics
|
|||||||
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.
|
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.
|
||||||
|
|
||||||
Refer to the :ref:`minio-metrics-and-alerts` for more information on available endpoints and configuration.
|
Refer to the :ref:`minio-metrics-and-alerts` for more information on available endpoints and configuration.
|
||||||
|
|
||||||
.. _minio-concepts-healing-colors:
|
|
||||||
|
|
||||||
Healing Output Color Key
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
Earlier MinIO versions generated a table with green, yellow, red, and gray colors to indicate the healing status of individual objects.
|
|
||||||
These colors have been deprecated in favor of more detailed :ref:`healing metrics available at the cluster level <minio-metrics-and-alerts-available-metrics>`.
|
|
||||||
|
|
||||||
The following table describes the meaning of the now-deprecated status colors.
|
|
||||||
|
|
||||||
.. list-table::
|
|
||||||
:widths: 25 75
|
|
||||||
:width: 100%
|
|
||||||
|
|
||||||
* - **Green**
|
|
||||||
- *Healthy*, the object has all data and parity shards available as required to serve the object
|
|
||||||
|
|
||||||
* - **Yellow**
|
|
||||||
- *Healing*, the object is still in the process of healing, and there are sufficient data or parity shards available to complete the healing
|
|
||||||
|
|
||||||
* - **Red**
|
|
||||||
- *Unhealthy*, the object has lost one or more shards and requires healing
|
|
||||||
|
|
||||||
* - **Grey**
|
|
||||||
- *Unrecoverable*, the object has lost too many data and/or parity shards and cannot be healed or recovered
|
|
||||||
|
|
||||||
|
@ -81,8 +81,18 @@ Syntax
|
|||||||
Show information about offline and faulty healing drives.
|
Show information about offline and faulty healing drives.
|
||||||
|
|
||||||
|
|
||||||
|
.. _minio-concepts-healing-colors:
|
||||||
|
|
||||||
Healing Colors
|
Healing Colors
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
Some versions of MinIO used a color key as a way to differentiate objects with different healing statuses.
|
Some versions of MinIO used a color key as a way to differentiate objects with different healing statuses.
|
||||||
For details of this key, see the :ref:`Healing <minio-concepts-healing-colors>` concept page.
|
|
||||||
|
.. versionchanged:: mc RELEASE.2024-11-17T19-35-25Z
|
||||||
|
|
||||||
|
The color meaning has been updated.
|
||||||
|
|
||||||
|
- Green indicates the bucket is healthy.
|
||||||
|
- Yellow indicates the bucket requires healing on one or more drives.
|
||||||
|
- Red indicates one or more drives are unhealthy.
|
||||||
|
- Grey indicates an indeterminate healing state.
|
@ -38,7 +38,12 @@ Exercise caution before sending a report to a third party or posting the report
|
|||||||
.. versionchanged:: RELEASE.2022-12-12T19-27-27Z
|
.. versionchanged:: RELEASE.2022-12-12T19-27-27Z
|
||||||
|
|
||||||
When writing the zip archive, MinIO also encrypts the zip index of file names included in the archive.
|
When writing the zip archive, MinIO also encrypts the zip index of file names included in the archive.
|
||||||
|
|
||||||
|
.. versionchanged:: RELEASE.2024-10-29T15-34-59Z
|
||||||
|
|
||||||
|
Inspect now generates unique file names to help distinguish one inspect file from another.
|
||||||
|
The file name reflects the inspected path.
|
||||||
|
|
||||||
.. important::
|
.. important::
|
||||||
|
|
||||||
:mc:`mc support inspect` requires a MinIO deployment server from October 2021 or later.
|
:mc:`mc support inspect` requires a MinIO deployment server from October 2021 or later.
|
||||||
|
121
source/reference/minio-mc/mc-support-top-rpc.rst
Normal file
121
source/reference/minio-mc/mc-support-top-rpc.rst
Normal file
@ -0,0 +1,121 @@
|
|||||||
|
=======================
|
||||||
|
``mc support top rpc``
|
||||||
|
=======================
|
||||||
|
|
||||||
|
.. default-domain:: minio
|
||||||
|
|
||||||
|
.. contents:: Table of Contents
|
||||||
|
:local:
|
||||||
|
:depth: 2
|
||||||
|
|
||||||
|
.. mc:: mc support top rpc
|
||||||
|
|
||||||
|
.. include:: /includes/common-mc-support.rst
|
||||||
|
:start-after: start-minio-only
|
||||||
|
:end-before: end-minio-only
|
||||||
|
|
||||||
|
Syntax
|
||||||
|
------
|
||||||
|
|
||||||
|
.. start-mc-support-top-rpc-desc
|
||||||
|
|
||||||
|
The :mc:`mc support top rpc` command displays metrics for remote procedure calls (RPC).
|
||||||
|
|
||||||
|
.. end-mc-support-top-rpc-desc
|
||||||
|
|
||||||
|
.. tab-set::
|
||||||
|
|
||||||
|
.. tab-item:: EXAMPLE
|
||||||
|
|
||||||
|
The following command displays the current remote procedure call metrics for the :term:`alias` ``myminio`` deployment.
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc support top rpc myminio/
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
The output resembles
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
λ mc support top rpc myminio
|
||||||
|
SERVER CONCTD PING PONG OUT.Q RECONNS STR.IN STR.OUT MSG.IN MSG.OUT
|
||||||
|
To 127.0.0.1:9002 5 0.7ms 1s ago 0 0 ->0 0-> 3269 3212
|
||||||
|
From 127.0.0.1:9002 5 1.1ms 1s ago 0 0 ->0 0-> 3213 3269
|
||||||
|
To 127.0.0.1:9003 5 0.6ms 1s ago 0 0 ->0 0-> 6001 6076
|
||||||
|
From 127.0.0.1:9003 5 0.6ms 1s ago 0 0 ->0 0-> 6077 6001
|
||||||
|
To 127.0.0.1:9004 5 0.6ms 1s ago 0 0 ->0 0-> 3243 3160
|
||||||
|
From 127.0.0.1:9004 5 0.4ms 1s ago 0 0 ->0 0-> 3161 3243
|
||||||
|
To 127.0.0.1:9005 5 0.6ms 1s ago 0 0 ->0 0-> 3150 3094
|
||||||
|
From 127.0.0.1:9005 5 0.3ms 1s ago 0 0 ->0 0-> 3095 3150
|
||||||
|
To 127.0.0.1:9006 5 0.3ms 1s ago 0 0 ->0 0-> 3185 3221
|
||||||
|
From 127.0.0.1:9006 5 0.6ms 1s ago 0 0 ->0 0-> 3222 3185
|
||||||
|
|
||||||
|
.. tab-item:: SYNTAX
|
||||||
|
|
||||||
|
The command has the following syntax:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc [GLOBALFLAGS] support top rpc \
|
||||||
|
[--airgap] \
|
||||||
|
[--in value] \
|
||||||
|
[--interval value] \
|
||||||
|
[-n value] \
|
||||||
|
[--nodes value] \
|
||||||
|
TARGET
|
||||||
|
|
||||||
|
.. include:: /includes/common-minio-mc.rst
|
||||||
|
:start-after: start-minio-syntax
|
||||||
|
:end-before: end-minio-syntax
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
|
.. mc-cmd:: TARGET
|
||||||
|
:required:
|
||||||
|
|
||||||
|
The full path to the :ref:`alias <minio-mc-alias>` or :term:`prefix` where the command should run.
|
||||||
|
|
||||||
|
.. mc-cmd:: --airgap
|
||||||
|
:optional:
|
||||||
|
|
||||||
|
Use in environments without network access to SUBNET.
|
||||||
|
|
||||||
|
.. mc-cmd:: --in
|
||||||
|
:optional:
|
||||||
|
|
||||||
|
Replay a previously saved JSON file.
|
||||||
|
Specify the path to the JSON file to replay, such as one generated by a previous run of this command.
|
||||||
|
|
||||||
|
.. mc-cmd:: --interval
|
||||||
|
:optional:
|
||||||
|
|
||||||
|
The interval in seconds between metric requests.
|
||||||
|
|
||||||
|
By default, the command requests metrics every second.
|
||||||
|
|
||||||
|
.. mc-cmd:: -n
|
||||||
|
:optional:
|
||||||
|
|
||||||
|
The number of requests to run before existing.
|
||||||
|
Use ``0`` for endless.
|
||||||
|
|
||||||
|
If not specified, the command does not automatically exit.
|
||||||
|
|
||||||
|
.. mc-cmd:: --nodes
|
||||||
|
:optional:
|
||||||
|
|
||||||
|
Comma-separated list of the node or nodes from which to collect metrics.
|
||||||
|
|
||||||
|
|
||||||
|
Global Flags
|
||||||
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. include:: /includes/common-minio-mc.rst
|
||||||
|
:start-after: start-minio-mc-globals
|
||||||
|
:end-before: end-minio-mc-globals
|
||||||
|
|
@ -40,6 +40,7 @@ MinIO deployments, similar to the output of the ``top`` command in a shell.
|
|||||||
- :mc-cmd:`~mc support top locks`
|
- :mc-cmd:`~mc support top locks`
|
||||||
- :mc-cmd:`~mc support top disk`
|
- :mc-cmd:`~mc support top disk`
|
||||||
- :mc-cmd:`~mc support top net`
|
- :mc-cmd:`~mc support top net`
|
||||||
|
- :mc-cmd:`~mc support top rpc`
|
||||||
|
|
||||||
Refer to the pages linked above for each subcommand for details.
|
Refer to the pages linked above for each subcommand for details.
|
||||||
|
|
||||||
@ -59,4 +60,5 @@ The command has the following syntax:
|
|||||||
/reference/minio-mc/mc-support-top-api
|
/reference/minio-mc/mc-support-top-api
|
||||||
/reference/minio-mc/mc-support-top-locks
|
/reference/minio-mc/mc-support-top-locks
|
||||||
/reference/minio-mc/mc-support-top-disk
|
/reference/minio-mc/mc-support-top-disk
|
||||||
/reference/minio-mc/mc-support-top-net
|
/reference/minio-mc/mc-support-top-net
|
||||||
|
/reference/minio-mc/mc-support-top-rpc
|
Reference in New Issue
Block a user