Skip to content

Commit 7ab4ecd

Browse files
Merge branch 'master' into dev/simpler-url-parsing-in-sub-url-hooks
2 parents e373d73 + 2565084 commit 7ab4ecd

File tree

538 files changed

+8632
-3879
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

538 files changed

+8632
-3879
lines changed

.eslintrc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,7 @@ module.exports = {
491491
'x-pack/dev-tools/mocha/setup_mocha.js',
492492
'x-pack/scripts/*.js',
493493
],
494+
excludedFiles: ['**/integration_tests/**/*'],
494495
rules: {
495496
'import/no-commonjs': 'off',
496497
'prefer-object-spread/prefer-object-spread': 'off',

.i18nrc.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,7 @@
5252
"visTypeVega": "src/legacy/core_plugins/vis_type_vega",
5353
"visTypeVislib": "src/legacy/core_plugins/vis_type_vislib",
5454
"visTypeXy": "src/legacy/core_plugins/vis_type_xy",
55-
"visualizations": [
56-
"src/plugins/visualizations",
57-
"src/legacy/core_plugins/visualizations"
58-
]
55+
"visualizations": "src/plugins/visualizations"
5956
},
6057
"exclude": [
6158
"src/legacy/ui/ui_render/ui_render_mixin.js"

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
search: {
1111
aggs: {
1212
AggConfigs: typeof AggConfigs;
13-
aggGroupNamesMap: () => Record<"buckets" | "metrics", string>;
13+
aggGroupNamesMap: () => Record<"metrics" | "buckets", string>;
1414
aggTypeFilters: import("./search/aggs/filter/agg_type_filters").AggTypeFilters;
1515
CidrMask: typeof CidrMask;
1616
convertDateRangeToString: typeof convertDateRangeToString;

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
| Function | Description |
2424
| --- | --- |
2525
| [getDefaultSearchParams(config)](./kibana-plugin-plugins-data-server.getdefaultsearchparams.md) | |
26+
| [getTotalLoaded({ total, failed, successful })](./kibana-plugin-plugins-data-server.gettotalloaded.md) | |
2627
| [parseInterval(interval)](./kibana-plugin-plugins-data-server.parseinterval.md) | |
2728
| [plugin(initializerContext)](./kibana-plugin-plugins-data-server.plugin.md) | Static code to be shared externally |
2829
| [shouldReadFieldFromDocValues(aggregatable, esType)](./kibana-plugin-plugins-data-server.shouldreadfieldfromdocvalues.md) | |
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[role="xpack"]
2+
[[alert-details]]
3+
=== Alert details
4+
5+
beta[]
6+
7+
The *Alert details* page tells you about the state of the alert and provides granular control over the actions it is taking.
8+
9+
[role="screenshot"]
10+
image::images/alerts-details-instances-active.png[Alert details page with three alert instances]
11+
12+
In this example, alerts detect when a site serves more than a threshold number of bytes in a 24 hour period. Three sites are above the threshold. These are called alert instances - occurrences of the condition being detected - and the instance name, status, time of detection, and duration of the condition are shown in this view.
13+
14+
Upon detection, each instance can trigger one or more actions. If the condition persists, the same actions will trigger either on the next scheduled alert check, or (if defined) after the re-notify period on the alert has passed. To prevent re-notification, you can suppress future actions by clicking on the eye icon to mute an individual alert instance. Muting means that the alert checks continue to run on a schedule, but that instance will not trigger any action.
15+
16+
[role="screenshot"]
17+
image::images/alerts-details-instance-muting.png[Muting an alert instance]
18+
19+
Alert instances will come and go from the list depending on whether they meet the alert conditions or not - unless they are muted. If a muted instance no longer meets the alert conditions, it will appear as inactive in the list. This prevents an instance from triggering actions if it reappears in the future.
20+
21+
[role="screenshot"]
22+
image::images/alerts-details-instances-inactive.png[Alert details page with three inactive alert instances]
23+
24+
If you want to suppress actions on all current and future instances, you can mute the entire alert. Alert checks continue to run and the instance list will update as instances activate or deactivate, but no actions will be triggered.
25+
26+
[role="screenshot"]
27+
image::images/alerts-details-muting.png[Use the mute toggle to suppress all action on current and future instances]
28+
29+
You can also disable an alert altogether. When disabled, the alert stops running checks altogether and will clear any instances it is tracking. You may want to disable alerts that are not currently needed to reduce the load on {kib} and {es}.
30+
31+
[role="screenshot"]
32+
image::images/alerts-details-disabling.png[Use the disable toggle to turn off alert checks and clear instances tracked]
33+
34+
* For further information on alerting concepts and examples, see <<alerting-getting-started>>.
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
[role="xpack"]
2+
[[alert-management]]
3+
=== Managing Alerts
4+
5+
beta[]
6+
7+
The *Alerts* tab provides a cross-app view of alerting. Different {kib} apps like <<xpack-infra, Metrics>>, <<xpack-apm, APM>>, <<xpack-uptime, Uptime>>, and <<xpack-siem, SIEM>> can offer their own alerts, and the *Alerts* tab provides a central place to:
8+
9+
* <<create-edit-alerts, Create and edit>> alerts
10+
* <<controlling-alerts, Control alerts>> including enabling/disabling, muting/unmuting, and deleting
11+
* Drill-down to <<alert-details, alert details>>
12+
13+
[role="screenshot"]
14+
image:management/alerting/images/alerts-and-actions-ui.png[Example alert listing in the Alerts and Actions UI]
15+
16+
For more information on alerting concepts and the types of alerts and actions available, see <<alerting-getting-started>>.
17+
18+
[float]
19+
==== Finding alerts
20+
21+
The *Alerts* tab lists all alerts in the current space, including summary information about their execution frequency, tags, and type.
22+
23+
The *search bar* can be used to quickly find alerts by name or tag.
24+
25+
[role="screenshot"]
26+
image::images/alerts-filter-by-search.png[Filtering the alerts list using the search bar]
27+
28+
The *type* dropdown lets you filter to a subset of alert types.
29+
30+
[role="screenshot"]
31+
image::images/alerts-filter-by-type.png[Filtering the alerts list by types of alert]
32+
33+
The *Action type* dropdown lets you filter by the type of action used in the alert.
34+
35+
[role="screenshot"]
36+
image::images/alerts-filter-by-action-type.png[Filtering the alert list by type of action]
37+
38+
[float]
39+
[[create-edit-alerts]]
40+
==== Creating and editing alerts
41+
42+
Many alerts must be created within the context of a {kib} app like <<xpack-infra, Metrics>>, <<xpack-apm, APM>>, or <<xpack-uptime, Uptime>>, but others are generic. Generic alert types can be created in the *Alerts* management UI by clicking the *Create* button. This will launch a flyout that guides you through selecting an alert type and configuring it's properties. Refer to <<alert-types>> for details on what types of alerts are available and how to configure them.
43+
44+
After an alert is created, you can re-open the flyout and change an alerts properties by clicking the *Edit* button shown on each row of the alert listing.
45+
46+
47+
[float]
48+
[[controlling-alerts]]
49+
==== Controlling alerts
50+
51+
The alert listing allows you to quickly mute/unmute, disable/enable, and delete individual alerts by clicking the action button at the right of each row.
52+
53+
[role="screenshot"]
54+
image:management/alerting/images/individual-mute-disable.png[The actions button allows an individual alert to be muted, disabled, or deleted]
55+
56+
These operations can also be performed in bulk by multi-selecting alerts and clicking the *Manage alerts* button:
57+
58+
[role="screenshot"]
59+
image:management/alerting/images/bulk-mute-disable.png[The Manage alerts button lets you mute/unmute, enable/disable, and delete in bulk]
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[role="xpack"]
2+
[[managing-alerts-and-actions]]
3+
== Alerts and Actions
4+
5+
beta[]
6+
7+
The *Alerts and Actions* UI lets you <<alert-management, see and control all the alerts>> in a space, and provides tools to <<connector-management, create and manage connectors>> so that alerts can trigger actions like notification, indexing, and ticketing.
8+
9+
To manage alerting and connectors, go to *Management > {kib} > Alerts and Actions*.
10+
11+
[role="screenshot"]
12+
image:management/alerting/images/alerts-and-actions-ui.png[Example alert listing in the Alerts and Actions UI]
13+
14+
[NOTE]
15+
============================================================================
16+
Similar to dashboards, alerts and connectors reside in a <<xpack-spaces, space>>.
17+
The *Alerts and Actions* UI only shows alerts and connectors for the current space.
18+
============================================================================
19+
20+
[NOTE]
21+
============================================================================
22+
{es} also offers alerting capabilities through Watcher, which
23+
can be managed through the <<watcher-ui, Watcher UI>>. See
24+
<<alerting-concepts-differences>> for more information.
25+
============================================================================
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
[role="xpack"]
2+
[[connector-management]]
3+
=== Managing Connectors
4+
5+
beta[]
6+
7+
Alerts use *Connectors* to route actions to different destinations like log files, ticketing systems, and messaging tools. While each {kib} app can offer their own types of alerts, they typically share connectors. The *Connectors* tab offers a central place to view and manage all the connectors in the current space.
8+
9+
For more information on connectors and the types of actions available see <<action-types>>.
10+
11+
[role="screenshot"]
12+
image::images/connector-listing.png[Example connector listing in the Alerts and Actions UI]
13+
14+
15+
[float]
16+
==== Connector list
17+
18+
The *Connectors* tab lists all connectors in the current space. The *search bar* can be used to find specific connectors by name and/or type.
19+
20+
[role="screenshot"]
21+
image::images/connector-filter-by-search.png[Filtering the connector list using the search bar]
22+
23+
24+
The *type* dropdown also lets you filter to a subset of action types.
25+
26+
[role="screenshot"]
27+
image::images/connector-filter-by-type.png[Filtering the connector list by types of actions]
28+
29+
The *Actions* column indicates the number of actions that reference the connector. This count helps you confirm a connector is unused before you delete it, and tells you how many actions will be affected when a connector is modified.
30+
31+
[role="screenshot"]
32+
image::images/connector-action-count.png[Filtering the connector list by types of actions]
33+
34+
You can delete individual connectors using the trash icon on the right of each row. Connectors can also be deleted in bulk by multi-selecting them and clicking the *Delete* button to the left of the search box.
35+
36+
[role="screenshot"]
37+
image::images/connector-delete.png[Deleting connectors individually or in bulk]
38+
39+
[NOTE]
40+
============================================================================
41+
You can delete a connector even if there are still actions referencing it.
42+
When this happens the action will fail to execute, and appear as errors in the {kib} logs.
43+
============================================================================
44+
45+
==== Creating a new connector
46+
47+
New connectors can be created by clicking the *Create connector* button, which will guide you to select the type of connector and configure it's properties. Refer to <<action-types>> for the types of connectors available and how to configure them. Once you create a connector it will be made available to you anytime you set up an action in the current space.
160 KB
Loading
19 KB
Loading

0 commit comments

Comments
 (0)