Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions explore-analyze/_snippets/inspect-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
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.

1. Open the **Inspector**:
- If you're in **Discover**, select **Inspect** from the application's toolbar.
- If you're in **Dashboards**, open the panel menu and select **Inspect**.
1. Open the **View** dropdown, then select **Requests**.
1. Several tabs with different information can appear, depending on nature of the request:
:::{tip}
Some visualizations rely on several requests. From the dropdown, select the request you want to inspect.
:::
* **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.
* **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.

:::{note}
This tab is not available for {{esql}} queries and Vega visualizations.
:::

* **Request**: Provides a full view of the visualization's request, which you can copy or **Open in Console** to refine, if needed.
* **Response**: Provides a full view of the response returned by the request.
17 changes: 2 additions & 15 deletions explore-analyze/dashboards/using.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,21 +180,8 @@ This action is possible for all charts created using **Lens** or {{esql}}. It is

#### View the requests that collect the data

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.

1. Open the panel menu and select **Inspect**.
1. Open the **View** dropdown, then select **Requests**.
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:
* **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.
* **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.

:::{note}
This tab is not available for {{esql}} and Vega visualizations.
:::

* **Request**: Provides a full view of the visualization's request, which you can copy or **Open in Console** to refine, if needed.
* **Response**: Provides a full view of the response returned by the request.

:::{include} ../_snippets/inspect-request.md
:::

#### View the time range on specific panels

Expand Down
14 changes: 14 additions & 0 deletions explore-analyze/discover/discover-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ Your query may include multiple data types that each have tailored experiences;

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).

### View active context-aware experience

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.

1. Select **Inspect** from Discover's toolbar.
1. Open the **View** dropdown, then select **Profiles**.

The various profiles listed show details such as the active solution and data source contexts, which determine Discover's context-aware experiences.
Comment on lines +46 to +53

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I overlooked this one in the checklist you shared. While it's probably useful for some users, this was mainly added as a troubleshooting tool for profile issues in prod deployments. I don't personally have an issue with public docs for it, but we should check with @ninoslavmiskovic first to see what he thinks.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is fine, since we have a section that explains we are rendering something for the user that is contextual, to also show how they can check it. There is no harm in that. I doubt it will be used much, but no harm in documentation it. ++ LGTM


## Load data into Discover [find-the-data-you-want-to-use]

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

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

### Inspect your Discover queries

:::{include} ../_snippets/inspect-request.md
:::


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

Expand Down
Loading