UpdateLogScaleAlert - 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 LogScaleAlert will be created if it does not already exist, identified by slug. If false, an error will be returned if the LogScaleAlert does not already exist.

dry_run

boolean

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

log_scale_alert

object

The LogScaleAlert to update.

Show child attributes

log_scale_alert.name

string

required

Name of the alert.

log_scale_alert.alert_type

enum<string>

Type of alert, which can be standard or filter. A standard alert is triggered by an aggregate result. A filter alert is triggered by single event.

Available options:

STANDARD,

FILTER

log_scale_alert.description

string

Description of the alert.

log_scale_alert.disabled

boolean

Flag indicating whether the alert is disabled.

log_scale_alert.log_scale_action_slugs

string[]

Slugs of LogScale actions that will receive the alerts. When the value is empty this alert won't trigger. Optional.

log_scale_alert.log_scale_query

string

LogScale query to execute.

Example:

"level = ERROR | severity > 3 | count(as=numErrors) | numErrors > 500"

log_scale_alert.repository

string

Name of LogScale repository the alerts belongs to. Required.

log_scale_alert.run_as_user

string

Email of the user that the alert runs on behalf of. Required.

log_scale_alert.slug

string

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

log_scale_alert.tags

string[]

Tags attached to the alert.

log_scale_alert.throttle_field

string

Field to throttle on. Optional.

log_scale_alert.throttle_secs

integer<int32>

Throttle time in seconds. The alert is triggered at most once per throttle period.

log_scale_alert.time_window_secs

integer<int32>

Lookback window used for an alert's evaluation. If this is set to 86400 seconds (24 hours), only the events from the last 24 hours will be considered when the alert query is run.

Example:

"3600"

Response

A successful response containing the updated LogScaleAlert.

log_scale_alert

object

Show child attributes

log_scale_alert.name

string

required

Name of the alert.

log_scale_alert.alert_type

enum<string>

Type of alert, which can be standard or filter. A standard alert is triggered by an aggregate result. A filter alert is triggered by single event.

Available options:

STANDARD,

FILTER

log_scale_alert.created_at

string<date-time>

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

log_scale_alert.description

string

Description of the alert.

log_scale_alert.disabled

boolean

Flag indicating whether the alert is disabled.

log_scale_alert.log_scale_action_slugs

string[]

Slugs of LogScale actions that will receive the alerts. When the value is empty this alert won't trigger. Optional.

log_scale_alert.log_scale_query

string

LogScale query to execute.

Example:

"level = ERROR | severity > 3 | count(as=numErrors) | numErrors > 500"

log_scale_alert.repository

string

Name of LogScale repository the alerts belongs to. Required.

log_scale_alert.run_as_user

string

Email of the user that the alert runs on behalf of. Required.

log_scale_alert.slug

string

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

log_scale_alert.tags

string[]

Tags attached to the alert.

log_scale_alert.throttle_field

string

Field to throttle on. Optional.

log_scale_alert.throttle_secs

integer<int32>

Throttle time in seconds. The alert is triggered at most once per throttle period.

log_scale_alert.time_window_secs

integer<int32>

Lookback window used for an alert's evaluation. If this is set to 86400 seconds (24 hours), only the events from the last 24 hours will be considered when the alert query is run.

Example:

"3600"

log_scale_alert.updated_at

string<date-time>

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

Endpoints

Authorizations

Path Parameters

Body

Response