From 8fa8bce58d5a76852779f965833dd88b61ce5a07 Mon Sep 17 00:00:00 2001 From: Daryl White <53910321+djwfyi@users.noreply.github.com> Date: Thu, 5 Dec 2024 16:38:58 -0500 Subject: [PATCH] MC updates for two releases. - Adds mc support top rpc command - Adds information about new mc support inspect file names Closes #1361 - Updates healing color meaning. Closes #1371 --- .../minio-mc-admin/mc-admin-heal.rst | 10 +- .../reference/minio-mc/mc-support-inspect.rst | 5 + .../reference/minio-mc/mc-support-top-rpc.rst | 121 ++++++++++++++++++ source/reference/minio-mc/mc-support-top.rst | 4 +- 4 files changed, 138 insertions(+), 2 deletions(-) create mode 100644 source/reference/minio-mc/mc-support-top-rpc.rst diff --git a/source/reference/minio-mc-admin/mc-admin-heal.rst b/source/reference/minio-mc-admin/mc-admin-heal.rst index ea8505be3..46d2d9525 100644 --- a/source/reference/minio-mc-admin/mc-admin-heal.rst +++ b/source/reference/minio-mc-admin/mc-admin-heal.rst @@ -85,4 +85,12 @@ Healing Colors -------------- 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 ` concept page. + +.. versionchanged:: mc RELEASE.2024-11-17T19-35-25Z + +The color meaning has been updated. + +- Green indicates that all is okay with the bucket healing. +- Yellow indicates the bucket is missing from an expected drive. +- Red indicates a drive is in an unreadable state (for example, unformatted or offline). +- Grey indicates that MinIO cannot determine the healing status. \ No newline at end of file diff --git a/source/reference/minio-mc/mc-support-inspect.rst b/source/reference/minio-mc/mc-support-inspect.rst index 0e1dd491f..99b93296c 100644 --- a/source/reference/minio-mc/mc-support-inspect.rst +++ b/source/reference/minio-mc/mc-support-inspect.rst @@ -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 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:: :mc:`mc support inspect` requires a MinIO deployment server from October 2021 or later. diff --git a/source/reference/minio-mc/mc-support-top-rpc.rst b/source/reference/minio-mc/mc-support-top-rpc.rst new file mode 100644 index 000000000..1f15fd9ac --- /dev/null +++ b/source/reference/minio-mc/mc-support-top-rpc.rst @@ -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 ` 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. + +.. 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 + diff --git a/source/reference/minio-mc/mc-support-top.rst b/source/reference/minio-mc/mc-support-top.rst index 9073b85ce..926f7098c 100644 --- a/source/reference/minio-mc/mc-support-top.rst +++ b/source/reference/minio-mc/mc-support-top.rst @@ -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 disk` - :mc-cmd:`~mc support top net` +- :mc-cmd:`~mc support top rpc` 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-locks /reference/minio-mc/mc-support-top-disk - /reference/minio-mc/mc-support-top-net \ No newline at end of file + /reference/minio-mc/mc-support-top-net + /reference/minio-mc/mc-support-top-rpc \ No newline at end of file