-
Notifications
You must be signed in to change notification settings - Fork 181
[on week] Add frontmatter description to analyst xp files #3926
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
Changes from 16 commits
e76ec76
8441f16
1b96ac4
d323fc9
a26a06e
c75c852
f95ade8
30fbc46
4b1a38d
73fcf42
18c7ab1
341f514
7a0d1dd
8b1036b
18e84aa
f36e0e0
596192c
dbeaaeb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,4 +12,7 @@ AGENTS.md | |
| .github/instructions/**.instructions.md | ||
| CLAUDE.md | ||
| GEMINI.md | ||
| .cursor | ||
|
|
||
| # Editor settings | ||
| .cursor | ||
| .vscode | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,27 @@ | ||
| --- | ||
| mapped_pages: | ||
| - https://www.elastic.co/guide/en/kibana/current/create-dashboards.html | ||
| description: Build dashboards in Kibana with visualizations, charts, maps, and controls to track key metrics and enable data exploration across Elasticsearch data. | ||
| applies_to: | ||
| stack: ga | ||
| serverless: ga | ||
| products: | ||
| - id: kibana | ||
| --- | ||
|
|
||
| # Building dashboards [create-dashboards] | ||
| # Build dashboards [create-dashboards] | ||
|
|
||
| {{kib}} offers many ways to build powerful dashboards that will help you visualize and keep track of the most important information contained in your {{es}} data. | ||
| Dashboards in {{product.kibana}} combine multiple visualizations, metrics, and controls into a single view that tells a story about your data. You can create dashboards from scratch, start with templates, or assemble panels from the Visualize Library. | ||
|
|
||
| * Create and assemble visualizations such as charts or maps, and enrich them with helpful legends containing key data. | ||
| * Extract and show key indicators and metrics to keep them visible and highlighted at all times. | ||
| * Add text, images, and links to help viewers make the most of your dashboard. | ||
| * Include additional controls to facilitate filtering and browsing the data. | ||
| This section covers the key concepts and requirements for building dashboards. To get started, you need indexed data in {{product.elasticsearch}} and a {{data-source}} that defines which data to analyze. | ||
|
|
||
| $$$dashboard-minimum-requirements$$$ | ||
| To create or edit dashboards, you first need to: | ||
|
|
||
| * have [data indexed into {{es}}](/manage-data/ingest.md) and a [data view](../find-and-organize/data-views.md). A data view is a subset of your {{es}} data, and allows you to load the right data when building a visualization or exploring it. | ||
| * have [data indexed into {{product.elasticsearch}}](/manage-data/ingest.md) and a [data view](../find-and-organize/data-views.md). A data view is a subset of your {{product.elasticsearch}} data, and allows you to load the right data when building a visualization or exploring it. | ||
|
|
||
| ::::{tip} | ||
| If you don’t have data at hand and still want to explore dashboards, you can import one of the [sample data sets](../../manage-data/ingest/sample-data.md) available. | ||
| :::: | ||
|
|
||
| * have sufficient permissions on the **Dashboard** feature. If that’s not the case, you might get a read-only indicator. A {{kib}} administrator can [grant you the required privileges](../../deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md). | ||
| * have sufficient permissions on the **Dashboard** feature. If that’s not the case, you might get a read-only indicator. A {{product.kibana}} administrator can [grant you the required privileges](../../deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md). |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,6 +1,7 @@ | ||||||
| --- | ||||||
| mapped_pages: | ||||||
| - https://www.elastic.co/guide/en/kibana/current/create-a-dashboard-of-panels-with-ecommerce-data.html | ||||||
| description: Step-by-step tutorial for building a time series dashboard with e-commerce data, including custom intervals, percentiles, and multi-layer visualizations. | ||||||
| applies_to: | ||||||
| stack: ga | ||||||
| serverless: ga | ||||||
|
|
@@ -10,9 +11,14 @@ products: | |||||
|
|
||||||
| # Create a dashboard with time series charts [create-a-dashboard-of-panels-with-ecommerce-data] | ||||||
|
|
||||||
| In this tutorial, you’ll use the ecommerce sample data to analyze sales trends, but you can use any type of data to complete the tutorial. | ||||||
| In this tutorial, you'll learn how to build time series visualizations that reveal patterns in your data over time. You'll explore techniques for customizing date intervals, calculating percentiles, comparing multiple data series, and analyzing percentage changes. By the end, you'll understand the core workflows for creating effective time series dashboards. | ||||||
|
|
||||||
| When you’re done, you’ll have a complete overview of the sample web logs data. | ||||||
| The tutorial uses ecommerce sample data, but you can apply these techniques to any time-based data set. | ||||||
|
|
||||||
| **Prerequisites:** | ||||||
|
|
||||||
| - Access to {{product.kibana}} (version 8.0 or later) | ||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - Ecommerce sample data installed (instructions below) | ||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| :::{image} /explore-analyze/images/kibana-lens_timeSeriesDataTutorialDashboard_8.3.png | ||||||
| :alt: Final dashboard with eCommerce sample data | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,18 +1,24 @@ | ||||||
| --- | ||||||
| mapped_pages: | ||||||
| - https://www.elastic.co/guide/en/kibana/current/create-a-dashboard-of-panels-with-web-server-data.html | ||||||
| description: Step-by-step tutorial for building log monitoring dashboards with web server data, covering metrics, traffic analysis, and common Lens visualization patterns. | ||||||
| applies_to: | ||||||
| stack: ga | ||||||
| serverless: ga | ||||||
| products: | ||||||
| - id: kibana | ||||||
| --- | ||||||
|
|
||||||
| # Create a simple dashboard to monitor website logs [create-a-dashboard-of-panels-with-web-server-data] | ||||||
| # Create a dashboard to monitor website logs [create-a-dashboard-of-panels-with-web-server-data] | ||||||
|
|
||||||
| Learn the most common ways to create a dashboard from your own data. The tutorial will use sample data from the perspective of an analyst looking at website logs, but this type of dashboard works on any type of data. | ||||||
| In this tutorial, you'll learn the most common visualization patterns for creating dashboards in {{product.kibana}}. You'll explore how to build metric panels, line charts, tables, pie charts, and other visualizations using Lens, the default visualization editor. By the end, you'll understand the fundamental workflows for transforming raw data into meaningful dashboards. | ||||||
|
|
||||||
| When you’re done, you’ll have a complete overview of the sample web logs data. | ||||||
| The tutorial uses web server log data from the analyst perspective, but these techniques apply to any data set. | ||||||
|
|
||||||
| **Prerequisites:** | ||||||
|
|
||||||
| - Access to {{product.kibana}} (version 8.0 or later) | ||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - Web logs sample data installed (instructions below) | ||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| :::{image} /explore-analyze/images/kibana-lens_logsDashboard_8.4.0.png | ||||||
| :alt: Logs dashboard | ||||||
|
|
@@ -38,7 +44,7 @@ Open the visualization editor, then make sure the correct fields appear. | |||||
| * {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar. | ||||||
| * {applies_to}`stack: ga 9.0` Click **Create visualization**. | ||||||
|
|
||||||
| 2. Make sure the **{{kib}} Sample Data Logs** {{data-source}} appears. | ||||||
| 2. Make sure the **{{product.kibana}} Sample Data Logs** {{data-source}} appears. | ||||||
|
|
||||||
| :::{image} /explore-analyze/images/kibana-lens_dataViewDropDown_8.4.0.png | ||||||
| :alt: Data view dropdown | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| mapped_pages: | ||
| - https://www.elastic.co/guide/en/kibana/current/drilldowns.html | ||
| description: Create interactive drilldowns in dashboards to navigate between dashboards, external URLs, or Discover. Maintain context with filters and time ranges during exploration. | ||
| applies_to: | ||
| stack: ga | ||
| serverless: ga | ||
|
|
@@ -10,9 +11,9 @@ products: | |
|
|
||
| # Add drilldowns [drilldowns] | ||
|
|
||
| Panels have built-in interactive capabilities that apply filters to the dashboard data. For example, when you drag a time range or click a pie slice, a filter for the time range or pie slice is applied. Drilldowns let you customize the interactive behavior while keeping the context of the interaction. | ||
| Drilldowns extend the built-in interactivity of dashboard panels by letting you define custom actions that users can trigger by clicking on data points. Unlike basic click interactions that only apply filters, drilldowns can navigate to other dashboards, open external websites, or jump to Discover while preserving filters, time ranges, and other context. | ||
|
|
||
| There are three types of drilldowns you can add to dashboards: | ||
| You can add three types of drilldowns to dashboard panels: | ||
|
|
||
| * **Dashboard** — Navigates you from one dashboard to another dashboard. For example, create a drilldown for a **Lens** panel that navigates you from a summary dashboard to a dashboard with a filter for a specific host name. | ||
| * **URL** — Navigates you from a dashboard to an external website. For example, a website with the specific host name as a parameter. | ||
|
|
@@ -113,13 +114,13 @@ For example, if you have a dashboard that shows data from a Github repository, y | |
|
|
||
| 1. Give the drilldown a name. For example, `Show on Github`. | ||
| 2. For the **Trigger**, select **Single click**. | ||
| 3. To navigate to the {{kib}} repository Github issues, enter the following in the **Enter URL** field: | ||
| 3. To navigate to the {{product.kibana}} repository Github issues, enter the following in the **Enter URL** field: | ||
|
|
||
| ```bash | ||
| https://github.com/elastic/kibana/issues?q=is:issue+is:open+{{event.value}} | ||
| ``` | ||
|
|
||
| {{kib}} substitutes `{{event.value}}` with a value associated with the selected pie slice. | ||
| {{product.kibana}} substitutes `{{event.value}}` with a value associated with the selected pie slice. | ||
|
|
||
| 4. Click **Create drilldown**. | ||
|
|
||
|
|
@@ -128,7 +129,7 @@ For example, if you have a dashboard that shows data from a Github repository, y | |
|
|
||
|  | ||
|
|
||
| 9. In the list of {{kib}} repository issues, verify that the slice value appears. | ||
| 9. In the list of {{product.kibana}} repository issues, verify that the slice value appears. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we really want to update to
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. that's the new recommended pattern unfortunately for variables that are defined at the docs-builder level |
||
|
|
||
|  | ||
|
|
||
|
|
@@ -212,7 +213,7 @@ Example: | |
|
|
||
| **rison** | ||
|
|
||
| Serialize variables in [rison](https://github.com/w33ble/rison-node) format. Rison is a common format for {{kib}} apps for storing state in the URL. | ||
| Serialize variables in [rison](https://github.com/w33ble/rison-node) format. Rison is a common format for {{product.kibana}} apps for storing state in the URL. | ||
|
|
||
| Example: | ||
|
|
||
|
|
@@ -346,11 +347,11 @@ To ensure that the configured URL drilldown works as expected with your data, yo | |
|
|
||
| | Source | Variable | Description | | ||
| | --- | --- | --- | | ||
| | **Global** | kibanaUrl | {{kib}} base URL. Useful for creating URL drilldowns that navigate within {{kib}}. | | ||
| | **Global** | kibanaUrl | {{product.kibana}} base URL. Useful for creating URL drilldowns that navigate within {{product.kibana}}. | | ||
| | **Context** | context.panel | Context provided by current dashboard panel. | | ||
| | | context.panel.id | ID of a panel. | | ||
| | | context.panel.title | Title of a panel. | | ||
| | | context.panel.filters | List of {{kib}} filters applied to a panel.<br>Tip: Use in combination with [rison](#helpers) helper forinternal {{kib}} navigations with carrying over current filters. | | ||
| | | context.panel.filters | List of {{product.kibana}} filters applied to a panel.<br>Tip: Use in combination with [rison](#helpers) helper forinternal {{product.kibana}} navigations with carrying over current filters. | | ||
| | | context.panel.query.query | Current query string. | | ||
| | | context.panel.query.language | Current query language. | | ||
| | | context.panel.timeRange.from<br>context.panel.timeRange.to | Current time picker values.<br>Tip: Use in combination with [date](#helpers) helper to format date. | | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,19 @@ | ||
| --- | ||
| mapped_pages: | ||
| - https://www.elastic.co/guide/en/kibana/current/_import_dashboards.html | ||
| description: Import dashboards with related objects from saved object files. Configure import behavior for data views, visualizations, and handle object conflicts during migration. | ||
| applies_to: | ||
| stack: ga | ||
| serverless: ga | ||
| products: | ||
| - id: kibana | ||
| --- | ||
|
|
||
| # Import a dashboard [_import_dashboards] | ||
| # Import dashboards [_import_dashboards] | ||
|
|
||
| You can import dashboards from the [Saved Objects](../find-and-organize/saved-objects.md) page under **Stack Management**. | ||
| To move dashboards between {{product.kibana}} instances or restore dashboards from backup, use the import feature. Import works with NDJSON files that contain dashboard definitions and their dependencies. | ||
|
Comment on lines
-13
to
+14
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A simple example as to why these changes are useful. The old description just tells me how. The new one tells me why I would want to use this feature. |
||
|
|
||
| When importing dashboards, you also import their related objects, such as data views and visualizations. Import options allow you to define how the import should behave with these related objects. | ||
| When you import a dashboard, {{product.kibana}} also imports related objects like {{data-sources}} and visualizations. You can control whether to overwrite existing objects or create new ones with random IDs to avoid conflicts. | ||
|
|
||
| * **Check for existing objects**: When selected, objects are not imported when another object with the same ID already exists in this space or cluster. For example, if you import a dashboard that uses a data view which already exists, the data view is not imported and the dashboard uses the existing data view instead. You can also chose to select manually which of the imported or the existing objects are kept by selecting **Request action on conflict**. | ||
| * **Create new objects with random IDs**: All related objects are imported and are assigned a new ID to avoid conflicts. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.