UpdateDropRule - Chronosphere Documentation

Authorizations

API-Token

string

header

required

Chronosphere API token

Path Parameters

slug

string

required

Body

application/json

create_if_missing

boolean

If true, the DropRule will be created if it does not already exist, identified by slug. If false, an error will be returned if the DropRule does not already exist.

drop_rule

object

The DropRule to update.

Show child attributes

drop_rule.name

string

required

The name of the DropRule. You can modify this value after the DropRule is created.

drop_rule.drop_nan_value

boolean

Drops data points if values are Not a Number (NaN). If set to true, Chronosphere drops NaN data points, along with any published staleness markers. See the drop rules documentation for more information.

drop_rule.filters

object[]

Defines the conditions that determine whether to drop a metric. Drop rules can have multiple filter conditions on different labels, making it possible to drop a subset of the series matching a particular metric name.

Show child attributes

drop_rule.filters.name

string

The name of the label to match.

Example:

"job"

drop_rule.filters.value_glob

string

The glob value of the label to match.

Example:

"myservice*"

drop_rule.mode

enum<string>

If set to DISABLED, then the rule isn't applied when ingesting data points and metrics won't be dropped on the basis of this rule.

Available options:

ENABLED,

DISABLED,

PREVIEW

drop_rule.slug

string

The unique identifier of the DropRule. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the DropRule is created.

drop_rule.value_based_drop

object

Drops metrics based on values of 0 or 1. This type of drop rule can significantly reduce data points per second, but changes metrics from continuous series to sparse metrics. Adding a rule of this type can change the behavior of existing monitors or dashboards that use the target metric.

Show child attributes

drop_rule.value_based_drop.enabled

boolean

Enables dropping metrics based on a set value.

drop_rule.value_based_drop.target_drop_value

number<double>

The target data point value at which to drop metrics.

dry_run

boolean

If true, validates the specified configuration without creating or updating the DropRule. If the specified configuration is valid, the endpoint returns a partial response without the DropRule. If the specified configuration is invalid, the endpoint returns an error.

Response

A successful response containing the updated DropRule.

drop_rule

object

Show child attributes

drop_rule.name

string

required

The name of the DropRule. You can modify this value after the DropRule is created.

drop_rule.created_at

string<date-time>

Timestamp of when the DropRule was created. Cannot be set by clients.

drop_rule.drop_nan_value

boolean

Drops data points if values are Not a Number (NaN). If set to true, Chronosphere drops NaN data points, along with any published staleness markers. See the drop rules documentation for more information.

drop_rule.filters

object[]

Defines the conditions that determine whether to drop a metric. Drop rules can have multiple filter conditions on different labels, making it possible to drop a subset of the series matching a particular metric name.

Show child attributes

drop_rule.filters.name

string

The name of the label to match.

Example:

"job"

drop_rule.filters.value_glob

string

The glob value of the label to match.

Example:

"myservice*"

drop_rule.mode

enum<string>

If set to DISABLED, then the rule isn't applied when ingesting data points and metrics won't be dropped on the basis of this rule.

Available options:

ENABLED,

DISABLED,

PREVIEW

drop_rule.slug

string

The unique identifier of the DropRule. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the DropRule is created.

drop_rule.updated_at

string<date-time>

Timestamp of when the DropRule was last updated. Cannot be set by clients.

drop_rule.value_based_drop

object

Drops metrics based on values of 0 or 1. This type of drop rule can significantly reduce data points per second, but changes metrics from continuous series to sparse metrics. Adding a rule of this type can change the behavior of existing monitors or dashboards that use the target metric.

Show child attributes

drop_rule.value_based_drop.enabled

boolean

Enables dropping metrics based on a set value.

drop_rule.value_based_drop.target_drop_value

number<double>

The target data point value at which to drop metrics.

Endpoints

Authorizations

Path Parameters

Body

Response