AIS CLI show command can universally be used to view summaries and details on a cluster and its nodes, buckets and objects, running and finished jobs - in short, all managed entities (see below).
The command is a “hub” for all information-viewing commands that are currently supported:
For easy usage, all show commands have been aliased to their respective top-level counterparts:
is equivalent to:
For instance,
ais show performanceis an alias forais performance- both can be used interchangeably.
As a general rule, instead of remembering any of the above (as well as any of the below), type (e.g.)
ais perf<TAB-TAB>and pressEnter.
You can also hit <TAB-TAB>` maybe a few more times while typing a few more letters in between. Any combination will work.
When part-typing, part-TABing a sequence of words that (will eventually) constitute a valid AIS CLI command, type
--helpat any time. This will display short description, command-line options, usage examples, and other context-sensitive information.
For usage examples, another way to quickly find them would be a good-and-old keyword search. E.g.,
cd aistore; grep -n "ais.*cp" docs/cli/*.md, and similar. Additional useful tricks (includingais search) are also mentioned elsewhere in the documentation.
As far as ais show, the command currently extends as follows:
In other words, there are currently 12 subcommands that are briefly described in the rest of this text.
ais show performanceais show jobais show clusterais show dashboardais show authais show bucketais show objectais show storageais show configais show remote-clusterais show rebalanceais show logais show performanceThe command has 5 subcommands:
The command provides a quick single-shot overview of cluster performance. If you type ais show performance and instead of <TAB-TAB> hit Enter, the command will show performance counters, aggregated cluster throughput statistics, and the other 3 tables (latency, capacity, disk IO) - in sequence, one after another.
The command’s help screen follows below - notice the command-line options (aka flags):
As one would maybe expect, --refresh, --units and all the other listed flags universally work across all performance subcommands.
For instance, you could continuously run several screens to simultaneously display a variety of performance-related aspects:
and so on - all the 5 tables with 5-seconds periodicity, or any other time interval(s) of your choosing.
As far as continuous monitoring goes, this (approach) has a chance to provide a good overall insight. A poor-man’s addition, if you will, to the popular (and also supported) tools such as Grafana and Prometheus. But available with zero setup out of the box (which is a plus).
Use ais show performance and its variations in combination with ais show job (and variations). The latter shows what’s running in the cluster, and thus combining the two may make sense.
ais show jobThe command has no statically defined subcommands. When you type ais show job <TAB-TAB>, the resulting set of shell completions will only include job names (aka “kinds”) that are currently running. Example:
Just maybe to reiterate the same slightly differently: ais show job <TAB-TAB> won’t produce anything useful iff the cluster currently doesn’t run any jobs
On the other hand, job-identifying selections [NAME] [JOB_ID] [NODE_ID] [BUCKET]:
Example:
is the same as:
In both cases, we are asking a specific target node (denoted as NODE_ID in the command’s help) for a specific job ID (denoted as JOB_ID).
Selection-wise, this would be the case of ultimate specificity. Accordingly, on the opposite side of the spectrum would be something like:
The --all flag always defines the broadest scope possible, and so the query ais show job --all includes absolutely all jobs, running and finished (succeeded and aborted).
Here’s at a glance:
Here and elsewhere in the documentation, CLI colors used to highlight certain (notable) items on screen - are not shown.
On a related note: coloring can be disabled via
ais config cli set no_color.
xaction vs jobais job commanddsort (distributed shuffle)download from any remote sourcerebalanceais show clusterThe first command to think of when deploying a new cluster. Useful as well when looking for the shortest quickest summary of what’s running and what’s going on. The subcommands and brief description follows:
AIS_ENDPOINTis part of theAIS_**environment.
AIS_ENDPOINTcan point to any AIS gateway (proxy) in a given cluster. Does not necessarily have to be the primary gateway.
For CLI, in particular,
AIS_ENDPOINToverrides cluster’s endpoint that’s currently configured. To view or change the configured endpoint (or any other CLI configuration item), runais config cli.
ais show dashboardThe ais show dashboard command provides comprehensive cluster analytics and health monitoring. Unlike the basic ais show cluster command which shows node tables and basic summary, this command focuses on detailed analytics including storage metrics, performance indicators, error tracking, and system health.
The command provides a comprehensive view of your cluster’s health and performance:
Performance and Health Section:
Cluster Section:
When cluster issues are detected, use the --verbose flag for a detailed breakdown:
Use the --refresh flag for continuous monitoring:
ais show authThe following subcommands are currently supported:
Refer to ais auth documentation for details and examples.
ais show bucketShow bucket properties.
Refer to ais bucket documentation for details and examples.
ais show objectShow object details.
Refer to ais object documentation for details and examples.
ais show storageShow storage usage and utilization in the cluster. Show disks and mountpaths - for a single selected node or for all storage nodes.
When run with no subcommands, ais show storage defaults to ais show storage disk.
In addition, the command support the following subcommands:
And with brief subcommand descriptions:
Refer to ais storage documentation for details and examples.
ais show configShow daemon configuration.
Refer to ais cluster documentation for details and examples.
ais show remote-clusterShow information about attached AIS clusters.
Refer to ais cluster documentation for details and examples.
ais show rebalanceDisplay details about the most recent rebalance xaction.
ais show logThere are 3 enumerated log severities and, respectively, 3 types of logs generated by each node:
By default, ais show log shows “info” log (that also contains all warnings and errors).
To show only errors, run:
For warnings and errors, run: