From 0150cecb21c73375e2936c8d25937b8d002e4786 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Wed, 14 May 2025 15:47:01 +0000 Subject: [PATCH] Regenerate client from commit 64f5e7ee of spec repo --- .apigentools-info | 8 ++-- content/en/api/v2/metrics/examples.json | 12 +++--- data/api/v2/full_spec.yaml | 52 +++++-------------------- data/api/v2/full_spec_deref.json | 40 +++++++++---------- data/api/v2/translate_actions.json | 2 +- static/resources/json/full_spec_v2.json | 40 +++++++++---------- 6 files changed, 61 insertions(+), 93 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index 51b5399c4af6d..6c12e0aab33c4 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-05-14 14:50:03.643881", - "spec_repo_commit": "90c6252d" + "regenerated": "2025-05-14 15:46:38.896407", + "spec_repo_commit": "64f5e7ee" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-05-14 14:50:12.794148", - "spec_repo_commit": "90c6252d" + "regenerated": "2025-05-14 15:46:48.228708", + "spec_repo_commit": "64f5e7ee" } } } \ No newline at end of file diff --git a/content/en/api/v2/metrics/examples.json b/content/en/api/v2/metrics/examples.json index b6deabc8cc03b..6d6b09ade1fb5 100644 --- a/content/en/api/v2/metrics/examples.json +++ b/content/en/api/v2/metrics/examples.json @@ -25,7 +25,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

Array of metrics and metric tag configurations.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric resource type. \nAllowed enum values: metrics

default: metrics

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration attributes.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:

\n
    \n
  • time: avg, space: avg
    • \n
  • time: avg, space: max
    • \n
  • time: avg, space: min
    • \n
  • time: avg, space: sum
    • \n
  • time: count, space: sum
    • \n
  • time: max, space: max
    • \n
  • time: min, space: min
    • \n
  • time: sum, space: avg
    • \n
  • time: sum, space: sum
    • \n
\n

Can only be applied to non_distribution metrics that have a metric_type of count, rate, or gauge.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the tag configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include or exclude percentile aggregations for distribution metrics.\nOnly present when the metric_type is distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp when the tag configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tag keys on which to group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Pagination links. Only present if pagination query parameters were provided.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to previous page.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata object.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Paging attributes. Only present if pagination query parameters were provided.

\n
\n
\n
\n
\n
\n

cursor

\n
\n

string

\n

The cursor used to get the current results, if any.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int32

\n

Number of results returned

\n
\n \n
\n
\n
\n
\n
\n

next_cursor

\n
\n

string

\n

The cursor used to get the next results, if any.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of metric pagination. \nAllowed enum values: cursor_limit

default: cursor_limit

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

Array of metrics and metric tag configurations.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric resource type. \nAllowed enum values: metrics

default: metrics

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration attributes.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the tag configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include or exclude percentile aggregations for distribution metrics.\nOnly present when the metric_type is distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp when the tag configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tag keys on which to group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Pagination links. Only present if pagination query parameters were provided.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to previous page.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata object.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Paging attributes. Only present if pagination query parameters were provided.

\n
\n
\n
\n
\n
\n

cursor

\n
\n

string

\n

The cursor used to get the current results, if any.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int32

\n

Number of results returned

\n
\n \n
\n
\n
\n
\n
\n

next_cursor

\n
\n

string

\n

The cursor used to get the next results, if any.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of metric pagination. \nAllowed enum values: cursor_limit

default: cursor_limit

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -552,7 +552,7 @@ "type": "manage_tags" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration attributes.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:

\n
    \n
  • time: avg, space: avg
    • \n
  • time: avg, space: max
    • \n
  • time: avg, space: min
    • \n
  • time: avg, space: sum
    • \n
  • time: count, space: sum
    • \n
  • time: max, space: max
    • \n
  • time: min, space: min
    • \n
  • time: sum, space: avg
    • \n
  • time: sum, space: sum
    • \n
\n

Can only be applied to non_distribution metrics that have a metric_type of count, rate, or gauge.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the tag configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include or exclude percentile aggregations for distribution metrics.\nOnly present when the metric_type is distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp when the tag configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tag keys on which to group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration attributes.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the tag configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include or exclude percentile aggregations for distribution metrics.\nOnly present when the metric_type is distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp when the tag configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tag keys on which to group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -611,7 +611,7 @@ "type": "manage_tags" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration attributes.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:

\n
    \n
  • time: avg, space: avg
    • \n
  • time: avg, space: max
    • \n
  • time: avg, space: min
    • \n
  • time: avg, space: sum
    • \n
  • time: count, space: sum
    • \n
  • time: max, space: max
    • \n
  • time: min, space: min
    • \n
  • time: sum, space: avg
    • \n
  • time: sum, space: sum
    • \n
\n

Can only be applied to non_distribution metrics that have a metric_type of count, rate, or gauge.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the tag configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include or exclude percentile aggregations for distribution metrics.\nOnly present when the metric_type is distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp when the tag configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tag keys on which to group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration attributes.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the tag configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include or exclude percentile aggregations for distribution metrics.\nOnly present when the metric_type is distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp when the tag configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tag keys on which to group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -681,7 +681,7 @@ "type": "manage_tags" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single tag configuration to be edited.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration to be updated.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:

\n
    \n
  • time: avg, space: avg
    • \n
  • time: avg, space: max
    • \n
  • time: avg, space: min
    • \n
  • time: avg, space: sum
    • \n
  • time: count, space: sum
    • \n
  • time: max, space: max
    • \n
  • time: min, space: min
    • \n
  • time: sum, space: avg
    • \n
  • time: sum, space: sum
    • \n
\n

Can only be applied to non_distribution metrics that have a metric_type of count, rate, or gauge.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include/exclude percentiles for a distribution metric.\nDefaults to false. Can only be applied to metrics that have a metric_type of distribution.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tag keys that will be queryable for your metric.

default:

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single tag configuration to be edited.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration to be updated.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include/exclude percentiles for a distribution metric.\nDefaults to false. Can only be applied to metrics that have a metric_type of distribution.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tag keys that will be queryable for your metric.

default:

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" } }, "CreateTagConfiguration": { @@ -710,7 +710,7 @@ "type": "manage_tags" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration attributes.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:

\n
    \n
  • time: avg, space: avg
    • \n
  • time: avg, space: max
    • \n
  • time: avg, space: min
    • \n
  • time: avg, space: sum
    • \n
  • time: count, space: sum
    • \n
  • time: max, space: max
    • \n
  • time: min, space: min
    • \n
  • time: sum, space: avg
    • \n
  • time: sum, space: sum
    • \n
\n

Can only be applied to non_distribution metrics that have a metric_type of count, rate, or gauge.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the tag configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include or exclude percentile aggregations for distribution metrics.\nOnly present when the metric_type is distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp when the tag configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tag keys on which to group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single metric tag configuration.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration attributes.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the tag configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include or exclude percentile aggregations for distribution metrics.\nOnly present when the metric_type is distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp when the tag configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tag keys on which to group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -786,7 +786,7 @@ "type": "manage_tags" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single metric to be configure tags on.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration to be created.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:

\n
    \n
  • time: avg, space: avg
    • \n
  • time: avg, space: max
    • \n
  • time: avg, space: min
    • \n
  • time: avg, space: sum
    • \n
  • time: count, space: sum
    • \n
  • time: max, space: max
    • \n
  • time: min, space: min
    • \n
  • time: sum, space: avg
    • \n
  • time: sum, space: sum
    • \n
\n

Can only be applied to non_distribution metrics that have a metric_type of count, rate, or gauge.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include/exclude percentiles for a distribution metric.\nDefaults to false. Can only be applied to metrics that have a metric_type of distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type [required]

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tag keys that will be queryable for your metric.

default:

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single metric to be configure tags on.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Object containing the definition of a metric tag configuration to be created.

\n
\n
\n
\n
\n
\n

aggregations

\n
\n

[object]

\n

Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.

\n
\n
\n
\n
\n
\n

space [required]

\n
\n

enum

\n

A space aggregation for use in query. \nAllowed enum values: avg,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n

time [required]

\n
\n

enum

\n

A time aggregation for use in query. \nAllowed enum values: avg,count,max,min,sum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

exclude_tags_mode

\n
\n

boolean

\n

When set to true, the configuration will exclude the configured tags and include any other submitted tags.\nWhen set to false, the configuration will include the configured tags and exclude any other submitted tags.\nDefaults to false. Requires tags property.

\n
\n \n
\n
\n
\n
\n
\n

include_percentiles

\n
\n

boolean

\n

Toggle to include/exclude percentiles for a distribution metric.\nDefaults to false. Can only be applied to metrics that have a metric_type of distribution.

\n
\n \n
\n
\n
\n
\n
\n

metric_type [required]

\n
\n

enum

\n

The metric's type. \nAllowed enum values: gauge,count,rate,distribution

default: gauge

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tag keys that will be queryable for your metric.

default:

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The metric name for this resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The metric tag configuration resource type. \nAllowed enum values: manage_tags

default: manage_tags

\n
\n \n
\n
\n
\n
" } }, "ListVolumesByMetricName": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 71825228cde2e..299b55863ff2d 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -21544,38 +21544,8 @@ components: - space type: object MetricCustomAggregations: - description: 'A list of queryable aggregation combinations for a count, rate, - or gauge metric. - - By default, count and rate metrics require the (time: sum, space: sum) aggregation - and - - Gauge metrics require the (time: avg, space: avg) aggregation. - - Additional time & space combinations are also available: - - - - time: avg, space: avg - - - time: avg, space: max - - - time: avg, space: min - - - time: avg, space: sum - - - time: count, space: sum - - - time: max, space: max - - - time: min, space: min - - - time: sum, space: avg - - - time: sum, space: sum - - - Can only be applied to non_distribution metrics that have a `metric_type` - of `count`, `rate`, or `gauge`.' + description: Deprecated. You no longer need to configure specific time and space + aggregations for Metrics Without Limits. example: - space: sum time: sum @@ -52458,8 +52428,7 @@ paths: maximum: 2147483647 minimum: 49 type: integer - - description: The number of aggregations that a `count`, `rate`, or `gauge` - metric is configured to use. Max number of aggregation combos is 9. + - description: Deprecated. Number of aggregations has no impact on volume. example: 1 in: query name: filter[num_aggregations] @@ -52679,17 +52648,16 @@ paths: description: 'Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. - Optionally, include percentile aggregations on any distribution metric or - configure custom aggregations + Optionally, include percentile aggregations on any distribution metric. By + setting `exclude_tags_mode` - on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true - the behavior is changed + to true, the behavior is changed from an allow-list to a deny-list, and tags + in the defined list are - from an allow-list to a deny-list, and tags in the defined list will not be - queryable. + not queryable. Can only be used with application keys of users with the `Manage + Tags for Metrics` - Can only be used with application keys of users with the `Manage Tags for - Metrics` permission.' + permission.' operationId: CreateTagConfiguration parameters: - $ref: '#/components/parameters/MetricName' diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 81e0e0f43e6b7..fed98235feaef 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -150459,7 +150459,7 @@ "type": "object" }, "MetricCustomAggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152052,7 +152052,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152193,7 +152193,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152314,7 +152314,7 @@ "description": "Object containing the definition of a metric tag configuration to be created.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152443,7 +152443,7 @@ "description": "Object containing the definition of a metric tag configuration to be created.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152599,7 +152599,7 @@ "description": "Object containing the definition of a metric tag configuration to be created.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152800,7 +152800,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152957,7 +152957,7 @@ "description": "Object containing the definition of a metric tag configuration to be updated.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -153063,7 +153063,7 @@ "description": "Object containing the definition of a metric tag configuration to be updated.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -153196,7 +153196,7 @@ "description": "Object containing the definition of a metric tag configuration to be updated.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -153579,7 +153579,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -153779,7 +153779,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -407967,7 +407967,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -409925,7 +409925,7 @@ } }, { - "description": "The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9.", + "description": "Deprecated. Number of aggregations has no impact on volume.", "example": 1, "in": "query", "name": "filter[num_aggregations]", @@ -410331,7 +410331,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -410626,7 +410626,7 @@ "description": "Object containing the definition of a metric tag configuration to be updated.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -410781,7 +410781,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -411056,7 +411056,7 @@ } }, "post": { - "description": "Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.\nOptionally, include percentile aggregations on any distribution metric or configure custom aggregations\non any count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed\nfrom an allow-list to a deny-list, and tags in the defined list will not be queryable.\nCan only be used with application keys of users with the `Manage Tags for Metrics` permission.", + "description": "Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.\nOptionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`\nto true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are\nnot queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`\npermission.", "operationId": "CreateTagConfiguration", "parameters": [ { @@ -411095,7 +411095,7 @@ "description": "Object containing the definition of a metric tag configuration to be created.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -411272,7 +411272,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index ea998b485b265..4bd18e5916b90 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1226,7 +1226,7 @@ "request_schema_description": "Request object that includes the metric that you would like to edit the tag configuration on." }, "CreateTagConfiguration": { - "description": "Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.\nOptionally, include percentile aggregations on any distribution metric or configure custom aggregations\non any count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed\nfrom an allow-list to a deny-list, and tags in the defined list will not be queryable.\nCan only be used with application keys of users with the `Manage Tags for Metrics` permission.", + "description": "Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.\nOptionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`\nto true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are\nnot queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`\npermission.", "summary": "Create a tag configuration", "request_description": "", "request_schema_description": "Request object that includes the metric that you would like to configure tags for." diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 81e0e0f43e6b7..fed98235feaef 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -150459,7 +150459,7 @@ "type": "object" }, "MetricCustomAggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152052,7 +152052,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152193,7 +152193,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152314,7 +152314,7 @@ "description": "Object containing the definition of a metric tag configuration to be created.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152443,7 +152443,7 @@ "description": "Object containing the definition of a metric tag configuration to be created.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152599,7 +152599,7 @@ "description": "Object containing the definition of a metric tag configuration to be created.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152800,7 +152800,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -152957,7 +152957,7 @@ "description": "Object containing the definition of a metric tag configuration to be updated.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -153063,7 +153063,7 @@ "description": "Object containing the definition of a metric tag configuration to be updated.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -153196,7 +153196,7 @@ "description": "Object containing the definition of a metric tag configuration to be updated.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -153579,7 +153579,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -153779,7 +153779,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -407967,7 +407967,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -409925,7 +409925,7 @@ } }, { - "description": "The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9.", + "description": "Deprecated. Number of aggregations has no impact on volume.", "example": 1, "in": "query", "name": "filter[num_aggregations]", @@ -410331,7 +410331,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -410626,7 +410626,7 @@ "description": "Object containing the definition of a metric tag configuration to be updated.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -410781,7 +410781,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -411056,7 +411056,7 @@ } }, "post": { - "description": "Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.\nOptionally, include percentile aggregations on any distribution metric or configure custom aggregations\non any count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed\nfrom an allow-list to a deny-list, and tags in the defined list will not be queryable.\nCan only be used with application keys of users with the `Manage Tags for Metrics` permission.", + "description": "Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.\nOptionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`\nto true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are\nnot queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`\npermission.", "operationId": "CreateTagConfiguration", "parameters": [ { @@ -411095,7 +411095,7 @@ "description": "Object containing the definition of a metric tag configuration to be created.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum", @@ -411272,7 +411272,7 @@ "description": "Object containing the definition of a metric tag configuration attributes.", "properties": { "aggregations": { - "description": "A list of queryable aggregation combinations for a count, rate, or gauge metric.\nBy default, count and rate metrics require the (time: sum, space: sum) aggregation and\nGauge metrics require the (time: avg, space: avg) aggregation.\nAdditional time & space combinations are also available:\n\n- time: avg, space: avg\n- time: avg, space: max\n- time: avg, space: min\n- time: avg, space: sum\n- time: count, space: sum\n- time: max, space: max\n- time: min, space: min\n- time: sum, space: avg\n- time: sum, space: sum\n\nCan only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.", + "description": "Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.", "example": [ { "space": "sum",