kafka_mirror_maker_metrics

Creates, updates, deletes, gets or lists a kafka_mirror_maker_metrics resource.

Overview

Name	kafka_mirror_maker_metrics
Type	Resource
Id	ovh.cloud_database.kafka_mirror_maker_metrics

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of the metric
metrics	array	Metric values for each cluster's host
units	string	Unit of the metric (BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, MEGABYTES, MEGABYTES_PER_SECOND, MILLISECONDS, PERCENT, SCALAR, SCALAR_PER_SECOND, SECONDS, UNKNOWN)

list

Metric definition for cloud project databases

Name	Datatype	Description
name	string	Name of the metric
metrics	array	Metric values for each cluster's host
units	string	Unit of the metric (BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, MEGABYTES, MEGABYTES_PER_SECOND, MILLISECONDS, PERCENT, SCALAR, SCALAR_PER_SECOND, SECONDS, UNKNOWN)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, metric_name, period, service_name		Get the metric values for the kafkaMirrorMaker
list	select	cluster_id, service_name	extended, x_pagination_mode	List available metrics for the kafkaMirrorMaker

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
metric_name	string	Metric name (wire: metricName)
period	string	The period of time to query metrics for
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
extended	boolean	Display DB specific metrics
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get the metric values for the kafkaMirrorMaker

SELECT
name,
metrics,
units
FROM ovh.cloud_database.kafka_mirror_maker_metrics
WHERE cluster_id = '{{ cluster_id }}' -- required
AND metric_name = '{{ metric_name }}' -- required
AND period = '{{ period }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List available metrics for the kafkaMirrorMaker

SELECT
name,
metrics,
units
FROM ovh.cloud_database.kafka_mirror_maker_metrics
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND extended = '{{ extended }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;