minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-05-03 18:04:53 +03:00
Code
docs/source/reference/minio-mc/mc-support-perf.rst
Daryl White 0cd491c328
Mc updates for multiple releases (#642) 
Updates `mc` reference docs for several releases of the MinIO Client.

- Adds missing flags to `mc admin trace`
- Updates `disk` -> `drive` throughout the docs, but not in all cases.
- Adds `--airgap flag` to `mc support profile` and `mc support perf`
commands.
- Updates the flags for `mc ilm add` command
- Adds `mc license unregister` command.
    
Closes #571
Closes #614
Closes #627
Closes #633
2022-11-18 12:49:03 -06:00

6.8 KiB
Raw Blame History

mc support perf

minio

Table of Contents

mc support perf

Description

Use the mc support perf command to review the performance of the S3 API (read/write), network IO, and storage (drive read/write).

The resulting tests can provide general guidance of deployment performance under S3 GET and PUT requests and identify any potential bottlenecks.

For more complete performance testing, consider using a combination of load-testing using your staging application environments and the MinIO WARP S3 benchmarking tool.

mc support perf has three subcommands

  1. ~mc support perf drive

    Measure the speed of drives in a MinIO deployment.

  2. ~mc support perf object

    Measure the speed of reading and writing objects in a cluster.

  3. ~mc support perf net

    Measure the network throughput of all nodes.

Examples

Measure Speed of an Object

Measure the performance of S3 read/write of an object on the alias minio1. MinIO autotunes concurrency to obtain maximum throughput and IOPS (Input/Output Per Second).

mc support perf object minio1

Measure Speed of an Object of a Specific Size for a Specific Duration

Run object the S3 read/write performance of an object for 20 seconds with object size of 128MiB on alias minio1. MinIO autotunes concurrency to obtain maximum throughput.

mc support perf object minio1 --duration 20s --size 128MiB

Test Speed of All Drives on All Nodes with Default Specifications

Run drive read/write performance measurements on all drive on all nodes for a cluster with alias minio1. The command does not specify the blocksize, so the default of 4MiB is used.

mc support perf drive minio1

Test Drive Speed Measurements with Custom Specifications

Run drive read/write performance measurements on a cluster with alias minio1 specificying a blocksize of 64KiB and data read/written from each drive of 2GiB.

mc support perf drive minio1 --blocksize 64KiB --filesize 2GiB

Test Network Throughput

Run a network throughput test on a cluster with alias minio1.

mc support perf net minio1

Syntax

drive

Measure the read/write speed of the drives in a cluster.

mc [GLOBAL FLAGS] support perf drive   \
                [--concurrent]         \
                [--verbose, -v]        \
                [--filesize]           \
                [--blocksize]          \
                [--serial]             \
                [--airgap]             \
                ALIAS

object

Measure the S3 peformance of reading and writing objects in a cluster.

mc [GLOBAL FLAGS] support perf object  \
                [--duration]           \
                [--size]               \
                [--concurrent]         \
                [--verbose, -v]        \
                [--airgap]             \
                ALIAS

net

Measure the network throughput of all nodes in a cluster.

mc [GLOBAL FLAGS] support perf net  \
                [--concurrent]      \
                [--verbose, -v]     \
                [--serial]          \
                [--airgap]          \
                ALIAS

Parameters

--duration

Applies to the ~mc support perf object command.

Specify the duration for the performance tests to run.

If not specified, the default value is 10s.

Use --duration <value> where <value> is a number and a unit of s for seconds, m for minutes.

--airgap

Use in environments without network access to SUBNET (for example, airgapped, firewalled, or similar configuration).

If the deployment is airgapped, but the local device where you are using the minio client <minio-client> has network access, you do not need to use the --airgap flag.

--size

Applies to the ~mc support perf object command.

Specify the size of the object to use for upload and download performance test.

If not specified, the default value is 64MiB.

Use --size <value> where <value> is a number and the storage unit, KiB, MiB, or GiB.

--concurrent

Applies to the ~mc support perf drive, ~mc support perf object, and ~mc support perf net commands.

Specify the number of concurrent requests to test per server.

If not specified, the default value is 32.

Use --concurrent <value> where <value> is a number.

--verbose

Applies to the ~mc support perf drive, ~mc support perf object, and ~mc support perf net commands.

Show per-server stats in the output.

--filesize

Applies to the ~mc support perf drive command.

Specify the total size of data to read or write to each drive.

If not specified, the default value is 1GiB.

Use --filesize <value> where <value> is a number and storage unit, KiB, MiB, or GiB.

--blocksize

Applies to the ~mc support perf drive command.

Specify the read/write block size.

If not specified, the default value is 4MiB.

Use --filesize <value> where <value> is a number and a storage unit, using standard storage unit abbreviations.

--serial

Applies to the ~mc support perf drive and ~mc support perf net commands.

Run performance tests on drive(s) one by one.

ALIAS

Applies to the ~mc support perf drive, ~mc support perf object, and ~mc support perf net commands.

The alias <alias> of the MinIO deployment.

Global Flags