Project: YugabyteDB (App Definition and Development / Database)
File: managed-cli-metrics-exporter.md

title: ybm CLI metrics-exporter resource headerTitle: ybm metrics-exporter linkTitle: metrics-exporter description: YugabyteDB Managed CLI reference metrics-exporter resource. headcontent: Manage metrics export configuration menu: preview_yugabyte-cloud: identifier: managed-cli-metrics-exporter parent: managed-cli-reference weight: 20 type: docs Use the `metrics-exporter` resource to create metrics export configurations for third-party tools, and assign them to clusters. ```text Usage: ybm metrics-exporter [command] [flags] ``` Create a configuration: ```sh ybm metrics-exporter create \ --config-name datadog1 \ --type DATADOG \ --datadog-spec api-key=efXXXXXXXXXXXXXXXXXXXXXXXXXXXXee,site=US1 ``` Assign the configuration to a cluster: ```sh ybm metrics-exporter attach \ --config-name datadog1 \ --cluster-name my_cluster ``` 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 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.<br>Arguments:<ul><li>api-key - your Datadog API key.</li><li>site - your Datadog site parameters.</li></ul> | | --grafana-spec | Required for type GRAFANA. The Grafana Cloud export details, provided as key-value pairs.<br>Arguments:<ul><li>access-policy-token - your Grafana Cloud token.</li><li>org-slug - your organization name.</li><li>instance-id - your Grafana Cloud instance ID.</li><li>zone - your Grafana Cloud instance zone.</li></ul> | | --sumologic-spec | Required for type SUMOLOGIC. The Sumo Logic export details, provided as key-value pairs.<br>Arguments:<ul><li>access-key - your Sumo Logic access key.</li><li>access-id - your Sumo Logic access ID.</li><li>installation-token - your Sumo Logic installation token.</li></ul> | 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 a specified export configuration. | Flag | Description | | : | : | | --config-name | Required. Name of the export configuration. | List the export configurations. Pause the export of metrics from the specified cluster. | Flag | Description | | : | : | | --cluster-name | Required. Name of the cluster. | Remove the export configuration from the specified cluster. | Flag | Description | | : | : | | --cluster-name | Required. Name of the cluster. | 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.<br>Arguments:<ul><li>api-key - your Datadog API key.</li><li>site - your Datadog site parameters.</li></ul> | | --grafana-spec | Required for type GRAFANA. The Grafana Cloud export details, provided as key-value pairs.<br>Arguments:<ul><li>access-policy-token - your Grafana Cloud token.</li><li>org-slug - your organization name.</li><li>instance-id - your Grafana Cloud instance ID.</li><li>zone - your Grafana Cloud instance zone.</li></ul> | | --sumologic-spec | Required for type SUMOLOGIC. The Sumo Logic export details, provided as key-value pairs.<br>Arguments:<ul><li>access-key - your Sumo Logic access key.</li><li>access-id - your Sumo Logic access ID.</li><li>installation-token - your Sumo Logic installation token.</li></ul> |