Skip to content

Commit 8495820

Browse files
Ability to view active profiles and add missing query inspect information (elastic#3425)
This PR: - Adds a section to indicate how to view active profiles in Discover - Brings missing information about how to inspect queries. Similar information existed in the dashboards docs so I turned it into a snippet and included mentions of Discover in it. Now the same snippet is used in both places. Closes: elastic#3090
1 parent 9b759f3 commit 8495820

File tree

3 files changed

+35
-15
lines changed

3 files changed

+35
-15
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
The request **Inspector** is available in **Discover** and for all **Dashboards** visualization panels that are built based on a query. The available information can differ based on the request.
2+
3+
1. Open the **Inspector**:
4+
- If you're in **Discover**, select **Inspect** from the application's toolbar.
5+
- If you're in **Dashboards**, open the panel menu and select **Inspect**.
6+
1. Open the **View** dropdown, then select **Requests**.
7+
1. Several tabs with different information can appear, depending on nature of the request:
8+
:::{tip}
9+
Some visualizations rely on several requests. From the dropdown, select the request you want to inspect.
10+
:::
11+
* **Statistics**: Provides general information and statistics about the request. For example, you can check if the number of hits and query time match your expectations. If not, this may indicate an issue with the request used to build the visualization.
12+
* **Clusters and shards**: Lists the {{es}} clusters and shards per cluster queried to fetch the data and shows the status of the request on each of them. With the information in this tab, you can check if the request is properly executed, especially in case of cross-cluster search.
13+
14+
:::{note}
15+
This tab is not available for {{esql}} queries and Vega visualizations.
16+
:::
17+
18+
* **Request**: Provides a full view of the visualization's request, which you can copy or **Open in Console** to refine, if needed.
19+
* **Response**: Provides a full view of the response returned by the request.

explore-analyze/dashboards/using.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -180,21 +180,8 @@ This action is possible for all charts created using **Lens** or {{esql}}. It is
180180

181181
#### View the requests that collect the data
182182

183-
This action is possible for all visualization panels that are built based on a query, but the available information can differ based on the panel type.
184-
185-
1. Open the panel menu and select **Inspect**.
186-
1. Open the **View** dropdown, then select **Requests**.
187-
1. Some visualizations rely on several requests. From the dropdown, select the request you want to inspect. Several tabs with different information can appear, depending on the panel type:
188-
* **Statistics**: Provides general information and statistics about the request. For example, you can check if the number of hits and query time match your expectations. If not, this may indicate an issue with the request used to build the visualization.
189-
* **Clusters and shards**: Lists the {{es}} clusters and shards per cluster queried to fetch the data and shows the status of the request on each of them. With the information in this tab, you can check if the request is properly executed, especially in case of cross-cluster search.
190-
191-
:::{note}
192-
This tab is not available for {{esql}} and Vega visualizations.
193-
:::
194-
195-
* **Request**: Provides a full view of the visualization's request, which you can copy or **Open in Console** to refine, if needed.
196-
* **Response**: Provides a full view of the response returned by the request.
197-
183+
:::{include} ../_snippets/inspect-request.md
184+
:::
198185

199186
#### View the time range on specific panels
200187

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ Your query may include multiple data types that each have tailored experiences;
4343

4444
In this case **Discover** provides the default experience until it detects that you're interacting with a single type of data. For example, when you [](#look-inside-a-document).
4545

46+
### View active context-aware experience
47+
48+
You can check which experience is currently active for your current Discover session. This can help you confirm whether the type of data you're currently exploring is properly detected or if Discover is currently using its default experience.
49+
50+
1. Select **Inspect** from Discover's toolbar.
51+
1. Open the **View** dropdown, then select **Profiles**.
52+
53+
The various profiles listed show details such as the active solution and data source contexts, which determine Discover's context-aware experiences.
54+
4655
## Load data into Discover [find-the-data-you-want-to-use]
4756

4857
Select the data you want to explore, and then specify the time range in which to view that data.
@@ -294,6 +303,11 @@ Note that in ES|QL mode, the **Documents** tab is named **Results**.
294303

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

306+
### Inspect your Discover queries
307+
308+
:::{include} ../_snippets/inspect-request.md
309+
:::
310+
297311

298312
### Save your Discover session for later use [save-discover-search]
299313

0 commit comments

Comments
 (0)