-
Notifications
You must be signed in to change notification settings - Fork 8.5k
[DOCS] Adds quick start #78822
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
Merged
Merged
[DOCS] Adds quick start #78822
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
996b4f3
[DOCS] Getting started refresh
KOTungseth 5726d32
Dashboard changes
KOTungseth d0265d4
Discover and Dashboard changes
KOTungseth 31b1b81
[DOCS] Adds quick start
KOTungseth 1783172
Merge branch 'master' into docs/gs-refresh
KOTungseth 076f51a
Redirects
KOTungseth 5ccaea5
Redirects pt 2
KOTungseth 1345f21
Redirects pt
KOTungseth b9a9a05
More redirect issues
KOTungseth 8c70189
Removed second chunk of KQL tasks
KOTungseth 20ab783
Review comments
KOTungseth 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
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.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
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.
Binary file not shown.
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.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
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,142 @@ | ||
| [[get-started]] | ||
| == Quick start | ||
|
|
||
| To quickly get up and running with {kib}, set up on Cloud, then add a sample data set that you can explore and analyze. | ||
|
|
||
| When you've finished, you'll know how to: | ||
|
|
||
| * <<explore-the-data,Explore the data with *Discover*.>> | ||
|
|
||
| * <<view-and-analyze-the-data,Gain insight into the data with *Dashboard*.>> | ||
|
|
||
| [float] | ||
| === Before you begin | ||
| When security is enabled, you must have `read`, `write`, and `manage` privileges on the `kibana_sample_data_*` indices. For more information, refer to {ref}/security-privileges.html[Security privileges]. | ||
|
|
||
| [float] | ||
| [[set-up-on-cloud]] | ||
| == Set up on cloud | ||
|
|
||
| include::{docs-root}/shared/cloud/ess-getting-started.asciidoc[] | ||
|
|
||
| [float] | ||
| [[gs-get-data-into-kibana]] | ||
| == Add the sample data | ||
|
|
||
| Sample data sets come with sample visualizations, dashboards, and more to help you explore {kib} without adding your own data. | ||
|
|
||
| . From the home page, click *Try our sample data*. | ||
|
|
||
| . On the *Sample eCommerce orders* card, click *Add data*. | ||
| + | ||
| [role="screenshot"] | ||
| image::getting-started/images/add-sample-data.png[] | ||
|
|
||
| [float] | ||
| [[explore-the-data]] | ||
| == Explore the data | ||
|
|
||
| *Discover* displays an interactive histogram that shows the distribution of of data, or documents, over time, and a table that lists the fields for each document that matches the index. By default, all fields are shown for each matching document. | ||
|
|
||
| . Open the menu, then click *Discover*. | ||
|
|
||
| . Change the <<set-time-filter, time filter>> to *Last 7 days*. | ||
| + | ||
| [role="screenshot"] | ||
| image::images/tutorial-discover-2.png[] | ||
|
|
||
| . To focus in on the documents you want to view, use the <<kuery-query,{kib} Query Language>>. In the *KQL* search field, enter: | ||
| + | ||
| [source,text] | ||
| products.taxless_price >= 60 AND category : Women's Clothing | ||
| + | ||
| The query returns the women's clothing orders for $60 and more. | ||
| + | ||
| [role="screenshot"] | ||
| image::images/tutorial-discover-4.png[] | ||
|
|
||
| . Hover over the list of *Available fields*, then click *+* next to the fields you want to view in the table. | ||
| + | ||
| For example, when you add the *category* field, the table displays the product categories for the orders. | ||
| + | ||
| [role="screenshot"] | ||
| image::images/tutorial-discover-3.png[] | ||
| + | ||
| For more information, refer to <<discover, *Discover*>>. | ||
|
|
||
| [float] | ||
| [[view-and-analyze-the-data]] | ||
| == View and analyze the data | ||
|
|
||
| A dashboard is a collection of panels that you can use to view and analyze the data. Panels contain visualizations, interactive controls, Markdown, and more. | ||
|
|
||
| . Open the menu, then click *Dashboard*. | ||
|
|
||
| . Click *[eCommerce] Revenue Dashboard*. | ||
| + | ||
| [role="screenshot"] | ||
| image::getting-started/images/tutorial-sample-dashboard.png[] | ||
|
|
||
| [float] | ||
| [[filter-and-query-the-data]] | ||
| === Filter the data | ||
|
|
||
| To focus in on the data you want to view on the dashboard, use filters. | ||
|
|
||
| . From the *Controls* visualization, make a selection from the *Manufacturer* and *Category* dropdowns, then click *Apply changes*. | ||
| + | ||
| For example, the following dashboard shows the data for women's clothing from Gnomehouse. | ||
| + | ||
| [role="screenshot"] | ||
| image::getting-started/images/tutorial-sample-filter.png[] | ||
|
|
||
| . To manually add a filter, click *Add filter*, then specify the options. | ||
| + | ||
| For example, to view the orders for Wednesday, select *day_of_week* from the *Field* dropdown, select *is* from the *Operator* dropdown, then select *Wednesday* from the *Value* dropdown. | ||
| + | ||
| [role="screenshot"] | ||
| image::getting-started/images/tutorial-sample-filter2.png[] | ||
|
|
||
| . When you are done, remove the filters. | ||
| + | ||
| For more information, refer to <<dashboard,*Dashboard*>>. | ||
|
|
||
| [float] | ||
| [[create-a-visualization]] | ||
| === Create a visualization | ||
|
|
||
| To create a treemap that shows the top regions and manufacturers, use *Lens*, then add the treemap to the dashboard. | ||
|
|
||
| . From the {kib} toolbar, click *Edit*, then click *Create new*. | ||
|
|
||
| . On the *New Visualization* window, click *Lens*. | ||
|
|
||
| . From the *Available fields* list, drag and drop the following fields to the visualization builder: | ||
|
|
||
| * *geoip.city_name* | ||
|
|
||
| * *manufacturer.keyword* | ||
| + | ||
| . From the visualization dropdown, select *Treemap*. | ||
| + | ||
| [role="screenshot"] | ||
| image::getting-started/images/tutorial-visualization-dropdown.png[Visualization dropdown with Treemap selected] | ||
|
|
||
| . Click *Save*. | ||
|
|
||
| . On the *Save Lens visualization*, enter a title and make sure *Add to Dashboard after saving* is selected, then click *Save and return*. | ||
| + | ||
| The treemap appears as the last visualization on the dashboard. | ||
| + | ||
| [role="screenshot"] | ||
| image::getting-started/images/tutorial-final-dashboard.gif[Final dashboard with new treemap visualization] | ||
| + | ||
| For more information, refer to <<lens, *Lens*>>. | ||
|
|
||
| [float] | ||
| [[quick-start-whats-next]] | ||
| == What's next? | ||
|
|
||
| If you are you ready to add your own data, refer to <<connect-to-elasticsearch,Add data to {kib}>>. | ||
|
Contributor
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. The "Add Data" needs updating. I'll add it to my ToDo list. |
||
|
|
||
| If you want to ingest your data, refer to {ingest-guide}/ingest-management-getting-started.html[Quick start: Get logs and metrics into the Elastic Stack]. | ||
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
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.
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.
How do you feel about making "Click Launch Kibana" step 6? We could talk to the Cloud folks about changing the include file.
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.
I can go either way. This topic is about how to set up on Cloud, not how to launch Kibana. So I can see why the Kibana-specific content comes after the tasks. On the other hand, it is a task, so it really should appear as one. I'll leave this one up to you.