`bm admin prometheus metrics`

Description

The bm admin prometheus metrics command prints Prometheus metrics for a cluster.

The output includes additional information about each metric, such as if its value is a counter or gauge.

For more complete documentation on using Buckit with Prometheus, see How to monitor Buckit server with Prometheus

Metrics version 3 (v3) provides additional endpoints and metrics. To print v3 metrics use the --api_version v3 option.

Buckit recommends new deployments use version 3 (v3). Existing deployments can continue to use metrics version 2

Use bm admin on Buckit Deployments Only

Buckit does not support using bm admin commands with other S3-compatible services, regardless of their claimed compatibility with Buckit deployments.

EXAMPLE

The following command prints cluster metrics from the deployment at alias mybuckit:

bm admin prometheus metrics mybuckit cluster

SYNTAX

The command has the following syntax:

bm [GLOBALFLAGS] admin prometheus metrics  \
                                  ALIAS                                           \
                                  [TYPE]                                          \
                                  [--api_version v3]                              \
                                  [--bucket <bucket name>]

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS: Required
The alias of a configured Buckit deployment for which the command prints metrics.

--api-version

Optional

To print version 3 (v3) metrics, include an --api-version v3 parameter. v3 is the only accepted value.

Omit --api-version to print version 2 (v2) metrics.

--bucket

Optional

Requires --api-version. For v3 metric types that return bucket-level metrics, specify a bucket name.

--bucket works for the following v3 metric types:

api
replication

The following example prints API metrics for the bucket mybucket:

bm admin prometheus metrics ALIAS api --bucket mybucket --api-version v3

TYPE

Optional

The type of metrics to print.

Valid values for metrics version 3 are:

api

audit

cluster

debug

ilm

logger

notification

replication

scanner

system

If not specified, a v3 command returns all metrics.

Valid values for metrics version 2 are:

bucket

cluster

node

resource

If not specified, a v2 command returns cluster metrics. Cluster metrics include rollups of certain node metrics.

Global flags

This command supports any of the global flags.

Examples

Print v3 metrics

Use bm admin prometheus metrics --api-version v3 to print all available v3 metrics and their current values for a Buckit deployment:

bm admin prometheus metrics ALIAS --api-version v3

Replace ALIAS with the alias of the Buckit deployment.

To print a specific type of metrics, include the TYPE. The following prints all scanner metrics for a deployment:

bm admin prometheus metrics ALIAS scanner --api-version v3

Print v3 API or bucket replication metrics

Certain v3 metric types accept a --bucket parameter to specify the bucket for which to print metrics. The following example prints v3 replication metrics for bucket mybucket:

bm admin prometheus metrics ALIAS replication --bucket mybucket --api-version v3

Replace ALIAS with the alias of the Buckit deployment.

To print API metrics for the bucket, replace replication with api.

Print v2 cluster metrics

By default, bm admin prometheus metrics prints v2 cluster metrics:

bm admin prometheus metrics ALIAS

Replace ALIAS with the alias of the Buckit deployment.

Print other types of v2 metrics

To print another type of v2 metrics, specify the desired TYPE. The following example prints v2 bucket metrics:

bm admin prometheus metrics ALIAS bucket

Accepted values are bucket, cluster, node, and resource.