kibana/docs/user/dashboard/tutorial-create-a-dashboard-of-lens-panels.asciidoc
Kibana Machine bc126af5f9
[8.7] [DOCS] Adds Visualizations features for 8.7 (#151045) (#152509)
# Backport

This will backport the following commits from `main` to `8.7`:
- [[DOCS] Adds Visualizations features for 8.7
(#151045)](https://github.com/elastic/kibana/pull/151045)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Kaarina
Tungseth","email":"kaarina.tungseth@elastic.co"},"sourceCommit":{"committedDate":"2023-03-01T20:28:19Z","message":"[DOCS]
Adds Visualizations features for 8.7 (#151045)\n\n## Summary\r\n\r\nAdds
the 8.7 docs for:\r\n\r\n- #149388\r\n- #148829\r\n- Closes #144590\r\n-
Replaces
#144551","sha":"3de0009dd184d031c08fe5b3c3a4e7f56352b510","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","Team:Visualizations","release_note:skip","v8.7.0","v8.8.0"],"number":151045,"url":"https://github.com/elastic/kibana/pull/151045","mergeCommit":{"message":"[DOCS]
Adds Visualizations features for 8.7 (#151045)\n\n## Summary\r\n\r\nAdds
the 8.7 docs for:\r\n\r\n- #149388\r\n- #148829\r\n- Closes #144590\r\n-
Replaces
#144551","sha":"3de0009dd184d031c08fe5b3c3a4e7f56352b510"}},"sourceBranch":"main","suggestedTargetBranches":["8.7"],"targetPullRequestStates":[{"branch":"8.7","label":"v8.7.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/151045","number":151045,"mergeCommit":{"message":"[DOCS]
Adds Visualizations features for 8.7 (#151045)\n\n## Summary\r\n\r\nAdds
the 8.7 docs for:\r\n\r\n- #149388\r\n- #148829\r\n- Closes #144590\r\n-
Replaces #144551","sha":"3de0009dd184d031c08fe5b3c3a4e7f56352b510"}}]}]
BACKPORT-->

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2023-03-01 15:50:24 -05:00

379 lines
13 KiB
Text

[[create-a-dashboard-of-panels-with-web-server-data]]
== Create your first dashboard
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.
When you're done, you'll have a complete overview of the sample web logs data.
[role="screenshot"]
image::images/lens_logsDashboard_8.4.0.png[Logs dashboard]
Before you begin, you should be familiar with the <<kibana-concepts-analysts>>.
[discrete]
[[add-the-data-and-create-the-dashboard]]
=== Add the data and create the dashboard
Add the sample web logs data, and create and set up the dashboard.
. On the home page, click *Try sample data*.
. Click *Other sample data sets*.
. On the *Sample web logs* card, click *Add data*.
Create the dashboard where you'll display the visualization panels.
. Open the main menu, then click *Dashboard*.
. Click *Create dashboard*.
. Set the <<set-time-filter,time filter>> to *Last 90 days*.
[float]
[[open-and-set-up-lens]]
=== Open the visualization editor and get familiar with the data
Open the visualization editor, then make sure the correct fields appear.
. On the dashboard, click *Create visualization*.
. Make sure the *{kib} Sample Data Logs* {data-source} appears.
+
[role="screenshot"]
image::images/lens_dataViewDropDown_8.4.0.png[Data view dropdown]
To create the visualizations in this tutorial, you'll use the following fields:
* *Records*
* *timestamp*
* *bytes*
* *clientip*
* *referer.keyword*
To see the most frequent values in a field, hover over the field name, then click *i*.
[discrete]
[[view-the-number-of-website-visitors]]
=== Create your first visualization
Pick a field you want to analyze, such as *clientip*. To analyze only the *clientip* field, use the *Metric* visualization to display the field as a number.
The only number function that you can use with *clientip* is *Unique count*, also referred to as cardinality, which approximates the number of unique values.
. Open the *Visualization type* dropdown, then select *Metric*.
+
[role="screenshot"]
image::images/lens_visualizationTypeDropdown_8.4.0.png[Visualization type dropdown]
. From the *Available fields* list, drag *clientip* to the workspace or layer pane.
+
[role="screenshot"]
image::images/lens_metricUniqueCountOfClientip_8.4.0.png[Metric visualization of the clientip field]
+
In the layer pane, *Unique count of clientip* appears because the editor automatically applies the *Unique count* function to the *clientip* field. *Unique count* is the only numeric function that works with IP addresses.
. In the layer pane, click *Unique count of clientip*.
.. In the *Name* field, enter `Unique visitors`.
.. Click *Close*.
. Click *Save and return*.
+
*[No Title]* appears in the visualization panel header. Since the visualization has its own `Unique visitors` label, you do not need to add a panel title.
[discrete]
[[mixed-multiaxis]]
=== View a metric over time
There are two shortcuts you can use to view metrics over time.
When you drag a numeric field to the workspace, the visualization editor adds the default
time field from the {data-source}. When you use the *Date histogram* function, you can
replace the time field by dragging the field to the workspace.
To visualize the *bytes* field over time:
. On the dashboard, click *Create visualization*.
. From the *Available fields* list, drag *bytes* to the workspace.
+
The visualization editor creates a bar chart with the *timestamp* and *Median of bytes* fields.
. To zoom in on the data, click and drag your cursor across the bars.
+
[role="screenshot"]
image::images/lens_end_to_end_3_1_1.gif[Zoom in on the data]
To emphasize the change in *Median of bytes* over time, change the visualization type to *Line* with one of the following options:
* In the *Suggestions*, click the line chart.
* In the editor toolbar, open the *Visualization type* dropdown, then select *Line*.
* In the layer pane, open the *Layer visualization type* menu, then click *Line*.
To increase the minimum time interval:
. In the layer pane, click *timestamp*.
. Change the *Minimum interval* to *1d*, then click *Close*.
+
You can increase and decrease the minimum interval, but you are unable to decrease the interval below the configured <<advanced-options,*Advanced Settings*>>.
To save space on the dashboard, hide the axis labels.
. Open the *Left axis* menu, then select *None* from the *Axis title* dropdown.
+
[role="screenshot"]
image::images/lens_lineChartMetricOverTimeLeftAxis_8.7.png[Left axis menu]
. Open the *Bottom axis* menu, then select *None* from the *Axis title* dropdown.
+
[role="screenshot"]
image::images/lens_lineChartMetricOverTimeBottomAxis_8.7.png[Bottom axis menu]
. Click *Save and return*
Since you removed the axis labels, add a panel title:
. Open the panel menu, then select *Edit panel settings*.
. In the *Title* field, enter `Median of bytes`, then click *Save*.
+
[role="screenshot"]
image::images/lens_lineChartMetricOverTime_8.4.0.png[Line chart that displays metric data over time]
[discrete]
[[view-the-distribution-of-visitors-by-operating-system]]
=== View the top values of a field
Create a visualization that displays the most frequent values of *request.keyword* on your website, ranked by the unique visitors.
To create the visualization, use *Top values of request.keyword* ranked by *Unique count of clientip*, instead of being ranked by *Count of records*.
The *Top values* function ranks the unique values of a field by another function.
The values are the most frequent when ranked by a *Count* function, and the largest when ranked by the *Sum* function.
. On the dashboard, click *Create visualization*.
. From the *Available fields* list, drag *clientip* to the *Vertical axis* field in the layer pane.
+
The visualization editor automatically applies the *Unique count* function. If you drag *clientip* to the workspace, the editor adds the field to the incorrect axis.
. Drag *request.keyword* to the workspace.
+
[role="screenshot"]
image::images/lens_end_to_end_2_1_1.png[Vertical bar chart with top values of request.keyword by most unique visitors]
+
When you drag a text or IP address field to the workspace,
the editor adds the *Top values* function ranked by *Count of records* to show the most frequent values.
The chart labels are unable to display because the *request.keyword* field contains long text fields. You could use one of the *Suggestions*, but the suggestions also have issues with long text. The best way to display long text fields is with the *Table* visualization.
. Open the *Visualization type* dropdown, then select *Table*.
+
[role="screenshot"]
image::images/lens_end_to_end_2_1_2.png[Table with top values of request.keyword by most unique visitors]
. In the layer pane, click *Top 5 values of request.keyword*.
.. In the *Number of values* field, enter `10`.
.. In the *Name* field, enter `Page URL`.
.. Click *Close*.
+
[role="screenshot"]
image::images/lens_tableTopFieldValues_7.16.png[Table that displays the top field values]
. Click *Save and return*.
+
Since the table columns are labeled, you do not need to add a panel title.
[discrete]
[[custom-ranges]]
=== Compare a subset of documents to all documents
Create a proportional visualization that helps you determine if your users transfer more bytes from documents under 10KB versus documents over 10Kb.
. On the dashboard, click *Create visualization*.
. From the *Available fields* list, drag *bytes* to the *Vertical axis* field in the layer pane.
. In the layer pane, click *Median of bytes*.
. Click the *Sum* quick function, then click *Close*.
. From the *Available fields* list, drag *bytes* to the *Break down by* field in the layer pane.
To select documents based on the number range of a field, use the *Intervals* function.
When the ranges are non numeric, or the query requires multiple clauses, you could use the *Filters* function.
Specify the file size ranges:
. In the layer pane, click *bytes*.
. Click *Create custom ranges*, enter the following in the *Ranges* field, then press Return:
* *Ranges* &mdash; `0` -> `10240`
* *Label* &mdash; `Below 10KB`
. Click *Add range*, enter the following, then press Return:
* *Ranges* &mdash; `10240` -> `+∞`
* *Label* &mdash; `Above 10KB`
+
[role="screenshot"]
image::images/lens_end_to_end_6_1.png[Custom ranges configuration]
. From the *Value format* dropdown, select *Bytes (1024)*, then click *Close*.
To display the values as a percentage of the sum of all values, use the *Pie* chart.
. Open the *Visualization Type* dropdown, then select *Pie*.
+
[role="screenshot"]
image::images/lens_pieChartCompareSubsetOfDocs_7.16.png[Pie chart that compares a subset of documents to all documents]
. Click *Save and return*.
Add a panel title:
. Open the panel menu, then select *Edit panel settings*.
. In the *Title* field, enter `Sum of bytes from large requests`, then click *Save*.
[discrete]
[[histogram]]
=== View the distribution of a number field
The distribution of a number can help you find patterns. For example, you can analyze the website traffic per hour to find the best time for routine maintenance.
. On the dashboard, click *Create visualization*.
. From the *Available fields* list, drag *bytes* to *Vertical axis* field in the layer pane.
. In the layer pane, click *Median of bytes*.
.. Click the *Sum* quick function.
.. In the *Name* field, enter `Transferred bytes`.
.. From the *Value format* dropdown, select *Bytes (1024)*, then click *Close*.
. From the *Available fields* list, drag *hour_of_day* to *Horizontal axis* field in the layer pane.
. In the layer pane, click *hour_of_day*, then slide the *Intervals granularity* slider until the horizontal axis displays hourly intervals.
+
[role="screenshot"]
image::images/lens_barChartDistributionOfNumberField_7.16.png[Bar chart that displays the distribution of a number field]
. Click *Save and return*.
Add a panel title:
. Open the panel menu, then select *Edit panel settings*.
. In the *Title* field, enter `Website traffic`, then click *Save*.
[discrete]
[[treemap]]
=== Create a multi-level chart
*Table* and *Proportion* visualizations support multiple functions. For example, to create visualizations that break down the data by website traffic sources and user geography, apply the *Filters* and *Top values* functions.
. On the dashboard, click *Create visualization*.
. Open the *Visualization type* dropdown, then select *Treemap*.
. From the *Available fields* list, drag *Records* to the *Size by* field in the layer pane.
. In the layer pane, click *Add or drag-and-drop a field* for *Group by*.
Create a filter for each website traffic source:
. Click *Filters*.
. Click *All records*, enter the following in the query bar, then press Return:
* *KQL* &mdash; `referer : *facebook.com*`
* *Label* &mdash; `Facebook`
. Click *Add a filter*, enter the following in the query bar, then press Return:
* *KQL* &mdash; `referer : *twitter.com*`
* *Label* &mdash; `Twitter`
. Click *Add a filter*, enter the following in the query bar, then press Return:
* *KQL* &mdash; `NOT referer : *twitter.com* OR NOT referer: *facebook.com*`
* *Label* &mdash; `Other`
. Click *Close*.
Add the user geography grouping:
. From the *Available fields* list, drag *geo.srcdest* to the workspace.
. To change the *Group by* order, drag *Top 3 values of geo.srcdest* in the layer pane so that appears first.
+
[role="screenshot"]
image::images/lens_end_to_end_7_2.png[Treemap visualization]
Remove the documents that do not match the filter criteria:
. In the layer pane, click *Top 3 values of geo.srcdest*.
. Click *Advanced*, deselect *Group other values as "Other"*, then click *Close*.
+
[role="screenshot"]
image::images/lens_treemapMultiLevelChart_7.16.png[Treemap visualization]
. Click *Save and return*.
Add a panel title:
. Open the panel menu, then select *Edit panel settings*.
. In the *Title* field, enter `Page views by location and referrer`, then click *Save*.
[float]
[[arrange-the-lens-panels]]
=== Arrange the dashboard panels
Resize and move the panels so they all appear on the dashboard without scrolling.
Decrease the size of the following panels, then move the panels to the first row:
* *Unique visitors*
* *Median of bytes*
* *Sum of bytes from large requests*
* *Website traffic*
+
[role="screenshot"]
image::images/lens_logsDashboard_8.4.0.png[Logs dashboard]
[discrete]
=== Save the dashboard
Now that you have a complete overview of your web server data, save the dashboard.
. In the toolbar, click *Save*.
. On the *Save dashboard* window, enter `Logs dashboard` in the *Title* field.
. Select *Store time with dashboard*.
. Click *Save*.