Skip to content

Latest commit

 

History

History
60 lines (56 loc) Β· 6.2 KB

File metadata and controls

60 lines (56 loc) Β· 6.2 KB

Alert

Properties

Name Type Description Notes
last_event_time int Start time (in epoch millis) of the last event associated with this alert. [optional]
created int When this alert was created, in epoch millis [optional]
minutes int The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires
name str
id str [optional]
target str The email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes
tags WFTags [optional]
status list[str] Lists the current state of the alert. Can be one or more of: FIRING,SNOOZED, IN_MAINTENANCE, INVALID, NONE, CHECKING, TRASH, NO_DATA [optional]
event Event [optional]
updated int When the alert was last updated, in epoch millis [optional]
process_rate_minutes int The interval between checks for this alert, in minutes. Defaults to 1 minute [optional]
last_processed_millis int The time when this alert was last checked, in epoch millis [optional]
update_user_id str The user that last updated this alert [optional]
display_expression str A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted [optional]
condition_qb_enabled bool Whether the condition query was created using the Query Builder. Default false [optional]
display_expression_qb_enabled bool Whether the display expression query was created using the Query Builder. Default false [optional]
condition str A Wavefront query that is evaluated at regular intervals (default 1m). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes
condition_qb_serialization str The special serialization of the Query Builder that corresponds to the condition query. Applicable only when conditionQBEnabled is true [optional]
display_expression_qb_serialization str The special serialization of the Query Builder that corresponds to the display expression query. Applicable only when displayExpressionQBEnabled is true [optional]
include_obsolete_metrics bool Whether to include obsolete metrics in alert query [optional]
severity str Severity of the alert
last_query_time int Last query time of the alert, averaged on hourly basis [optional]
notificants list[str] A derived field listing the webhook ids used by this alert [optional]
alerts_last_day int [optional]
alerts_last_week int [optional]
alerts_last_month int [optional]
snoozed int The until which time this alert is snoozed (not checked), in epoch millis. A negative value implies the alert is snoozed indefinitely [optional]
in_maintenance_host_label_pairs list[SourceLabelPair] Lists the sources that will not be checked for this alert, due to matching a maintenance window [optional]
failing_host_label_pairs list[SourceLabelPair] Failing host/metric pairs [optional]
active_maintenance_windows list[str] The names of the active maintenance windows that are affecting this alert [optional]
prefiring_host_label_pairs list[SourceLabelPair] Lists the series that are starting to fail, defined as failing for greater than 50% of the checks in the window determined by the "minutes" parameter [optional]
no_data_event Event No data event related to the alert [optional]
in_trash bool [optional]
query_failing bool Whether there was an exception when the alert condition last ran [optional]
create_user_id str [optional]
additional_information str User-supplied additional explanatory information for this alert. Useful for linking runbooks, mitigations,, etc [optional]
creator_id str [optional]
resolve_after_minutes int The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as "minutes" [optional]
updater_id str [optional]
last_failed_time int The time of the last error encountered when running this alert's condition query, in epoch millis [optional]
last_error_message str The last error encountered when running this alert's condition query [optional]
metrics_used list[str] Number of metrics checked by the alert condition [optional]
hosts_used list[str] Number of hosts checked by the alert condition [optional]
points_scanned_at_last_query int A derived field recording the number of data points scanned when the system last computed this alert's condition [optional]
last_notification_millis int When this alert last caused a notification, in epoch millis [optional]
notification_resend_frequency_minutes int How often to re-trigger a continually failing alert. If absent or <= 0, no retriggering occurs [optional]
created_epoch_millis int [optional]
updated_epoch_millis int [optional]
deleted bool [optional]
target_info list[TargetInfo] List of alert targets display information that includes name, id and type. [optional]
sort_attr int Attribute used for default alert sort that is derived from state and severity [optional]

[Back to Model list] [Back to API list] [Back to README]