Skip to content

Commit

Permalink
Updates for mc 2024-06-04 release (#1241)
Browse files Browse the repository at this point in the history
Corrects mc batch examples
Closes #1235

Applies changes to the mc admin trace --stat flag in mc
RELEASE.2024-06-05T18-13-30Z. That change has no tracking docs issue.
  • Loading branch information
djwfyi authored Jun 11, 2024
1 parent 0441711 commit d3eac20
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 23 deletions.
38 changes: 23 additions & 15 deletions source/reference/minio-mc-admin/mc-admin-trace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ Syntax

.. mc-cmd:: --call

Traces only matching call types.
For example, the following command only traces calls of the type ``scanner``.
Traces only matching client operation or call types.
For example, the following command only traces operations of the type ``scanner``.

.. code-block:: shell
Expand Down Expand Up @@ -145,19 +145,19 @@ Syntax

.. mc-cmd:: --filter-request

Trace calls with request size greater than the specified :mc-cmd:`~mc admin trace --filter-size` value.
Trace client operations or calls with request size greater than the specified :mc-cmd:`~mc admin trace --filter-size` value.

Must be used with :mc-cmd:`~mc admin trace --filter-size` flag.

.. mc-cmd:: --filter-response

Trace calls with response size greater than the specified :mc-cmd:`~mc admin trace --filter-size` value.
Trace client operations or calls with response size greater than the specified :mc-cmd:`~mc admin trace --filter-size` value.

Must be used with :mc-cmd:`~mc admin trace --filter-size` flag.

.. mc-cmd:: --filter-size

Size limit of a filtered call.
Size limit of a filtered client operation or call.

Must be used with either :mc-cmd:`~mc admin trace --filter-request` or :mc-cmd:`~mc admin trace --filter-response` flag.

Expand Down Expand Up @@ -246,38 +246,46 @@ Syntax
:widths: 30 70

* - Call
- The name of the captured function.
- The name of the captured client operation or function.

* - Count
- The number of times the Call occurred.
- The number of times the client operation or call occurred.

* - RPM
- The Rate Per Minute (RPM) of that Call.
- The Rate Per Minute (RPM) of the client operation or call.

* - Avg Time
- The average time required for the Call to complete.
- The average time required for the client operation or call to complete.

* - Min Time
- The minimum time spent for the Call to complete.
- The minimum time spent for the client operation or call to complete.

* - Max Time
- The maximum time spent for the client operation or call to complete.

* - Avg TTFB
- .. versionadded:: RELEASE.2023-11-15T22-45-58Z

The average Time To First Byte (TTFB) for the Call.
The average Time To First Byte (TTFB) for the client operation or call response.

* - Max TTFB
- .. versionadded:: RELEASE.2023-11-15T22-45-58Z

The maximum Time To First Byte for the Call.
The maximum Time To First Byte for the client operation or call response.

* - Avg Size
- Average size of client operation or call responses.

* - Errors
- The number of Calls that failed with an error.
- The number of client operations or calls that failed with an error.

* - RX Avg
- The average number of Bytes Received (RX) for the Call.
- The average number of Bytes Received (RX) for the client operation or call.
This stat only displays if not zero (0).

* - TX AVG
- The average number of Bytes Sent (TX) for the Call.
- The average number of Bytes Sent (TX) for the client operation or call.
This stat only displays if not zero (0).

Accumulate stats, such as name, count, duration, min time, max time, time to first byte, or errors.
Accumulates up to 15 stat entries.
Expand Down
4 changes: 2 additions & 2 deletions source/reference/minio-mc/mc-batch-cancel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To find the job ID, use :mc-cmd:`mc batch list`.
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] batch cancel TARGET JOBID
mc [GLOBALFLAGS] batch cancel ALIAS JOBID
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
Expand All @@ -53,7 +53,7 @@ To find the job ID, use :mc-cmd:`mc batch list`.
Parameters
~~~~~~~~~~

.. mc-cmd:: TARGET
.. mc-cmd:: ALIAS
:required:

The :ref:`alias <alias>` for the MinIO deployment on which the job is currently running.
Expand Down
6 changes: 3 additions & 3 deletions source/reference/minio-mc/mc-batch-generate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ See :ref:`job types <minio-batch-job-types>` for the supported jobs you can gene
.. code-block:: shell
:class: copyable
mc batch generate myminio/mybucket replicate
mc batch generate myminio replicate
.. tab-item:: SYNTAX

Expand All @@ -47,7 +47,7 @@ See :ref:`job types <minio-batch-job-types>` for the supported jobs you can gene
:class: copyable
mc [GLOBALFLAGS] batch generate \
TARGET \
ALIAS \
JOBTYPE
.. include:: /includes/common-minio-mc.rst
Expand All @@ -57,7 +57,7 @@ See :ref:`job types <minio-batch-job-types>` for the supported jobs you can gene
Parameters
~~~~~~~~~~

.. mc-cmd:: TARGET
.. mc-cmd:: ALIAS
:required:

The :ref:`alias <alias>` used to generate the YAML template file.
Expand Down
6 changes: 3 additions & 3 deletions source/reference/minio-mc/mc-batch-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To run the batch job again after completion, you must start it again.
.. code-block:: shell
:class: copyable
mc batch start myminio/mybucket jobfile.yaml
mc batch start myminio jobfile.yaml
The output of the above command is something similar to:

Expand All @@ -51,7 +51,7 @@ To run the batch job again after completion, you must start it again.
:class: copyable
mc [GLOBALFLAGS] batch start \
TARGET \
ALIAS \
JOBFILE
.. include:: /includes/common-minio-mc.rst
Expand All @@ -61,7 +61,7 @@ To run the batch job again after completion, you must start it again.
Parameters
~~~~~~~~~~

.. mc-cmd:: TARGET
.. mc-cmd:: ALIAS
:required:

The :ref:`alias <alias>` on which to start the batch job.
Expand Down

0 comments on commit d3eac20

Please sign in to comment.