metrics_output_series
Creates, updates, deletes, gets or lists a metrics_output_series resource.
Overview
| Name | metrics_output_series |
| Type | Resource |
| Id | datadog.metrics.metrics_output_series |
Fields
The following fields are returned by SELECT queries:
- estimate_metrics_output_series
| Name | Datatype | Description |
|---|---|---|
id | string | The metric name for this resource. (example: test.metric.latency) |
attributes | object | Object containing the definition of a metric estimate attribute. |
type | string | The metric estimate resource type. (default: metric_cardinality_estimate, example: metric_cardinality_estimate) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
estimate_metrics_output_series | select | metric_name, region | filter[groups], filter[hours_ago], filter[num_aggregations], filter[pct], filter[timespan_h] | Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™. |
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) |
region | string | (default: datadoghq.com) |
filter[groups] | string | Filtered tag keys that the metric is configured to query with. (example: app,host) |
filter[hours_ago] | integer (int32) | The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours. (example: 49) |
filter[num_aggregations] | integer (int32) | Deprecated. Number of aggregations has no impact on volume. (example: 1) |
filter[pct] | boolean | A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators. (example: true) |
filter[timespan_h] | integer (int32) | A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour. (example: 6) |
SELECT examples
- estimate_metrics_output_series
Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™.
SELECT
id,
attributes,
type
FROM datadog.metrics.metrics_output_series
WHERE metric_name = '{{ metric_name }}' -- required
AND region = '{{ region }}' -- required
AND filter[groups] = '{{ filter[groups] }}'
AND filter[hours_ago] = '{{ filter[hours_ago] }}'
AND filter[num_aggregations] = '{{ filter[num_aggregations] }}'
AND filter[pct] = '{{ filter[pct] }}'
AND filter[timespan_h] = '{{ filter[timespan_h] }}'
;