postgresql_metrics

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

Overview

Name	postgresql_metrics
Type	Resource
Id	ovh.public_cloud_database.postgresql_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 host in the cluster
unit	string	Unit of the metric values (BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, MEGABYTES, MEGABYTES_PER_SECOND, MILLISECONDS, PERCENT, SCALAR, SCALAR_PER_SECOND, SECONDS, UNKNOWN)

list

Metric data for a managed database service

Name	Datatype	Description
name	string	Name of the metric
metrics	array	Metric values for each host in the cluster
unit	string	Unit of the metric values (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	metric_name, service_id, project_id	period	Returns the values of a metric for each node of the service, over the requested period. (Beta version)
list	select	service_id, project_id	x_pagination_cursor, x_pagination_size, extended	Returns the metrics available for the service. Set extended to true to include engine-specific metrics. (Beta version)

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"}})
metric_name	string	Metric name (wire: metricName)
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
service_id	string (uuid)	Service ID (wire: serviceId)
extended	boolean	Display engine-specific metrics
period	string	Time period over which to retrieve metric values
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the values of a metric for each node of the service, over the requested period. (Beta version)

SELECT
name,
metrics,
unit
FROM ovh.public_cloud_database.postgresql_metrics
WHERE metric_name = '{{ metric_name }}' -- required
AND service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND period = '{{ period }}'
;

list

Returns the metrics available for the service. Set extended to true to include engine-specific metrics. (Beta version)

SELECT
name,
metrics,
unit
FROM ovh.public_cloud_database.postgresql_metrics
WHERE service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND extended = '{{ extended }}'
;