Running yb_stats

Once yb_stats is installed, it can be used to get metadata from a YugabyteDB cluster and to create snapshots.

Before yb_stats can be used to create snapshots or perform ad-hoc operations, in other words query data from a YugabyteDB cluster, the addresses of the endpoints must be specified using the --hosts switch, and optionally the --ports switch if ports have been changed (see: Specifying hosts and Specifying ports), or the .env file should exist in the current working directory.

If yb_stats is run for obtaining data, which means running in ad-hoc mode, ad-hoc print mode or snapshot mode, it must be able to access the YugabyteDB cluster nodes, and be allowed to access the different ports.

If yb_stats is run for investigating snapshots using print mode or snapshot-diff mode, there is no need to access the cluster ip addresses or ports, it will use the snapshot CSV data only.

For a more comprehensive view into the objects in the cluster, as well as the tablets, the --extra-data switch can be used. This switch will obtain detailed data about objects as well as tablets, at the cost of performing more work, and thus taking longer time. See the --extra-data switch.