You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Alert.md
+27-26Lines changed: 27 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -7,52 +7,53 @@ Name | Type | Description | Notes
7
7
**name** | **str** | |
8
8
**id** | **str** | | [optional]
9
9
**target** | **str** | The email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes |
10
-
**event** | [**Event**](Event.md) | | [optional]
11
10
**tags** | [**WFTags**](WFTags.md) | | [optional]
12
-
**target_info** | [**list[TargetInfo]**](TargetInfo.md) | List of alert targets display information that includes name, id and type. | [optional]
13
-
**sort_attr** | **int** | Attribute used for default alert sort that is derived from state and severity | [optional]
14
11
**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]
15
-
**process_rate_minutes** | **int** | The interval between checks for this alert, in minutes. Defaults to 1 minute | [optional]
16
-
**last_processed_millis** | **int** | The time when this alert was last checked, in epoch millis | [optional]
17
-
**update_user_id** | **str** | The user that last updated this alert | [optional]
18
-
**last_query_time** | **int** | Last query time of the alert, averaged on hourly basis | [optional]
19
-
**notificants** | **list[str]** | A derived field listing the webhook ids used by this alert | [optional]
20
-
**alerts_last_day** | **int** | | [optional]
21
-
**alerts_last_week** | **int** | | [optional]
22
-
**alerts_last_month** | **int** | | [optional]
23
-
**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]
24
-
**in_maintenance_host_label_pairs** | [**list[SourceLabelPair]**](SourceLabelPair.md) | Lists the sources that will not be checked for this alert, due to matching a maintenance window | [optional]
**active_maintenance_windows** | **list[str]** | The names of the active maintenance windows that are affecting this alert | [optional]
27
-
**prefiring_host_label_pairs** | [**list[SourceLabelPair]**](SourceLabelPair.md) | 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]
28
-
**in_trash** | **bool** | | [optional]
29
-
**query_failing** | **bool** | Whether there was an exception when the alert condition last ran | [optional]
30
-
**updated** | **int** | When the alert was last updated, in epoch millis | [optional]
31
-
**create_user_id** | **str** | | [optional]
32
12
**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]
33
13
**condition_qb_enabled** | **bool** | Whether the condition query was created using the Query Builder. Default false | [optional]
34
14
**display_expression_qb_enabled** | **bool** | Whether the display expression query was created using the Query Builder. Default false | [optional]
35
15
**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 |
36
16
**condition_qb_serialization** | **str** | The special serialization of the Query Builder that corresponds to the condition query. Applicable only when conditionQBEnabled is true | [optional]
37
17
**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]
18
+
**include_obsolete_metrics** | **bool** | Whether to include obsolete metrics in alert query | [optional]
38
19
**severity** | **str** | Severity of the alert |
39
-
**metrics_used** | **list[str]** | Number of metrics checked by the alert condition | [optional]
40
-
**created** | **int** | When this alert was created, in epoch millis | [optional]
41
20
**creator_id** | **str** | | [optional]
42
-
**updater_id** | **str** | | [optional]
43
-
**deleted** | **bool** | | [optional]
44
21
**additional_information** | **str** | User-supplied additional explanatory information for this alert. Useful for linking runbooks, mitigations,, etc | [optional]
45
22
**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]
23
+
**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 |
**query_failing** | **bool** | Whether there was an exception when the alert condition last ran | [optional]
46
26
**last_failed_time** | **int** | The time of the last error encountered when running this alert's condition query, in epoch millis | [optional]
47
27
**last_error_message** | **str** | The last error encountered when running this alert's condition query | [optional]
28
+
**metrics_used** | **list[str]** | Number of metrics checked by the alert condition | [optional]
48
29
**hosts_used** | **list[str]** | Number of hosts checked by the alert condition | [optional]
30
+
**in_maintenance_host_label_pairs** | [**list[SourceLabelPair]**](SourceLabelPair.md) | Lists the sources that will not be checked for this alert, due to matching a maintenance window | [optional]
31
+
**active_maintenance_windows** | **list[str]** | The names of the active maintenance windows that are affecting this alert | [optional]
32
+
**prefiring_host_label_pairs** | [**list[SourceLabelPair]**](SourceLabelPair.md) | 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]
33
+
**notificants** | **list[str]** | A derived field listing the webhook ids used by this alert | [optional]
34
+
**last_processed_millis** | **int** | The time when this alert was last checked, in epoch millis | [optional]
35
+
**process_rate_minutes** | **int** | The interval between checks for this alert, in minutes. Defaults to 1 minute | [optional]
49
36
**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]
50
37
**last_notification_millis** | **int** | When this alert last caused a notification, in epoch millis | [optional]
51
38
**notification_resend_frequency_minutes** | **int** | How often to re-trigger a continually failing alert. If absent or <= 0, no retriggering occurs | [optional]
52
-
**include_obsolete_metrics** | **bool** | Whether to include obsolete metrics in alert query | [optional]
53
39
**created_epoch_millis** | **int** | | [optional]
54
40
**updated_epoch_millis** | **int** | | [optional]
55
-
**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 |
41
+
**event** | [**Event**](Event.md) | | [optional]
42
+
**updater_id** | **str** | | [optional]
43
+
**created** | **int** | When this alert was created, in epoch millis | [optional]
44
+
**updated** | **int** | When the alert was last updated, in epoch millis | [optional]
45
+
**update_user_id** | **str** | The user that last updated this alert | [optional]
46
+
**last_query_time** | **int** | Last query time of the alert, averaged on hourly basis | [optional]
47
+
**alerts_last_day** | **int** | | [optional]
48
+
**alerts_last_week** | **int** | | [optional]
49
+
**alerts_last_month** | **int** | | [optional]
50
+
**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]
51
+
**no_data_event** | [**Event**](Event.md) | No data event related to the alert | [optional]
52
+
**in_trash** | **bool** | | [optional]
53
+
**create_user_id** | **str** | | [optional]
54
+
**deleted** | **bool** | | [optional]
55
+
**target_info** | [**list[TargetInfo]**](TargetInfo.md) | List of alert targets display information that includes name, id and type. | [optional]
56
+
**sort_attr** | **int** | Attribute used for default alert sort that is derived from state and severity | [optional]
56
57
57
58
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**client_id** | **str** | Client Id for an Azure service account within your project. |
7
7
**tenant** | **str** | Tenant Id for an Azure service account within your project. |
8
-
**client_secret** | **str** | Client Secret for an Azure service account within your project. |
8
+
**client_secret** | **str** | Client Secret for an Azure service account within your project. Use 'saved_secret' to retain the client secret when updating. |
9
9
10
10
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**no_default_events** | **bool** | Whether to hide events related to the sources in the charts produced. Default false (i.e. shows events) | [optional]
11
+
**base** | **int** | If the chart has a log-scale Y-axis, the base for the logarithms | [optional]
12
+
**units** | **str** | String to label the units of the chart on the Y-axis | [optional]
13
+
**chart_attributes** | [**JsonNode**](JsonNode.md) | Experimental field for chart attributes | [optional]
14
14
**interpolate_points** | **bool** | Whether to interpolate points in the charts produced. Default: true | [optional]
**summarization** | **str** | Summarization strategy for the chart. MEAN is default | [optional]
16
17
17
18
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
Copy file name to clipboardExpand all lines: docs/ChartSettings.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,12 @@ Name | Type | Description | Notes
6
6
**type** | **str** | Chart Type. 'line' refers to the Line Plot, 'scatter' to the Point Plot, 'stacked-area' to the Stacked Area plot, 'table' to the Tabular View, 'scatterploy-xy' to Scatter Plot, 'markdown-widget' to the Markdown display, and 'sparkline' to the Single Stat view |
7
7
**min** | **float** | Min value of Y-axis. Set to null or leave blank for auto | [optional]
8
8
**max** | **float** | Max value of Y-axis. Set to null or leave blank for auto | [optional]
9
+
**expected_data_spacing** | **int** | Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid line in line plots. Default: 60s | [optional]
9
10
**plain_markdown_content** | **str** | The Markdown content for a Markdown display, in plain text. Use this field instead of `markdownContent`. | [optional]
11
+
**fixed_legend_enabled** | **bool** | Whether to enable a fixed tabular legend adjacent to the chart | [optional]
12
+
**fixed_legend_use_raw_stats** | **bool** | If true, the legend uses non-summarized stats instead of summarized | [optional]
10
13
**line_type** | **str** | Plot interpolation type. linear is default | [optional]
11
14
**stack_type** | **str** | Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means Normalized from 0 to 1. wiggle means Minimize weighted changes. silhouette means to Center the Stream | [optional]
12
-
**expected_data_spacing** | **int** | Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid line in line plots. Default: 60s | [optional]
13
15
**windowing** | **str** | For the tabular view, whether to use the full time window for the query or the last X minutes | [optional]
14
16
**window_size** | **int** | Width, in minutes, of the time window to use for \"last\" windowing | [optional]
15
17
**show_hosts** | **bool** | For the tabular view, whether to display sources. Default: true | [optional]
@@ -30,15 +32,13 @@ Name | Type | Description | Notes
30
32
**y0_unit_autoscaling** | **bool** | Default: false. Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units | [optional]
31
33
**y1_unit_autoscaling** | **bool** | Default: false. Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units | [optional]
32
34
**invert_dynamic_legend_hover_control** | **bool** | Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed) | [optional]
33
-
**fixed_legend_enabled** | **bool** | Whether to enable a fixed tabular legend adjacent to the chart | [optional]
34
-
**fixed_legend_use_raw_stats** | **bool** | If true, the legend uses non-summarized stats instead of summarized | [optional]
35
35
**fixed_legend_position** | **str** | Where the fixed legend should be displayed with respect to the chart | [optional]
36
36
**fixed_legend_display_stats** | **list[str]** | For a chart with a fixed legend, a list of statistics to display in the legend | [optional]
37
37
**fixed_legend_filter_sort** | **str** | Whether to display \"Top\"- or \"Bottom\"-ranked series in the fixed legend | [optional]
38
-
**xmax** | **float** | For x-y scatterplots, max value for X-axis. Set null for auto | [optional]
39
38
**fixed_legend_filter_limit** | **int** | Number of series to include in the fixed legend | [optional]
40
39
**fixed_legend_filter_field** | **str** | Statistic to use for determining whether a series is displayed on the fixed legend | [optional]
**query** | **str** | Query expression to plot on the chart |
8
+
**disabled** | **bool** | Whether the source is disabled | [optional]
9
+
**secondary_axis** | **bool** | Determines if this source relates to the right hand Y-axis or not | [optional]
8
10
**scatter_plot_source** | **str** | For scatter plots, does this query source the X-axis or the Y-axis | [optional]
9
11
**querybuilder_serialization** | **str** | Opaque representation of the querybuilder | [optional]
10
12
**querybuilder_enabled** | **bool** | Whether or not this source line should have the query builder enabled | [optional]
11
-
**secondary_axis** | **bool** | Determines if this source relates to the right hand Y-axis or not | [optional]
12
13
**source_description** | **str** | A description for the purpose of this source | [optional]
13
14
**source_color** | **str** | The color used to draw all results from this source (auto if unset) | [optional]
14
-
**disabled** | **bool** | Whether the source is disabled | [optional]
15
15
16
16
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
0 commit comments