-
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
[DOCS] Adds quick start #78822
Changes from 10 commits
996b4f3
5726d32
d0265d4
31b1b81
1783172
076f51a
5ccaea5
1345f21
b9a9a05
8c70189
20ab783
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 |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| [[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 use to explore and analyze. | ||
|
|
||
| [float] | ||
| === Required privileges | ||
|
||
| 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[] | ||
|
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. How do you feel about making "Click Launch Kibana" step 6? We could talk to the Cloud folks about changing the include file.
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. 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. |
||
|
|
||
| [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. | ||
|
|
||
| . Go to the home page. | ||
KOTungseth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| . 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]] | ||
| [[query-the-data]] | ||
| == Explore the data | ||
|
|
||
| With *Discover*, use {ref}/query-dsl-query-string-query.html#query-string-syntax[Elasticsearch | ||
|
||
| queries] and filters to explore your 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 | ||
|
|
||
| Gain insight into your data with *Dashboard*, which is a collection of panels that you can | ||
| use to view and analyze your 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 | ||
|
|
||
| Use *Lens* to create a treemap that shows the top regions and manufacturersthen, then add it to the dashboard. | ||
KOTungseth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| . 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* | ||
| + | ||
| [role="screenshot"] | ||
| image::getting-started/images/tutorial-treemap.png[Treemap in Lens that shows the top regions and manufacturers from the Ecommerce sample data] | ||
|
|
||
| . Click *Save, enter a title, then click *Save and return*. | ||
|
||
| + | ||
| For more information, refer to <<lens, *Lens*>>. | ||
|
|
||
| [float] | ||
| [[quick-start-next-steps]] | ||
| == Next steps | ||
|
|
||
| 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-manager, Ingest Manager>>. | ||
KOTungseth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file was deleted.
This file was deleted.
Uh oh!
There was an error while loading. Please reload this page.