Skip to content

Commit fe50c52

Browse files
authored
Merge branch 'main' into rcs_kibana_ui_snippet
2 parents 71c8fcf + f8ae059 commit fe50c52

File tree

6 files changed

+87
-31
lines changed

6 files changed

+87
-31
lines changed

explore-analyze/dashboards/drilldowns.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,20 @@ The panels you create using the following editors support dashboard drilldowns:
4545
Use the [**Sample web logs**](../index.md#gs-get-data-into-kibana) data to create a dashboard and add panels, then set a search and filter on the **[Logs] Web Traffic** dashboard.
4646

4747
1. Add the **Sample web logs** data.
48-
2. Create a new dashboard, click **Add from Library**, then add the following panels:
48+
2. Create a new dashboard.
4949

50-
* **[Logs] Response Codes Over Time + Annotations**
51-
* **[Logs] Visits**
50+
* {applies_to}`stack: ga 9.2` Select **Add** > **From library** in the toolbar.
51+
* {applies_to}`stack: ga 9.0` Click **Add from library** in the dashboard toolbar.
5252

53-
3. Set the [time filter](../query-filter/filtering.md) to **Last 30 days**.
54-
4. Save the dashboard. In the **Title** field, enter `Detailed logs`.
55-
5. Open the **[Logs] Web Traffic** dashboard, then set a search and filter.
53+
3. Add the following panel:
5654

57-
Search: `extension.keyword: ("gz" or "css" or "deb")`<br> Filter: `geo.src: US`
55+
* **[Logs] Visits**
5856

57+
4. Set the [time filter](../query-filter/filtering.md) to **Last 30 days**.
58+
5. Save the dashboard. In the **Title** field, enter `Detailed logs`.
59+
6. Open the **[Logs] Web Traffic** dashboard, then set a search and filter.
5960

61+
Search: `extension.keyword: ("gz" or "css" or "deb")`<br> Filter: `geo.src: US`
6062

6163
### Create the dashboard drilldown [_create_the_dashboard_drilldown]
6264

@@ -77,8 +79,6 @@ Create a drilldown that opens the **Detailed logs** dashboard from the **[Logs]
7779
:screenshot:
7880
:::
7981

80-
81-
8282
## Create URL drilldowns [create-url-drilldowns]
8383

8484
URL drilldowns enable you to navigate from a dashboard to external websites. Destination URLs can be dynamic, depending on the dashboard context or user interaction with a panel. To create URL drilldowns, you add [variables](/explore-analyze/dashboards/drilldowns.md) to a URL template, which configures the behavior of the drilldown. All panels that you create with the visualization editors support dashboard drilldowns.
@@ -92,22 +92,23 @@ Some panels support multiple interactions, also known as triggers. The [variable
9292

9393
For example, **Single click** has `{{event.value}}` and **Range selection** has `{{event.from}}` and `{{event.to}}`.
9494

95-
9695
### Create a URL drilldown [_create_a_url_drilldown]
9796

9897
For example, if you have a dashboard that shows data from a Github repository, you can create a URL drilldown that opens Github from the dashboard panel.
9998

10099
1. Add the [**Sample web logs**](../index.md#gs-get-data-into-kibana) data.
101100
2. Open the **[Logs] Web Traffic** dashboard.
102101
3. In the toolbar, click **Edit**.
103-
4. Create a donut chart
102+
4. Create a pie chart.
103+
104+
* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
105+
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
104106

105-
1. Click **Create visualization**.
106-
2. From the **Chart type** dropdown, select **Donut**.
107-
3. From the **Available fields** list, drag **machine.os.keyword** to the workspace.
108-
4. Click **Save and return**.
107+
2. From the **Chart type** dropdown, select **Pie**.
108+
3. From the **Available fields** list, drag **machine.os.keyword** to the workspace.
109+
4. Click **Save and return**.
109110

110-
5. Open the donut chart panel menu, then select **Create drilldown**.
111+
5. Open the pie chart panel menu, then select **Create drilldown**.
111112
6. Click **Go to URL**.
112113

113114
1. Give the drilldown a name. For example, `Show on Github`.
@@ -123,7 +124,7 @@ For example, if you have a dashboard that shows data from a Github repository, y
123124
4. Click **Create drilldown**.
124125

125126
7. Save the dashboard.
126-
8. On the donut chart panel, click any chart slice, then select **Show on Github**.
127+
8. On the pie chart panel, click any chart slice, then select **Show on Github**.
127128

128129
![URL drilldown popup](/explore-analyze/images/kibana-dashboard_urlDrilldownPopup_8.3.png "")
129130

explore-analyze/dashboards/open-dashboard.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,32 +17,25 @@ products:
1717
When looking for a specific dashboard, you can filter them by tag or by creator, or search the list based on their name and description. Note that the creator information is only available for dashboards created on or after version 8.14.
1818
::::
1919

20-
3. Click the dashboard **Title** you want to open.
21-
4. Make sure that you are in **Edit** mode to be able to make changes to the dashboard. You can switch between **Edit** and **View** modes from the toolbar.
22-
![Switch between Edit and View modes](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt619b284e92c2be27/6750f3a512a5eae780936fe3/switch-to-view-mode-8.17.0.gif)
20+
3. Click the dashboard name you want to open.
21+
The dashboard opens automatically in **Edit** mode if you have the right permissions. You can switch between edit and view modes from the toolbar.
2322

2423
5. Make the changes that you need to the dashboard:
2524

2625
* Adjust the dashboard’s settings
2726
* [Add, remove, move, or edit panels](../visualize.md#panels-editors)
2827
* [Change the available controls](add-controls.md)
2928

30-
6. **Save** the dashboard. You automatically switch to **View** mode upon saving.
29+
6. **Save** the dashboard.
3130

3231
::::{note}
3332
Managed dashboards can’t be edited directly, but you can [duplicate](duplicate-dashboards.md) them and edit these duplicates.
3433
::::
3534

36-
3735
## Reset dashboard changes [reset-the-dashboard]
3836

39-
When editing a dashboard, you can revert any changes you’ve made since the last save using **Reset dashboards**.
37+
When editing a dashboard, you can revert any changes you’ve made since the last save using the **Reset** button in the toolbar.
4038

4139
::::{note}
4240
Once changes are saved, you can no longer revert them in one click, and instead have to edit the dashboard manually.
43-
::::
44-
45-
46-
1. In the toolbar, click **Reset**.
47-
2. On the **Reset dashboard?** window, click **Reset dashboard**.
48-
![Reset dashboard to revert unsaved changes](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte0c08bede75b3874/6750f5566cdeea14b273b048/reset-dashboard-8.17.0.gif)
41+
::::

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

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ You can later filter the data that shows in the chart and in the table by specif
9494
You can combine multiple keywords or characters. For example, `geo dest` finds `geo.dest` and `geo.src.dest`.
9595
::::
9696

97+
{applies_to}`stack: ga 9.2` For some searches, Discover suggests recommended fields to explore. These suggestions are based on the data you query and are managed by Elastic.
98+
9799
2. Select a field to view its most frequent values.
98100
**Discover** shows the top 10 values and the number of records used to calculate those values.
99101

@@ -303,6 +305,39 @@ Note that in ES|QL mode, the **Documents** tab is named **Results**.
303305

304306
Learn more about how to use ES|QL queries in [Using ES|QL](try-esql.md).
305307

308+
### Run multiple explorations with tabs
309+
```{applies_to}
310+
stack: preview 9.2
311+
serverless: preview
312+
```
313+
**Discover** supports multiple tabs to help you explore different aspects of your data simultaneously. Each tab maintains its own independent state, including the query ({{esql}} or classic mode), time range, filters, selected data source, columns and sort order you defined, and the active [context-aware experience](#context-aware-discover).
314+
315+
This allows you to pivot quickly between different explorations without losing your place. For example:
316+
317+
* **Compare time periods:** Open multiple tabs with the same query but different time ranges
318+
* **Test query variations:** Duplicate a tab to experiment with different {{esql}} queries or filters
319+
* **Switch contexts:** Keep separate tabs for logs, metrics, and traces explorations
320+
* **Test a hypothesis:** Switch between different data sources or field combinations
321+
322+
#### Manage Discover tabs
323+
324+
You can open new tabs or duplicate existing ones to compare different queries:
325+
- To start a fresh exploration in a new tab, select the {icon}`plus` icon next to the existing tabs.
326+
- To test variations of your current query in a new tab, hover over a tab and select the {icon}`boxes_vertical` **Actions** icon, then select **Duplicate**.
327+
328+
To manage and organize your tabs, you can:
329+
- Rename them: Double-click its label or hover over a tab and select the {icon}`boxes_vertical` **Actions** icon, then select **Rename**.
330+
- Reorder them: Drag and drop a tab to move it.
331+
- Close them: Hover over a tab and select the {icon}`cross` icon.
332+
- Close several tabs at once: When you hover over a tab and select the {icon}`boxes_vertical` **Actions** icon, options let you **Close other tabs** to keep only the active tab open or **Close tabs to the right** to only keep your first tabs and discard any subsequent tabs.
333+
334+
:::{tip}
335+
If you want to discard all open tabs, you can also start a {icon}`plus` **New session** from the toolbar. When you use this option, any unsaved changes to your current session are lost.
336+
:::
337+
- Reopen recently closed tabs: If you close a tab by mistake, you can retrieve it by selecting the {icon}`boxes_vertical` **Tabs bar menu** icon located at the end of the tab bar.
338+
339+
To keep all of your tabs for later, you can [Save your Discover session](#save-discover-search). All currently open tabs are saved within the session and will be there when you open it again.
340+
306341
### Inspect your Discover queries
307342

308343
:::{include} ../_snippets/inspect-request.md
@@ -319,7 +354,7 @@ You can send your long-running KQL or {{esql}} queries to the background from **
319354

320355
### Save your Discover session for later use [save-discover-search]
321356

322-
Save your Discover session so you can use it later, generate a CSV report, or use it to create visualizations, dashboards, and Canvas workpads. Saving a Discover session saves the query text, filters, and current view of **Discover**, including the columns selected in the document table, the sort order, and the {{data-source}}.
357+
Save your Discover session so you can use it later, generate a CSV report, or use it to create visualizations, dashboards, and Canvas workpads. Saving a Discover session saves all open tabs, along with their query text, filters, and current view of **Discover**, including the columns selected in the document table, the sort order, and the {{data-source}}.
323358

324359
1. In the application menu bar, click **Save**.
325360
2. Give your session a title and a description.
117 KB
Loading

solutions/search/agent-builder/limitations-known-issues.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ Error: Invalid function call syntax
4242
Error executing agent: No tool calls found in the response.
4343
```
4444

45+
### {{esql}} limitations
46+
47+
{{esql}} tools are subject to the current limitations of the {{esql}} language itself. For example, [named parameters](elasticsearch://reference/query-languages/esql/esql-syntax.md#esql-function-named-params) (`?parameter_name`) do not currently work with the `LIKE` and `RLIKE` operators ([issue #131356](https://github.com/elastic/elasticsearch/issues/131356)).
48+
49+
For a complete list of {{esql}} limitations, refer to the the [{{esql}} limitations documentation](elasticsearch://reference/query-languages/esql/limitations.md).
50+
4551
### Misinterpreted SQL syntax as ES|QL
4652

4753
The `.execute_esql` tool is designed only for [{{esql}}](elasticsearch://reference/query-languages/esql.md) syntax, not other query languages.

solutions/search/agent-builder/tools/esql-tools.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,34 @@ Parameters can be configured as:
5252

5353
In your {{esql}} query, reference parameters using the `?parameter_name` syntax. The agent will automatically interpolate parameter values when executing the query.
5454

55+
### Example
56+
57+
Here's an example {{esql}} tool that searches for books using full-text search. `?search_terms` is a named parameter that the agent will provide when executing the query.
58+
59+
```esql
60+
FROM books
61+
| WHERE MATCH(title, ?search_terms)
62+
| KEEP title, author, year
63+
| LIMIT 10
64+
```
65+
66+
You can ask the LLM to infer the parameters for the query or add them manually.
67+
68+
:::{image} ../images/create-esql-tool-query.png
69+
:alt: Creating an ES|QL tool with a parameterized query
70+
:::
5571

5672
## Best practices
5773

58-
- **Include LIMIT clauses**: Prevent returning excessive results by setting reasonable limits
74+
- **Include [`LIMIT`](elasticsearch://reference/query-languages/esql/commands/limit.md) clauses**: Prevent returning excessive results by setting reasonable limits
5975
- **Use meaningful parameter names**: Choose names that clearly indicate what the parameter represents (e.g., `start_date` instead of `date1`)
76+
- **Define parameter types**: Ensure parameters have the correct type to avoid runtime errors
6077
- **Provide clear descriptions**: Help agents understand when and how to use each parameter
6178

79+
## Limitations
80+
81+
{{esql}} tools are subject to the current limitations of the {{esql}} language itself. For more information, refer to [{{esql}} tool limitations](../limitations-known-issues.md#esql-limitations).
82+
6283
## {{esql}} documentation
6384

6485
To learn more about the language, refer to the [{{esql}} docs](elasticsearch://reference/query-languages/esql.md).

0 commit comments

Comments
 (0)