statistics

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

Overview

Name	statistics
Type	Resource
Id	ovh.over_the_box.statistics

Fields

The following fields are returned by SELECT queries:

list

Device Statistics Datapoints

Name	Datatype	Description
name	string	Name of the serie
points	array	List of point
tags	array	List of tags
unit	string	Unit of the serie (bps, byte, n/a)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	metrics_type, service_name	period	Returns the load, free memory or traffic series of the device for an hourly, daily, weekly or monthly period, each series with its unit, tags and timestamped points. (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"}})
metrics_type	string	Type of metrics you want to retrieve (wire: metricsType)
service_name	string	Service name (wire: serviceName)
period	string	Period (default is daily)

SELECT examples

list

Returns the load, free memory or traffic series of the device for an hourly, daily, weekly or monthly period, each series with its unit, tags and timestamped points. (Beta version)

SELECT
name,
points,
tags,
unit
FROM ovh.over_the_box.statistics
WHERE metrics_type = '{{ metrics_type }}' -- required
AND service_name = '{{ service_name }}' -- required
AND period = '{{ period }}'
;