-
Notifications
You must be signed in to change notification settings - Fork 163
Add dedicated metrics view docs #3557
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mdbirnstiehl
wants to merge
15
commits into
elastic:main
Choose a base branch
from
mdbirnstiehl:discover-metrics-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+106
−5
Open
Changes from 10 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
19e477b
Add dedicated metrics view docs
mdbirnstiehl 54e8f9f
update toc
mdbirnstiehl 0a70e0d
update discover get started
mdbirnstiehl f42ca95
add actions
mdbirnstiehl 0a0f803
Merge branch 'main' into discover-metrics-docs
mdbirnstiehl 10df0aa
add screenshot
mdbirnstiehl e167e28
add intro
mdbirnstiehl 7c2d6ef
clean up
mdbirnstiehl 3693375
review updates
mdbirnstiehl df9f6d9
Merge branch 'main' into discover-metrics-docs
mdbirnstiehl f3a7d1e
Merge branch 'main' into discover-metrics-docs
mdbirnstiehl 3080510
review updates
mdbirnstiehl 4f89633
fix typo
mdbirnstiehl 006f771
Merge branch 'main' into discover-metrics-docs
mdbirnstiehl 1948b82
review updates
mdbirnstiehl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
106 changes: 106 additions & 0 deletions
106
solutions/observability/infra-and-hosts/discover-metrics.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
--- | ||
applies_to: | ||
stack: preview 9.2 | ||
serverless: preview | ||
description: Make the most of Discover to explore metrics data. | ||
products: | ||
- id: observability | ||
- id: security | ||
--- | ||
|
||
# Explore metrics data with Discover in Kibana | ||
|
||
**Discover** offers a dedicated experience for exploring metrics data. When **Discover** recognizes metrics data, it enables specific features and default behaviors to optimize your data exploration. Metrics-specific exploration in Discover automatically generates a grid of charts showing available metrics from your data. Use this view to quickly search and filter metrics, break metrics down by dimension, access them using ES|QL, and add metrics to dashboards with a single click. | ||
|
||
If you're just getting started with **Discover** and want to learn its main principles, you should get familiar with the [default experience](../../../explore-analyze/discover.md). | ||
|
||
:::{image} /solutions/images/explore-metrics-ui.png | ||
:alt: Screenshot of adding a dimension. | ||
:screenshot: | ||
::: | ||
|
||
## Requirements | ||
|
||
### Data recognition | ||
By default, all data stored in a `metrics-*` index is recognized as metrics data and triggers the **Discover** experience described on this page. | ||
|
||
### Required Kibana privileges | ||
|
||
% need to check if there are required privileges for metrics. | ||
|
||
Viewing metrics data in **Discover** requires at least `read` privileges for: | ||
- **Discover** | ||
- **Index** | ||
- **Infrastructure** | ||
|
||
For more on assigning Kibana privileges, refer to the [Kibana privileges documentation](../../../deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md). | ||
|
||
## Load metrics data | ||
|
||
:::{note} | ||
To visualize your metrics data as charts, its data stream needs its **Index mode** set to **Time series**. Open **Index Management** using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md), then select the **Data Streams** tab to find your data stream's index mode. | ||
::: | ||
|
||
The dedicated metrics view is only available in ES|QL mode. From the **Discover** main page, select **Try ES|QL**. | ||
|
||
% not sure if the above is true, but wasn't able to access in classic view. | ||
mdbirnstiehl marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Use the `FROM` command to select the data source. | ||
mdbirnstiehl marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
For example, the following query returns all of your metrics data: | ||
|
||
```esql | ||
FROM metrics* | ||
mdbirnstiehl marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
``` | ||
|
||
You can also query a specific index: | ||
|
||
```esql | ||
FROM metrics-index-1 | ||
mdbirnstiehl marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
``` | ||
|
||
## Metrics-specific Discover options | ||
|
||
With your data loaded, use the metrics charts to: | ||
|
||
**Search for specific metrics** | ||
|
||
Use the search function to find and visualize specific metric data: | ||
|
||
:::{image} /solutions/images/explore-metrics-search.png | ||
:alt: Screenshot of searching for a specific metric. | ||
:screenshot: | ||
::: | ||
|
||
**Break down metrics by dimension** | ||
|
||
Break down your metrics by dimension to find metrics that contain those dimensions and identify which values in those dimensions contribute the most to each metric. | ||
|
||
:::{image} /solutions/images/explore-metrics-host-ip.png | ||
:alt: Screenshot of adding a dimension. | ||
:screenshot: | ||
::: | ||
|
||
**Filter dimensions by a specific value** | ||
|
||
Select specific values to focus on within the dimension. You can select up to 10 values to filter your dimension by. | ||
|
||
:::{image} /solutions/images/explore-metrics-host-ip-values.png | ||
:alt: Screenshot of adding a filtering a dimension by a value. | ||
:screenshot: | ||
::: | ||
|
||
**View metric charts in full screen** | ||
|
||
Select the full screen ({icon}`full_screen`) to view the metric charts in full-screen mode. | ||
|
||
### Actions | ||
|
||
For each metric chart, you can perform the following actions: | ||
|
||
* **Explore in Discover** ({icon}`app_discover`): Open Discover filtered to focus on that specific metric. | ||
* **Inspect** ({icon}`inspect`): Show details about the query request and response. | ||
* **View details** ({icon}`eye`): Get additional information about the metric. | ||
* **Copy to dashboard** ({icon}`app_dashboard`): Save the metric chart to an existing or new [dashboard](/explore-analyze/dashboards.md). | ||
* **Add to case** ({icon}`app_cases`): Add the metric chart to a [case](/solutions/observability/incident-management/cases.md). | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.