ybm metrics-exporter

Manage metrics export configuration

Use the metrics-exporter resource to create metrics export configurations for third-party tools, and assign them to clusters.

Syntax

Usage: ybm metrics-exporter [command] [flags]

Example

Create a configuration:

ybm metrics-exporter create \
    --config-name datadog1 \
    --type DATADOG \
    --datadog-spec api-key=efXXXXXXXXXXXXXXXXXXXXXXXXXXXXee,site=US1

Assign the configuration to a cluster:

ybm metrics-exporter attach \
    --config-name datadog1 \
    --cluster-name my_cluster

Commands

assign

Assign an export configuration to the specified cluster.

Flag Description
--cluster-name Required. Name of the cluster.
--config-name Required. Name of the export configuration.

create

Create an export configuration.

Flag Description
--config-name Required. Name for the export configuration.
--type Required. The third party tool to export metrics to. Options: DATADOG, GRAFANA, SUMOLOGIC.
--datadog-spec Required for type DATADOG. The Datadog export details, provided as key-value pairs.
Arguments:
  • api-key - your Datadog API key.
  • site - your Datadog site parameters.
--grafana-spec Required for type GRAFANA. The Grafana Cloud export details, provided as key-value pairs.
Arguments:
  • access-policy-token - your Grafana Cloud token.
  • org-slug - your organization name.
  • instance-id - your Grafana Cloud instance ID.
  • zone - your Grafana Cloud instance zone.
--sumologic-spec Required for type SUMOLOGIC. The Sumo Logic export details, provided as key-value pairs.
Arguments:
  • access-key - your Sumo Logic access key.
  • access-id - your Sumo Logic access ID.
  • installation-token - your Sumo Logic installation token.

delete

Delete a specified export configuration. You can't delete configurations that are in use by a cluster.

Flag Description
--config-name Required. Name of the export configuration.

describe

Describe a specified export configuration.

Flag Description
--config-name Required. Name of the export configuration.

list

List the export configurations.

pause

Pause the export of metrics from the specified cluster.

Flag Description
--cluster-name Required. Name of the cluster.

unassign

Remove the export configuration from the specified cluster.

Flag Description
--cluster-name Required. Name of the cluster.

update

Update an export configuration.

Flag Description
--config-name Required. Name of the export configuration.
--new-config-name New name for the export configuration.
--type Required. The third party tool to exported metrics to. Options: DATADOG, GRAFANA, SUMOLOGIC.
--datadog-spec Required for type DATADOG. The Datadog export details, provided as key-value pairs.
Arguments:
  • api-key - your Datadog API key.
  • site - your Datadog site parameters.
--grafana-spec Required for type GRAFANA. The Grafana Cloud export details, provided as key-value pairs.
Arguments:
  • access-policy-token - your Grafana Cloud token.
  • org-slug - your organization name.
  • instance-id - your Grafana Cloud instance ID.
  • zone - your Grafana Cloud instance zone.
--sumologic-spec Required for type SUMOLOGIC. The Sumo Logic export details, provided as key-value pairs.
Arguments:
  • access-key - your Sumo Logic access key.
  • access-id - your Sumo Logic access ID.
  • installation-token - your Sumo Logic installation token.