Skip to content

Commit

Permalink
Updates getting started guide (#41778)
Browse files Browse the repository at this point in the history
* [DOCS] Updates images in Getting Started

* [DOCS] Updates getting started

* [DOCS] Updated gs based on review comments

* [DOCS] Updates links to sample data

* [DOCS] Fixes broken links

* [DOCS] Minor edits to GS
  • Loading branch information
gchaps committed Jul 25, 2019
1 parent ff47bd0 commit a6b8036
Show file tree
Hide file tree
Showing 47 changed files with 612 additions and 587 deletions.
2 changes: 1 addition & 1 deletion docs/canvas/canvas-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To get up and running with Canvas, use the following tutorial where you'll creat
[float]
=== Before you begin

For this tutorial, you'll need to add the {kibana-ref}/add-sample-data.html[Sample eCommerce orders data].
For this tutorial, you'll need to add the <<add-sample-data, Sample eCommerce orders data>>.

[float]
=== Create and personalize your workpad
Expand Down
2 changes: 1 addition & 1 deletion docs/canvas/canvas-workpad.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ When you create a workpad, you'll start with a blank page, or you can choose a w

* To import an existing workpad, click and drag a workpad JSON file to the *Import workpad JSON file* field.

For advanced workpad examples, add a {kibana-ref}/add-sample-data.html[sample Kibana data set], then select *Canvas* from the *View Data* dropdown list.
For advanced workpad examples, add a <<add-sample-data, sample Kibana data set>>, then select *Canvas* from the *View Data* dropdown list.

For more workpad inspiration, go to the link:https://www.elastic.co/blog/[Elastic Blog].

Expand Down
65 changes: 36 additions & 29 deletions docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,56 @@
[partintro]
--

Ready to get some hands-on experience with {kib}? There are two ways to start:
You’re new to Kibana and want to give it a try. {kib} has sample data sets and
tutorials to help you get started.

* <<tutorial-sample-data, Explore {kib} using the Flights dashboard>>
+
Load the Flights sample data and dashboard with one click and start
interacting with {kib} visualizations in seconds.
[float]
=== Sample data

* <<tutorial-build-dashboard, Build your own dashboard>>
+
Manually load a data set and build your own visualizations and dashboard.
You can use the <<add-sample-data, sample data
sets>> to take {kib} for a test ride without having
to go through the process of loading data yourself. With one click,
you can install a sample data set and start interacting with
{kib} visualizations in seconds. You can access the sample data
from the {kib} home page.

Before you begin, make sure you've <<install, installed Kibana>> and established
a {kibana-ref}/connect-to-elasticsearch.html[connection to Elasticsearch].
You might also be interested in the
https://www.elastic.co/webinars/getting-started-kibana[Getting Started with Kibana]
video tutorial.
[float]

If you are running our https://cloud.elastic.co[hosted Elasticsearch Service]
on Elastic Cloud, you can access Kibana with a single click.
--
=== Add data tutorials
{kib} has built-in *Add Data* tutorials to help you set up
data flows in the Elastic Stack. These tutorials are available
from the Kibana home page. In *Add Data to Kibana*, find the data type
you’re interested in, and click its button to view a list of available tutorials.

include::getting-started/add-sample-data.asciidoc[]
[float]
=== Hands-on experience

include::getting-started/tutorial-sample-data.asciidoc[]
The following tutorials walk you through searching, analyzing,
and visualizing data.

include::getting-started/tutorial-sample-filter.asciidoc[]
* <<tutorial-sample-data, Explore Kibana using sample data>>. You'll
learn to filter and query data, edit visualizations, and interact with dashboards.

include::getting-started/tutorial-sample-query.asciidoc[]
* <<tutorial-build-dashboard, Build your own dashboard>>. You'll manually load a data set and build
your own visualizations and dashboard.

include::getting-started/tutorial-sample-discover.asciidoc[]
[float]
=== Before you begin

include::getting-started/tutorial-sample-edit.asciidoc[]
Make sure you've <<install, installed Kibana>> and established
a <<connect-to-elasticsearch, connection to Elasticsearch>>.

include::getting-started/tutorial-sample-inspect.asciidoc[]
If you are running our https://cloud.elastic.co[hosted Elasticsearch Service]
on Elastic Cloud, you can access Kibana with a single click.

include::getting-started/tutorial-sample-remove.asciidoc[]

include::getting-started/tutorial-full-experience.asciidoc[]
--

include::getting-started/add-sample-data.asciidoc[]

include::getting-started/tutorial-load-dataset.asciidoc[]
include::getting-started/tutorial-sample-data.asciidoc[]

include::getting-started/tutorial-full-experience.asciidoc[]

include::getting-started/tutorial-define-index.asciidoc[]

Expand All @@ -53,6 +63,3 @@ include::getting-started/tutorial-visualizing.asciidoc[]

include::getting-started/tutorial-dashboard.asciidoc[]

include::getting-started/tutorial-inspect.asciidoc[]

include::getting-started/wrapping-up.asciidoc[]
28 changes: 12 additions & 16 deletions docs/getting-started/add-sample-data.asciidoc
Original file line number Diff line number Diff line change
@@ -1,32 +1,28 @@
[[add-sample-data]]
== Get up and running with sample data
== Add sample data

{kib} has several sample data sets that you can use to explore {kib} before loading your own data.
Sample data sets install prepackaged visualizations, dashboards,
{kibana-ref}/canvas-getting-started.html[Canvas workpads],
and {kibana-ref}/maps.html[Maps].

The sample data sets showcase a variety of use cases:
These sample data sets showcase a variety of use cases:

* *eCommerce orders* includes visualizations for product-related information,
such as cost, revenue, and price.
* *Flight data* enables you to view and interact with flight routes.
* *Web logs* lets you analyze website traffic.
* *Flight data* enables you to view and interact with flight routes for four airlines.

To get started, go to the home page and click the link next to *Add sample data*.

Once you have loaded a data set, click *View data* to view visualizations in *Dashboard*.

*Note:* The timestamps in the sample data sets are relative to when they are installed.
If you uninstall and reinstall a data set, the timestamps will change to reflect the most recent installation.
To get started, go to the {kib} home page and click the link underneath *Add sample data*.

Once you've loaded a data set, click *View data* to view prepackaged
visualizations, dashboards, Canvas workpads, Maps, and Machine Learning jobs.

[role="screenshot"]
image::images/add-sample-data.png[]

NOTE: The timestamps in the sample data sets are relative to when they are installed.
If you uninstall and reinstall a data set, the timestamps will change to reflect the most recent installation.

[float]
==== Next steps
=== Next steps

Play with the sample flight data in the {kibana-ref}/tutorial-sample-data.html[flight dashboard tutorial].
* Explore {kib} by following the <<tutorial-sample-data, sample data tutorial>>.

Learn how to load data, define index patterns and build visualizations by {kibana-ref}/tutorial-build-dashboard.html[building your own dashboard].
* Learn how to load data, define index patterns, and build visualizations by <<tutorial-build-dashboard, building your own dashboard>>.
50 changes: 40 additions & 10 deletions docs/getting-started/tutorial-dashboard.asciidoc
Original file line number Diff line number Diff line change
@@ -1,27 +1,57 @@
[[tutorial-dashboard]]
=== Displaying your visualizations in a dashboard
=== Add visualizations to a dashboard

A dashboard is a collection of visualizations that you can arrange and share.
You'll build a dashboard that contains the visualizations you saved during
this tutorial.

. Open *Dashboard*.
. Click *Create new dashboard*.
. Click *Add*.
. On the Dashboard overview page, click *Create new dashboard*.
. Click *Add* in the menu bar.
. Add *Bar Example*, *Map Example*, *Markdown Example*, and *Pie Example*.


Your sample dashboard look like this:

+
Your sample dashboard should look like this:
+
[role="screenshot"]
image::images/tutorial-dashboard.png[]

. Try out the editing controls.
+
You can rearrange the visualizations by clicking a the header of a
visualization and dragging. The gear icon in the top right of a visualization
displays controls for editing and deleting the visualization. A resize control
is on the lower right.

To get a link to share or HTML code to embed the dashboard in a web page, save
the dashboard and click *Share*.
. *Save* your dashboard.

==== Inspect the data

Seeing visualizations of your data is great,
but sometimes you need to look at the actual data to
understand what's really going on. You can inspect the data behind any visualization
and view the {es} query used to retrieve it.

. In the dashboard, hover the pointer over the pie chart, and then click the icon in the upper right.
. From the *Options* menu, select *Inspect*.
+
[role="screenshot"]
image::images/tutorial-full-inspect1.png[]

. To look at the query used to fetch the data for the visualization, select *View > Requests*
in the upper right of the Inspect pane.

[float]
=== Next steps

Now that you have a handle on the basics, you're ready to start exploring
your own data with Kibana.

* See {kibana-ref}/discover.html[Discover] for information about searching and filtering
your data.
* See {kibana-ref}/visualize.html[Visualize] for information about the visualization
types Kibana has to offer.
* See {kibana-ref}/management.html[Management] for information about configuring Kibana
and managing your saved objects.
* See {kibana-ref}/console-kibana.html[Console] to learn about the interactive
console you can use to submit REST requests to Elasticsearch.

*Save* your dashboard.
36 changes: 22 additions & 14 deletions docs/getting-started/tutorial-define-index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,45 +1,53 @@
[[tutorial-define-index]]
=== Defining your index patterns
=== Define your index patterns

Index patterns tell Kibana which Elasticsearch indices you want to explore.
An index pattern can match the name of a single index, or include a wildcard
(*) to match multiple indices.
(*) to match multiple indices.

For example, Logstash typically creates a
series of indices in the format `logstash-YYYY.MMM.DD`. To explore all
of the log data from May 2018, you could specify the index pattern
`logstash-2018.05*`.

You'll create patterns for the Shakespeare data set, which has an

[float]
==== Create your first index pattern

First you'll create index patterns for the Shakespeare data set, which has an
index named `shakespeare,` and the accounts data set, which has an index named
`bank.` These data sets don't contain time-series data.
`bank`. These data sets don't contain time series data.

. In Kibana, open *Management*, and then click *Index Patterns.*
. If this is your first index pattern, the *Create index pattern* page opens automatically.
Otherwise, click *Create index pattern* in the upper left.
Otherwise, click *Create index pattern*.
. Enter `shakes*` in the *Index pattern* field.
+
[role="screenshot"]
image::images/tutorial-pattern-1.png[]

. Click *Next step*.
. In *Configure settings*, click *Create index pattern*. For this pattern,
you don't need to configure any settings.
. Define a second index pattern named `ba*` You don't need to configure any settings for this pattern.
. In *Configure settings*, click *Create index pattern*.
+
You’re presented a table of all fields and associated data types in the index.

. Return to the *Index patterns* overview page and define a second index pattern named `ba*`.

[float]
==== Create an index pattern for time series data

Now create an index pattern for the Logstash data set. This data set
contains time-series data.
Now create an index pattern for the Logstash index, which
contains time series data.

. Define an index pattern named `logstash*`.
. Click *Next step*.
. In *Configure settings*, select *@timestamp* in the *Time Filter field name* dropdown menu.
. Open the *Time Filter field name* dropdown and select *@timestamp*.
. Click *Create index pattern*.




NOTE: When you define an index pattern, the indices that match that pattern must
exist in Elasticsearch and they must contain data. To check which indices are
available, go to *Dev Tools > Console* and enter `GET _cat/indices`. Alternately, use
`curl -XGET "http://localhost:9200/_cat/indices"`.



21 changes: 12 additions & 9 deletions docs/getting-started/tutorial-discovering.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[tutorial-discovering]]
=== Discovering your data
=== Discover your data

Using the Discover application, you can enter
an {ref}/query-dsl-query-string-query.html#query-string-syntax[Elasticsearch
Expand All @@ -11,23 +11,26 @@ The current index pattern appears below the filter bar, in this case `shakes*`.
You might need to click *New* in the menu bar to refresh the data.

. Click the caret to the right of the current index pattern, and select `ba*`.
+
By default, all fields are shown for each matching document.

. In the search field, enter the following string:
+
[source,text]
account_number<100 AND balance>47500

+
The search returns all account numbers between zero and 99 with balances in
excess of 47,500. It returns results for account numbers 8, 32, 78, 85, and 97.

excess of 47,500. Results appear for account numbers 8, 32, 78, 85, and 97.
+
[role="screenshot"]
image::images/tutorial-discover-2.png[]

By default, all fields are shown for each matching document. To choose which
fields to display, hover the pointer over the list of *Available Fields*
+
. To choose which
fields to display, hover the pointer over the list of *Available fields*
and then click *add* next to each field you want include as a column in the table.

+
For example, if you add the `account_number` field, the display changes to a list of five
account numbers.

+
[role="screenshot"]
image::images/tutorial-discover-3.png[]
Loading

0 comments on commit a6b8036

Please sign in to comment.