{
"consumption_budget": {
"name": "<string>",
"partition_slug_path": "<string>",
"resource": "LOG_PERSISTED_BYTES",
"alert_action_config": {
"annotations": {},
"instant_rate_sustain_secs": 123,
"labels": {}
},
"created_at": "2023-11-07T05:31:56Z",
"default_priority": 123,
"notification_policy_slug": "<string>",
"priorities": [
{
"filters": [
{
"dataset_slug": "<string>",
"log_filter": {
"query": "<string>"
}
}
],
"priority": 123
}
],
"slug": "<string>",
"thresholds": [
{
"action": "ALERT_WARN",
"type": "DAILY_VOLUME",
"instant_rate": {
"fixed_value_per_sec": "<string>"
},
"volume": {
"fixed_value": "<string>"
}
}
],
"updated_at": "2023-11-07T05:31:56Z"
}
}UpdateConsumptionBudget
{
"consumption_budget": {
"name": "<string>",
"partition_slug_path": "<string>",
"resource": "LOG_PERSISTED_BYTES",
"alert_action_config": {
"annotations": {},
"instant_rate_sustain_secs": 123,
"labels": {}
},
"created_at": "2023-11-07T05:31:56Z",
"default_priority": 123,
"notification_policy_slug": "<string>",
"priorities": [
{
"filters": [
{
"dataset_slug": "<string>",
"log_filter": {
"query": "<string>"
}
}
],
"priority": 123
}
],
"slug": "<string>",
"thresholds": [
{
"action": "ALERT_WARN",
"type": "DAILY_VOLUME",
"instant_rate": {
"fixed_value_per_sec": "<string>"
},
"volume": {
"fixed_value": "<string>"
}
}
],
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Chronosphere API token
Path Parameters
Body
The ConsumptionBudget to update.
Show child attributes
Show child attributes
The name of the ConsumptionBudget. You can modify this value after the ConsumptionBudget is created.
Path of the budget's partition, delimited by forward slashes (/), in the
format global/SLUG1/SLUG2, where SLUG1 is a top-level partition, and SLUG2
is a child partition of SLUG1.
A well-formed partition path always starts with the global partition slug, and
has no leading or trailing forward slashes.
Resource of the budget.
LOG_PERSISTED_BYTES, LOG_PROCESSED_BYTES Optional. Configures all ALERT_WARN & ALERT_CRITICAL actions for this budget.
Show child attributes
Show child attributes
Additional annotations to set on the generated monitor. By default, the monitors already contain "description", "dashboard", "resource", "consumption_budget_slug", "threshold_type", and "partition" annotations. Setting any of these annotations will override its default value.
Show child attributes
Show child attributes
How long instant rate consumption must sustain above the threshold in order to fire an alert. By default, the sustain is 0: any consumption over the threshold will fire an alert.
Additional labels to set on the generated monitor, which can be used for notification routing. The following labels are reserved and cannot be override: "resource", "partition", and "threshold_type".
Show child attributes
Show child attributes
Optional. The default priority for requests that don't match any priority in the
priorities list. If not set, then priority=10 (dropped first) is used as the
default.
Notification policy slug for routing alerts. Required only if ALERT_WARN or
ALERT_CRITICAL actions are configured.
Optional. Controls the order in which data is dropped when a drop action is
applied. For example, a priority of 10 is dropped first, and a priority of 1 is
dropped last. Priorities are evaluated in match order, and the first priority to
match is applied. All other priorities are ignored. If a request does not match
any priority, then it is assigned the default_priority.
Show child attributes
Show child attributes
Criteria that defines which data matches the priority. Filters are
concatenated together as implied AND operators. A request must match every
filter to match the priority.
Show child attributes
Show child attributes
If set, matches incoming data that belongs to the specified dataset.
The dataset type must match the budget resource. For example,
resource=LOG_PERSISTED_BYTES, then the dataset type must be
type=LOGS.
Exactly one of dataset_slug or log_filter must be set.
If set, matches incoming log data by log query. This field is only
valid for resource=LOG_* budgets.
Exactly one of dataset_slug or log_filter must be set.
Show child attributes
Show child attributes
Returns logs that match this query. The query can include only top-level
operations. Nested clauses aren't supported. Only one type of AND or OR
operator is allowed.
Priority order that determines when to drop data. A priority of 10 is
dropped first, and a priority of 1 is dropped last.
The unique identifier of the ConsumptionBudget. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the ConsumptionBudget is created.
Optional. Defines which actions to take when a threshold is exceeded.
Show child attributes
Show child attributes
The specified action to take when the threshold is exceeded.
ALERT_WARN, ALERT_CRITICAL, DROP Specifies the threshold type, which can be one of the following values.
INSTANT_RATE sets an instantaneous rate threshold. The configured action
triggers when consumption exceeds the configured rate threshold, defined by
the instant_rate field. The DROP action accepts requests up to the
threshold, and drops any data over the threshold in priority order.
ROLLING_1_HOUR_VOLUME and ROLLING_3_HOUR_VOLUME set a volume
threshold over a rolling time period. The configured action triggers when
consumption over the last hour or last three hours exceeds the
configured threshold, defined by the volume field.
HOURLY_VOLUME, DAILY_VOLUME, WEEKLY_VOLUME, and MONTHLY_VOLUME set a volume threshold
over a fixed, non-overlapping time period. The configured action triggers when consumption
over the specified time period (hourly, daily, weekly, or monthly) exceeds the
configured threshold, defined by the volume field. Volumes reset
to zero at the start of each time period. The DROP action drops all requests
when a volume threshold is exceeded, regardless of priority.
HOURLY_VOLUMEsums the consumption volume from00:00:00UTCto00:59:59` UTC every hour.DAILY_VOLUMEsums the consumption volume from00:00:00UTC to23:59:59UTC every day.WEEKLY_VOLUMEsums the consumption volume from00:00:00UTC Monday morning to23:59:59UTC Sunday night.MONTHLY_VOLUMEsums the consumption volume from00:00:00UTC on the first day of the month to23:59:59UTC on the last day of the month. For example,Jan 1 00:00:00toJan 31 23:59:59. Month thresholds are evaluated equally, regardless of how many days are in the month. For example, thresholds for January and February are the same, even though February has fewer days.
DAILY_VOLUME, INSTANT_RATE, WEEKLY_VOLUME, MONTHLY_VOLUME, HOURLY_VOLUME, ROLLING_1_HOUR_VOLUME, ROLLING_3_HOUR_VOLUME If true, the ConsumptionBudget will be created if it does not already exist, identified by slug. If false, an error will be returned if the ConsumptionBudget does not already exist.
If true, validates the specified configuration without creating or updating the ConsumptionBudget. If the specified configuration is valid, the endpoint returns a partial response without the ConsumptionBudget. If the specified configuration is invalid, the endpoint returns an error.
Response
A successful response containing the updated ConsumptionBudget.
Show child attributes
Show child attributes
The name of the ConsumptionBudget. You can modify this value after the ConsumptionBudget is created.
Path of the budget's partition, delimited by forward slashes (/), in the
format global/SLUG1/SLUG2, where SLUG1 is a top-level partition, and SLUG2
is a child partition of SLUG1.
A well-formed partition path always starts with the global partition slug, and
has no leading or trailing forward slashes.
Resource of the budget.
LOG_PERSISTED_BYTES, LOG_PROCESSED_BYTES Optional. Configures all ALERT_WARN & ALERT_CRITICAL actions for this budget.
Show child attributes
Show child attributes
Additional annotations to set on the generated monitor. By default, the monitors already contain "description", "dashboard", "resource", "consumption_budget_slug", "threshold_type", and "partition" annotations. Setting any of these annotations will override its default value.
Show child attributes
Show child attributes
How long instant rate consumption must sustain above the threshold in order to fire an alert. By default, the sustain is 0: any consumption over the threshold will fire an alert.
Additional labels to set on the generated monitor, which can be used for notification routing. The following labels are reserved and cannot be override: "resource", "partition", and "threshold_type".
Show child attributes
Show child attributes
Timestamp of when the ConsumptionBudget was created. Cannot be set by clients.
Optional. The default priority for requests that don't match any priority in the
priorities list. If not set, then priority=10 (dropped first) is used as the
default.
Notification policy slug for routing alerts. Required only if ALERT_WARN or
ALERT_CRITICAL actions are configured.
Optional. Controls the order in which data is dropped when a drop action is
applied. For example, a priority of 10 is dropped first, and a priority of 1 is
dropped last. Priorities are evaluated in match order, and the first priority to
match is applied. All other priorities are ignored. If a request does not match
any priority, then it is assigned the default_priority.
Show child attributes
Show child attributes
Criteria that defines which data matches the priority. Filters are
concatenated together as implied AND operators. A request must match every
filter to match the priority.
Show child attributes
Show child attributes
If set, matches incoming data that belongs to the specified dataset.
The dataset type must match the budget resource. For example,
resource=LOG_PERSISTED_BYTES, then the dataset type must be
type=LOGS.
Exactly one of dataset_slug or log_filter must be set.
If set, matches incoming log data by log query. This field is only
valid for resource=LOG_* budgets.
Exactly one of dataset_slug or log_filter must be set.
Show child attributes
Show child attributes
Returns logs that match this query. The query can include only top-level
operations. Nested clauses aren't supported. Only one type of AND or OR
operator is allowed.
Priority order that determines when to drop data. A priority of 10 is
dropped first, and a priority of 1 is dropped last.
The unique identifier of the ConsumptionBudget. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the ConsumptionBudget is created.
Optional. Defines which actions to take when a threshold is exceeded.
Show child attributes
Show child attributes
The specified action to take when the threshold is exceeded.
ALERT_WARN, ALERT_CRITICAL, DROP Specifies the threshold type, which can be one of the following values.
INSTANT_RATE sets an instantaneous rate threshold. The configured action
triggers when consumption exceeds the configured rate threshold, defined by
the instant_rate field. The DROP action accepts requests up to the
threshold, and drops any data over the threshold in priority order.
ROLLING_1_HOUR_VOLUME and ROLLING_3_HOUR_VOLUME set a volume
threshold over a rolling time period. The configured action triggers when
consumption over the last hour or last three hours exceeds the
configured threshold, defined by the volume field.
HOURLY_VOLUME, DAILY_VOLUME, WEEKLY_VOLUME, and MONTHLY_VOLUME set a volume threshold
over a fixed, non-overlapping time period. The configured action triggers when consumption
over the specified time period (hourly, daily, weekly, or monthly) exceeds the
configured threshold, defined by the volume field. Volumes reset
to zero at the start of each time period. The DROP action drops all requests
when a volume threshold is exceeded, regardless of priority.
HOURLY_VOLUMEsums the consumption volume from00:00:00UTCto00:59:59` UTC every hour.DAILY_VOLUMEsums the consumption volume from00:00:00UTC to23:59:59UTC every day.WEEKLY_VOLUMEsums the consumption volume from00:00:00UTC Monday morning to23:59:59UTC Sunday night.MONTHLY_VOLUMEsums the consumption volume from00:00:00UTC on the first day of the month to23:59:59UTC on the last day of the month. For example,Jan 1 00:00:00toJan 31 23:59:59. Month thresholds are evaluated equally, regardless of how many days are in the month. For example, thresholds for January and February are the same, even though February has fewer days.
DAILY_VOLUME, INSTANT_RATE, WEEKLY_VOLUME, MONTHLY_VOLUME, HOURLY_VOLUME, ROLLING_1_HOUR_VOLUME, ROLLING_3_HOUR_VOLUME Timestamp of when the ConsumptionBudget was last updated. Cannot be set by clients.