Skip to content

Latest commit

 

History

History
94 lines (90 loc) · 10.1 KB

IngestionPolicyAlert.md

File metadata and controls

94 lines (90 loc) · 10.1 KB

IngestionPolicyAlert

Properties

Name Type Description Notes
acl AccessControlListSimple [optional]
active_maintenance_windows list[str] The names of the active maintenance windows that are affecting this alert [optional]
additional_information str User-supplied additional explanatory information for this alert. Useful for linking runbooks, mitigations,, etc [optional]
alert_chart_base int The base of alert chart. A linear chart will have base as 1. A logarithmic chart will have the other base value.The value should be an integer and should greater than or equal to 1. [optional]
alert_chart_description str The description of alert chart. Different from alert additional info, this is used to describe the characteristics of the chart. [optional]
alert_chart_units str The y-axis unit of Alert chart. [optional]
alert_sources list[AlertSource] A list of queries represent multiple queries in alert. It must contains at least one query with AlertSourceType as CONDITION. [optional]
alert_triage_dashboards list[AlertDashboard] User-supplied dashboard and parameters to create dashboard links. Parameters must be specified as constants or variables. Constant parameters currently only supported [optional]
alert_type str Alert type. [optional]
alerts_last_day int [optional]
alerts_last_month int [optional]
alerts_last_week int [optional]
application list[str] Lists the applications from the failingHostLabelPair of the alert. [optional]
chart_attributes JsonNode Additional chart settings for the alert (e.g. pie chart has its chart settings in this section). [optional]
chart_settings ChartSettings The old chart settings for the alert (e.g. chart type, chart range etc.). [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_percentages dict(str, int) Multi - alert conditions. [optional]
condition_qb_enabled bool Whether the condition query was created using the Query Builder. Default false [optional]
condition_qb_serialization str The special serialization of the Query Builder that corresponds to the condition query. Applicable only when conditionQBEnabled is true [optional]
condition_query_type str [optional]
conditions dict(str, str) Multi - alert conditions. [optional]
conditions_threshold_operator str
create_user_id str [optional]
created int When this alert was created, in epoch millis [optional]
created_epoch_millis int [optional]
creator_id str [optional]
deleted bool [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]
display_expression_qb_enabled bool Whether the display expression query was created using the Query Builder. Default false [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]
display_expression_query_type str [optional]
enable_pd_incident_by_series bool [optional]
evaluate_realtime_data bool Whether to alert on the real-time ingestion stream (may be noisy due to late data) [optional]
event Event [optional]
failing_host_label_pair_links list[str] List of links to tracing applications that caused a failing series [optional]
failing_host_label_pairs list[SourceLabelPair] Failing host/metric pairs [optional]
hidden bool [optional]
hosts_used list[str] Number of hosts checked by the alert condition [optional]
id str [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]
in_trash bool [optional]
include_obsolete_metrics bool Whether to include obsolete metrics in alert query [optional]
ingestion_policy_id str Get the ingestion policy Id associated with ingestion policy alert. [optional]
last_error_message str The last error encountered when running this alert's condition query [optional]
last_event_time int Start time (in epoch millis) of the last event associated with this alert. [optional]
last_failed_time int The time of the last error encountered when running this alert's condition query, in epoch millis [optional]
last_notification_millis int When this alert last caused a notification, in epoch millis [optional]
last_processed_millis int The time when this alert was last checked, in epoch millis [optional]
last_query_time int Last query time of the alert, averaged on hourly basis [optional]
metrics_used list[str] Number of metrics checked by the alert condition [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
modify_acl_access bool Whether the user has modify ACL access to the alert. [optional]
name str
no_data_event Event No data event related to the alert [optional]
notificants list[str] A derived field listing the webhook ids used by this alert [optional]
notification_resend_frequency_minutes int How often to re-trigger a continually failing alert. If absent or <= 0, no retriggering occurs [optional]
num_points_in_failure_frame int Number of points scanned in alert query time frame. [optional]
orphan bool [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]
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 &quot;minutes&quot; parameter [optional]
process_rate_minutes int The interval between checks for this alert, in minutes. Defaults to 5 minutes [optional]
query_failing bool Whether there was an exception when the alert condition last ran [optional]
query_syntax_error bool Whether there was an query syntax exception when the alert condition last ran [optional]
resolve_after_minutes int The number of consecutive minutes that a firing series matching the condition query must evaluate to &quot;false&quot; (zero value) before the alert resolves. When unset, this defaults to the same value as &quot;minutes&quot; [optional]
runbook_links list[str] User-supplied runbook links for this alert. Useful for linking wiki page or documentation, etc to refer to when alert is triggered [optional]
secure_metric_details bool Whether to secure sensitive metric details and alert images in alert notifications, to not break Metrics Security. [optional]
service list[str] Lists the services from the failingHostLabelPair of the alert. [optional]
severity str Severity of the alert [optional]
severity_list list[str] Alert severity list for multi-threshold type. [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]
sort_attr int Attribute used for default alert sort that is derived from state and severity [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]
system_alert_version int If this is a system alert, the version of it [optional]
system_owned bool Whether this alert is system-owned and not writeable [optional]
tagpaths list[str] [optional]
tags WFTags [optional]
target str The email address or integration endpoint (such as PagerDuty or web hook) to notify when the alert status changes. Comma-separated list of targets. Multiple target types can be in the list. Alert target format: ({email} pd:{pd_key}
target_endpoints list[str] [optional]
target_info list[TargetInfo] List of alert targets display information that includes name, id and type. [optional]
targets dict(str, str) Targets for severity. [optional]
triage_dashboards list[TriageDashboard] Deprecated for alertTriageDashboards [optional]
update_user_id str The user that last updated this alert [optional]
updated int When the alert was last updated, in epoch millis [optional]
updated_epoch_millis int [optional]
updater_id str [optional]

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