1
0
mirror of https://github.com/minio/docs.git synced 2025-09-10 20:12:12 +03:00
Files
docs/source/reference/minio-mc/mc-support-top.rst
Daryl White 6482571bf2 Update mc reference docs for improved nav structure (#717)
- Adds landing pages for all two-word `mc` commands
- Nests three+ word commands under appropriate two-word commands
- Updates MinIO Client doc
- Uses description from each command to populate list of subcommand
descriptions
- Modifies toctree for MinIO Client doc and each command/subcommand to
improve left nav experienc

Closes #710
2023-02-02 16:52:36 -06:00

56 lines
1.1 KiB
ReStructuredText

==================
``mc support top``
==================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc support top
.. note::
.. versionchanged:: RELEASE.2022-08-11T00-30-48Z
``mc support top`` replaces the ``mc admin top`` command.
Description
-----------
.. start-mc-support-top-desc
The :mc:`mc support top` command returns statistics for distributed
MinIO deployments, similar to the output of the ``top`` command in a shell.
.. end-mc-support-top-desc
.. note::
:mc:`mc support top` is not supported on single-node single-drive MinIO deployments.
:mc-cmd:`mc support top` has the following subcommands:
- :mc-cmd:`~mc support top api`
- :mc-cmd:`~mc support top locks`
- :mc-cmd:`~mc support top disk`
Refer to the pages linked above for each subcommand for details.
Syntax
------
The command has the following syntax:
.. code-block:: shell
mc support top COMMAND [COMMAND FLAGS] [ARGUMENTS ...]
.. toctree::
:titlesonly:
:hidden:
/reference/minio-mc/mc-support-top-api
/reference/minio-mc/mc-support-top-locks
/reference/minio-mc/mc-support-top-disk