Skip to content

Commit 1f33cfe

Browse files
authored
Merge branch 'main' into 3183-ms-defender-for-endpoint
2 parents 07679a8 + 54e34f6 commit 1f33cfe

File tree

90 files changed

+438
-244
lines changed

Some content is hidden

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

90 files changed

+438
-244
lines changed

deploy-manage/deploy/elastic-cloud/regions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ The following AWS regions are currently available:
2626

2727
| Region | Name |
2828
| :--- | :--- |
29+
| ap-northeast-1 | Asia Pacific (Tokyo) |
2930
| ap-southeast-1 | Asia Pacific (Singapore) |
3031
| eu-central-1 | Europe (Frankfurt) |
3132
| eu-west-1 | Europe (Ireland) |
33+
| eu-west-2 | Europe (London) |
3234
| us-east-1 | US East (N. Virginia) |
3335
| us-east-2 | US East (Ohio) |
3436
| us-west-2 | US West (Oregon) |

deploy-manage/security/private-connectivity-aws.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ If the policy doesn't contain a VPC filter, then the association can serve as a
301301
302302
## Access the deployment over a PrivateLink [ec-access-the-deployment-over-private-link]
303303
304-
For traffic to connect with the deployment over Azure PrivateLink, the client making the request needs to be located within the VPC where you’ve created the VPC endpoint. You can also set up network traffic to flow through the originating VPC from somewhere else, such as another VPC or VPN from your corporate network. This assumes that the VPC endpoint and the DNS record are also available within that context. Check your service provider documentation for setup instructions.
304+
For traffic to connect with the deployment over AWS PrivateLink, the client making the request needs to be located within the VPC where you’ve created the VPC endpoint. You can also set up network traffic to flow through the originating VPC from somewhere else, such as another VPC or VPN from your corporate network. This assumes that the VPC endpoint and the DNS record are also available within that context. Check your service provider documentation for setup instructions.
305305
306306
::::{important}
307307
Use the alias you’ve set up as CNAME DNS record to access your deployment.
@@ -408,4 +408,4 @@ To delete a policy:
408408
409409
:::{include} _snippets/network-security-page.md
410410
:::
411-
4. Find the policy you want to edit, then click the **Delete** icon. The icon is inactive if there are deployments associated with the policy.
411+
4. Find the policy you want to edit, then click the **Delete** icon. The icon is inactive if there are deployments associated with the policy.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
To add a Discover query to a dashboard in a way that preserves the [controls created from Discover](/explore-analyze/discover/try-esql.md#add-variable-control-discover) and also adds them to the dashboard, do as follows:
2+
3+
1. Save the {{esql}} query containing the variable control into a Discover session. If your Discover session contains several tabs, only the first tab will be imported to the dashboard.
4+
5+
1. Go to **Dashboards** and open or create one.
6+
7+
1. Select **Add**, then **From library**.
8+
9+
1. Find and select the Discover session you saved earlier.
10+
11+
A new panel appears on the dashboard with the results of the query along with any attached controls.
12+
13+
![Importing Discover controls into a dashboard](/explore-analyze/images/import-discover-control-dashboard.png " =40%")
14+
15+
:::{note}
16+
When you add a visualization to a dashboard using the {icon}`save` **Save visualization** option, controls are not added to the dashboard.
17+
:::
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
**Examples**
2+
3+
* Integrate filtering into your {{esql}} experience
4+
5+
```esql
6+
| WHERE field == ?value
7+
```
8+
9+
* Fields in controls for dynamic group by
10+
11+
```esql
12+
| STATS count=COUNT(*) BY ??field
13+
```
14+
15+
* Variable time ranges? Bind function configuration settings to a control
16+
17+
```esql
18+
| BUCKET(@timestamp, ?interval),
19+
```
20+
21+
* Make the function itself dynamic
22+
23+
```esql
24+
| STATS metric = ??function
25+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
* The type of the control.
2+
* For controls with **Static values**, enter available controls manually or select them from the dropdown list.
3+
* For controls with **Values from a query**, write an {{esql}} query to populate the list of options.
4+
* The name of the control. This name is used to reference the control in {{esql}} queries.
5+
* Start the name with `?` if you want the options to be simple static values.
6+
* {applies_to}`stack: ga 9.1` Start the name with `??` if you want the options to be fields or functions.
7+
* The values users can select for this control. You can add multiple values from suggested fields, or type in custom values. If you selected **Values from a query**, you must instead write an {{esql}} query at this step.
8+
* The label of the control. This is the label displayed in **Discover** or in the dashboard.
9+
* The width of the control.
10+
11+
![ESQL control settings](/explore-analyze/images/esql-visualization-control-settings.png "title =50%")

explore-analyze/dashboards/add-controls.md

Lines changed: 16 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,10 @@ You can add one interactive time slider control to a dashboard.
9090

9191

9292
## Add variable controls [add-variable-control]
93+
```{applies_to}
94+
stack: preview 9.0
95+
serverless: preview
96+
```
9397

9498
:::{note}
9599
In versions `9.0` and `9.1`, variable controls are called {{esql}} controls.
@@ -113,17 +117,8 @@ Only **Options lists** are supported for {{esql}}-based controls. Options can be
113117

114118
2. A menu opens to let you configure the control. This is where you can specify:
115119

116-
* The type of the control.
117-
* For controls with **Static values**, select the options available in the controls by entering them manually or by using a dropdown listing available values.
118-
* For controls with **Values from a query**, write an {{esql}} query to populate the list of options.
119-
* The name of the control. This name is used to reference the control in {{esql}} queries.
120-
* Start the name with `?` if you want the options to be simple static values.
121-
* Start the name with `??` if you want the options of the control to be fields or functions. {applies_to}`stack: ga 9.1`
122-
* The values users can select for this control. You can add multiple values from suggested fields, or type in custom values. If you selected **Values from a query**, you must instead write an {{esql}} query at this step.
123-
* The label of the control. This is the label displayed for users viewing the dashboard for that control.
124-
* The width of the control.
125-
126-
![ESQL control settings](/explore-analyze/images/esql-visualization-control-settings.png "title =50%")
120+
:::{include} ../_snippets/variable-control-form.md
121+
:::
127122

128123
3. Save the control.
129124

@@ -132,34 +127,19 @@ If you added it by starting from a query, the control is directly inserted in th
132127

133128
You can then insert it in any other {{esql}} visualization queries by typing the control's name.
134129

130+
:::{include} ../_snippets/variable-control-examples.md
131+
:::
135132

136-
**Examples**
137-
138-
* Integrate filtering into your {{esql}} experience
139-
140-
```esql
141-
| WHERE field == ?value
142-
```
143-
144-
* Fields in controls for dynamic group by
145-
146-
```esql
147-
| STATS count=COUNT(*) BY ?field
148-
```
149-
150-
* Variable time ranges? Bind function configuration settings to a control
151-
152-
```esql
153-
| BUCKET(@timestamp, ?interval),
154-
```
155-
156-
* Make the function itself dynamic
133+
![Editing {{esql}} controls from a dashboard](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte42dfaa404bfc2d6/67d2e31e2e4dc59da190d78f/dashboard-esql-controls.gif)
157134

158-
```esql
159-
| STATS metric = ?function
160-
```
135+
### Import a Discover query along with its controls into a dashboard
136+
```{applies_to}
137+
stack: preview 9.2
138+
serverless: preview
139+
```
161140

162-
![Editing {{esql}} controls from a dashboard](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte42dfaa404bfc2d6/67d2e31e2e4dc59da190d78f/dashboard-esql-controls.gif)
141+
:::{include} ../_snippets/import-discover-query-controls-into-dashboard.md
142+
:::
163143

164144
## Configure the controls settings [configure-controls-settings]
165145

explore-analyze/dashboards/using.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/kibana/current/_use_and_filter_dashboards.html
4+
description: Learn how to explore and interact with Kibana dashboards using filters, time ranges, and controls to uncover insights in your data.
45
applies_to:
56
stack: ga
67
serverless: ga
@@ -10,6 +11,11 @@ products:
1011

1112
# Exploring dashboards [_use_and_filter_dashboards]
1213

14+
Kibana dashboards support filtering, time range adjustments, and interactive controls that let you focus on specific data segments or time periods.
15+
16+
This page covers the main ways to explore dashboard data: using KQL queries, filter pills, time ranges, and dashboard controls. You'll also learn how to view underlying data and switch between different display modes.
17+
18+
1319

1420
## Search and filter your dashboard data [search-or-filter-your-data]
1521

@@ -23,6 +29,20 @@ products:
2329

2430
This section shows the most common ways for you to filter dashboard data. For more information about {{kib}} and {{es}} filtering capabilities, refer to [](/explore-analyze/query-filter.md).
2531

32+
### Filter dashboards using the KQL query bar [_filter_dashboards_using_the_kql_query_bar]
33+
34+
The query bar lets you build filters using [{{kib}} Query Language (KQL)](../query-filter/languages/kql.md). When typing, it dynamically suggests matching fields, operators, and values to help you get the exact results that you want.
35+
36+
You can use KQL to create complex queries that filter your dashboard data. For example:
37+
- `status:error` to show only error records
38+
- `response_time > 1000` to display requests slower than 1 second
39+
- `user.name:"john doe" AND status:active` to combine multiple conditions
40+
41+
:::{tip}
42+
:applies_to: {"stack": "preview 9.2", "serverless": "unavailable"}
43+
When working with large datasets, complex KQL queries might cause dashboards to load slowly. In versions 9.2 and later, you can [send long-running searches to the background](../discover/background-search.md) and continue working on other tasks while the data loads.
44+
:::
45+
2646

2747
### Use filter pills [_use_filter_pills]
2848

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
navigation_title: "Run queries in the background"
3+
mapped_pages:
4+
- https://www.elastic.co/guide/en/kibana/current/search-sessions.html
5+
applies_to:
6+
stack: preview 9.2
7+
serverless: unavailable
8+
products:
9+
- id: kibana
10+
description: Send your long-running queries to run in the background with background searches and search sessions, and focus on your other tasks while they complete.
11+
---
12+
13+
# Run Discover and Dashboards queries in the background
14+
15+
::::{important} - Background search replaces Search sessions
16+
17+
Background search is a feature introduced in version 9.2. It replaces the deprecated **Search sessions** feature.
18+
If you have been using search sessions and upgrade to 9.2, your search sessions aren't lost and become background searches.
19+
::::
20+
21+
Sometimes you might need to search through large amounts of data, no matter how long the search takes. Consider a threat hunting scenario, where you need to search through years of data.
22+
23+
You can send your long-running searches to the background from **Discover** or **Dashboards** and let them run while you continue your work.
24+
25+
You can access your list of background searches at any time to check their status and manage them from the {icon}`background_task` **Background searches** button in the toolbar.
26+
27+
![Send search to background](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/bltee31dcf0d3917c75/68ecf412e5bae49d65a286ff/background-search.gif " =75%")
28+
29+
30+
## Enable background searches
31+
32+
This feature is disabled by default. You can enable background searches in versions 9.2 and later, or search sessions in versions 9.1 and earlier, by setting [`data.search.sessions.enabled`](kibana://reference/configuration-reference/search-sessions-settings.md) to `true` in the [`kibana.yml`](/deploy-manage/stack-settings.md) configuration file.
33+
34+
:::{note} - Exception for search sessions users
35+
If you upgrade to version 9.2 or later with search sessions enabled in the version you upgrade from, background searches are automatically enabled.
36+
:::
37+
38+
## Usage requirements [_requirements]
39+
40+
The background searches that you run are personal and only visible by you. To use this feature, you must have the following minimum permissions:
41+
42+
:::::{tab-set}
43+
:group: background search
44+
45+
::::{tab-item} 9.2 and later
46+
:sync: 92
47+
To send searches to the background, and to view and interact with the list of background searches from **Discover** and **Dashboards** apps, you must have permissions for **Discover** and **Dashboard**, and for the [Background search subfeature](../../deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md#kibana-feature-privileges).
48+
::::
49+
50+
::::{tab-item} 9.1 and earlier
51+
:sync: 91
52+
In versions 9.1 and earlier, this feature is named **Search sessions**.
53+
* To save a session, you must have permissions for **Discover** and **Dashboard**, and the [Search sessions subfeature](../../deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md#kibana-feature-privileges).
54+
* To view and restore a saved session, you must have access to **Stack Management**.
55+
::::
56+
57+
:::::
58+
59+
## Send a search to the background
60+
61+
You can send a search to the background only after it starts running. Until then, the **Send to background** button is disabled.
62+
63+
1. Write or edit the query.
64+
65+
1. Select {icon}`play` **Run** (or {icon}`refresh` **Refresh** if you already ran the query at least once) to start executing the query. At this point, the {icon}`background_task` **Send to background** button becomes available.
66+
67+
1. Select {icon}`background_task` **Send to background**. The search is sent to the background and added to the queue of background searches.
68+
69+
You can resume your other tasks, for example start a new search, navigate to a different application, or close the browser. Once the search has completed, a notification informs you and lets you access the search to view its results.
70+
71+
Background searches expire after 7 days. Beyond that period, you must run the search again. You can change this default value by editing the [`data.search.sessions.defaultExpiration`](kibana://reference/configuration-reference/search-sessions-settings.md) setting.
72+
73+
## Reopen or manage background searches
74+
75+
From the list of background searches, you can reopen and edit any searches, but also extend their validity period or delete them to keep only searches that you care about.
76+
77+
1. Open your list of background searches using one of the following methods:
78+
- Once a background search is sent to the background, a notification appears to inform you, with a link to open the list of background searches.
79+
- If you miss the notification or need to access this list at any time, go to **Discover** or **Dashboards** and select the {icon}`background_task` **Background searches** button in the toolbar. This option is only available from version 9.2.
80+
81+
:::{tip}
82+
From **Discover**, you can only view Discover background searches. And from **Dashboards**, you can only see Dashboards background searches.
83+
:::
84+
- Open the **Background Search** management page in {{kib}}.
85+
86+
1. Find the background search that you want to interact with using the search or status filter options.
87+
- To open it to view its results and continue your explorations, select its name. Relative dates are converted to absolute dates.
88+
- To rename it, select the {icon}`boxes_horizontal` **More actions** button, then select {icon}`pencil` **Edit name**. By default, background searches get default names that indicate their execution date and time.
89+
- To extend its current expiration date by another 7 days, select the {icon}`boxes_horizontal` More actions button, then select **Extend**.
90+
- To delete it, select the {icon}`boxes_horizontal` More actions button, then select {icon}`trash` **Delete**.
91+
92+
93+
## Background search limitations in dashboards [_limitations]
94+
95+
Some visualization features do not fully support background searches. When you restore a dashboard, panels with unsupported features won’t load immediately, but instead send out additional data requests, which can take a while to complete. The **Your background search is still running** warning appears. You can either wait for these additional requests to complete or come back to the dashboard later when all data requests have finished.
96+
97+
A panel on a dashboard can behave like this if one of the following features is used:
98+
99+
**Lens**
100+
101+
* A **top values** dimension with an enabled **Group other values as "Other"** setting. This is configurable in the **Advanced** section of the dimension.
102+
* An **intervals** dimension.
103+
104+
**Aggregation-based** visualizations
105+
106+
* A **terms** aggregation with an enabled **Group other values in separate bucket** setting.
107+
* A **histogram** aggregation.
108+
109+
**Maps**
110+
111+
* Layers using joins, blended layers, or tracks layers.

explore-analyze/discover/discover-get-started.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,14 @@ Learn more about how to use ES|QL queries in [Using ES|QL](try-esql.md).
308308
:::{include} ../_snippets/inspect-request.md
309309
:::
310310

311+
### Run long-running queries in the background
312+
```{applies_to}
313+
stack: ga 9.2
314+
serverless: unavailable
315+
```
316+
317+
You can send your long-running KQL or {{esql}} queries to the background from **Discover** and let them run while you continue exploring your data. Refer to [Run queries in the background](/explore-analyze/discover/background-search.md).
318+
311319

312320
### Save your Discover session for later use [save-discover-search]
313321

0 commit comments

Comments
 (0)