diff --git a/content/en/api/v1/logs-indexes/examples.json b/content/en/api/v1/logs-indexes/examples.json index 87853762873..24de4d3186e 100644 --- a/content/en/api/v1/logs-indexes/examples.json +++ b/content/en/api/v1/logs-indexes/examples.json @@ -107,6 +107,7 @@ { "filter": { "query": "*", + "sample_attribute": "@ci.job_id", "sample_rate": 1 }, "is_enabled": false, @@ -127,7 +128,7 @@ } ] }, - "html": "
\n
\n
\n
\n

indexes

\n
\n

[object]

\n

Array of Log index configurations.

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

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

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

indexes

\n
\n

[object]

\n

Array of Log index configurations.

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

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_attribute

\n
\n

string

\n

Sample attribute to use for the sampling of logs going through this exclusion filter.\nWhen set, only the logs with the specified attribute are sampled.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -166,6 +167,7 @@ { "filter": { "query": "*", + "sample_attribute": "@ci.job_id", "sample_rate": 1 }, "is_enabled": false, @@ -184,7 +186,7 @@ "env:production" ] }, - "html": "
\n
\n
\n
\n

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

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

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_attribute

\n
\n

string

\n

Sample attribute to use for the sampling of logs going through this exclusion filter.\nWhen set, only the logs with the specified attribute are sampled.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

\n
\n \n
\n
" }, "400": { "json": { @@ -247,6 +249,7 @@ { "filter": { "query": "*", + "sample_attribute": "@ci.job_id", "sample_rate": 1 }, "is_enabled": false, @@ -264,7 +267,7 @@ "env:production" ] }, - "html": "
\n
\n
\n
\n

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

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

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_attribute

\n
\n

string

\n

Sample attribute to use for the sampling of logs going through this exclusion filter.\nWhen set, only the logs with the specified attribute are sampled.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

\n
\n \n
\n
" } }, "DeleteLogsIndex": { @@ -316,6 +319,7 @@ { "filter": { "query": "*", + "sample_attribute": "@ci.job_id", "sample_rate": 1 }, "is_enabled": false, @@ -334,7 +338,7 @@ "env:production" ] }, - "html": "
\n
\n
\n
\n

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

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

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_attribute

\n
\n

string

\n

Sample attribute to use for the sampling of logs going through this exclusion filter.\nWhen set, only the logs with the specified attribute are sampled.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

\n
\n \n
\n
" }, "403": { "json": { @@ -383,6 +387,7 @@ { "filter": { "query": "*", + "sample_attribute": "@ci.job_id", "sample_rate": 1 }, "is_enabled": false, @@ -401,7 +406,7 @@ "env:production" ] }, - "html": "
\n
\n
\n
\n

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

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

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_attribute

\n
\n

string

\n

Sample attribute to use for the sampling of logs going through this exclusion filter.\nWhen set, only the logs with the specified attribute are sampled.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

is_rate_limited

\n
\n

boolean

\n

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.\nRate limit is reset every-day at 2pm UTC.

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

name [required]

\n
\n

string

\n

The name of the index.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

\n
\n \n
\n
" }, "400": { "json": { @@ -456,6 +461,7 @@ { "filter": { "query": "*", + "sample_attribute": "@ci.job_id", "sample_rate": 1 }, "is_enabled": false, @@ -472,7 +478,7 @@ "env:production" ] }, - "html": "
\n
\n
\n
\n

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

disable_daily_limit

\n
\n

boolean

\n

If true, sets the daily_limit value to null and the index is not limited on a daily basis (any\nspecified daily_limit value in the request is ignored). If false or omitted, the index's current\ndaily_limit is maintained.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

Note: Changing this value affects all logs already in this index. It may also affect billing.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

Note: Changing this value affects all logs already in this index. It may also affect billing.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

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

daily_limit

\n
\n

int64

\n

The number of log events you can send in this index per day before you are rate-limited.

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

daily_limit_reset

\n
\n

object

\n

Object containing options to override the default daily limit reset time.

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

reset_time

\n
\n

string

\n

String in HH:00 format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive).

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

reset_utc_offset

\n
\n

string

\n

String in (-|+)HH:00 format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive).

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

daily_limit_warning_threshold_percentage

\n
\n

double

\n

A percentage threshold of the daily quota at which a Datadog warning event is generated.

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

disable_daily_limit

\n
\n

boolean

\n

If true, sets the daily_limit value to null and the index is not limited on a daily basis (any\nspecified daily_limit value in the request is ignored). If false or omitted, the index's current\ndaily_limit is maintained.

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

exclusion_filters

\n
\n

[object]

\n

An array of exclusion objects. The logs are tested against the query of each filter,\nfollowing the order of the array. Only the first matching active exclusion matters,\nothers (if any) are ignored.

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

filter

\n
\n

object

\n

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

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

query

\n
\n

string

\n

Default query is *, meaning all logs flowing in the index would be excluded.\nScope down exclusion filter to only a subset of logs with a log query.

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

sample_attribute

\n
\n

string

\n

Sample attribute to use for the sampling of logs going through this exclusion filter.\nWhen set, only the logs with the specified attribute are sampled.

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

sample_rate [required]

\n
\n

double

\n

Sample rate to apply to logs going through this exclusion filter,\na value of 1.0 excludes all logs matching the query.

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

is_enabled

\n
\n

boolean

\n

Whether or not the exclusion filter is active.

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

name [required]

\n
\n

string

\n

Name of the index exclusion filter.

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

filter [required]

\n
\n

object

\n

Filter for logs.

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

query

\n
\n

string

\n

The filter query.

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

num_flex_logs_retention_days

\n
\n

int64

\n

The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.\nIf Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through num_retention_days,\nand then stored in Flex Tier until the number of days specified in num_flex_logs_retention_days is reached.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

Note: Changing this value affects all logs already in this index. It may also affect billing.

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

num_retention_days

\n
\n

int64

\n

The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index.\nThe available values depend on retention plans specified in your organization's contract/subscriptions.

Note: Changing this value affects all logs already in this index. It may also affect billing.

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

tags

\n
\n

[string]

\n

A list of tags associated with the index. Tags must be in key:value format.

\n
\n \n
\n
" } } } \ No newline at end of file diff --git a/data/api/v1/full_spec.yaml b/data/api/v1/full_spec.yaml index 66d3ae066d9..26883cb490f 100644 --- a/data/api/v1/full_spec.yaml +++ b/data/api/v1/full_spec.yaml @@ -5841,6 +5841,12 @@ components: Scope down exclusion filter to only a subset of logs with a log query. example: "*" type: string + sample_attribute: + description: |- + Sample attribute to use for the sampling of logs going through this exclusion filter. + When set, only the logs with the specified attribute are sampled. + example: "@ci.job_id" + type: string sample_rate: description: |- Sample rate to apply to logs going through this exclusion filter, @@ -29910,7 +29916,7 @@ paths: Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful. - Using the `PUT` method updates your index’s configuration by **replacing** + Using the `PUT` method updates your index's configuration by **replacing** your current configuration with the new one sent to your Datadog organization. operationId: UpdateLogsIndex parameters: diff --git a/data/api/v1/translate_actions.json b/data/api/v1/translate_actions.json index 63b08ae1fa5..ceed83bbc1e 100644 --- a/data/api/v1/translate_actions.json +++ b/data/api/v1/translate_actions.json @@ -546,7 +546,7 @@ "summary": "Get an index" }, "UpdateLogsIndex": { - "description": "Update an index as identified by its name.\nReturns the Index object passed in the request body when the request is successful.\n\nUsing the `PUT` method updates your index’s configuration by **replacing**\nyour current configuration with the new one sent to your Datadog organization.", + "description": "Update an index as identified by its name.\nReturns the Index object passed in the request body when the request is successful.\n\nUsing the `PUT` method updates your index's configuration by **replacing**\nyour current configuration with the new one sent to your Datadog organization.", "summary": "Update an index", "request_description": "Object containing the new `LogsIndexUpdateRequest`.", "request_schema_description": "Object for updating a Datadog Log index."