volumes
Creates, updates, deletes, gets or lists a volumes resource.
Overview
| Name | volumes |
| Type | Resource |
| Id | datadog.metrics.volumes |
Fields
The following fields are returned by SELECT queries:
- list_volumes_by_metric_name
| Name | Datatype | Description |
|---|---|---|
id | string | The metric name for this resource. (example: test.metric.latency) |
attributes | object | Object containing the definition of a metric's distinct volume. |
type | string | The metric distinct volume type. (distinct_metric_volumes) (default: distinct_metric_volumes, example: distinct_metric_volumes) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_volumes_by_metric_name | select | metric_name | window[seconds] | View hourly average cardinality for the given metric name over the look back period.<br />For Metric Name Pricing customers, view total point volume for the given metric name<br />over the look back period. |
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 |
|---|---|---|
metric_name | string | The name of the metric. (example: dist.http.endpoint.request) |
site | string | The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both. |
window[seconds] | integer (int64) | The number of seconds of look back (from now). Default value is 3,600 (1 hour), maximum value is 2,592,000 (1 month). (example: 7200) |
SELECT examples
- list_volumes_by_metric_name
View hourly average cardinality for the given metric name over the look back period.<br />For Metric Name Pricing customers, view total point volume for the given metric name<br />over the look back period.
SELECT
id,
attributes,
type
FROM datadog.metrics.volumes
WHERE metric_name = '{{ metric_name }}' -- required
AND window[seconds] = '{{ window[seconds] }}'
;