Skip to content
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

Add content about loading dashboards to the ref guide for each Beat #2505

Merged
merged 1 commit into from
Sep 13, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions filebeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -199,10 +199,10 @@ Filebeat is now ready to send log files to your defined output.

We don't offer prebuilt dashboards for visualizing Filebeat data. However, to make it easier for you to explore Filebeat
data in Kibana, we've created a Filebeat index pattern: `filebeat-*`. To load this pattern, you can use the script
that's provided for loading dashboards.
that's provided for importing dashboards.

For more information about running the script, see
{libbeat}/load-kibana-dashboards.html[Loading the Beats Dashboards].
{libbeat}/load-kibana-dashboards.html[Importing Existing Beat Dashboards] in the _Beats Platform Reference_.

After you've created the index pattern, you can select the `filebeat-*` index pattern in Kibana to explore
Filebeat data.
Expand Down
75 changes: 47 additions & 28 deletions libbeat/docs/dashboards.asciidoc
Original file line number Diff line number Diff line change
@@ -1,60 +1,83 @@
//////////////////////////////////////////////////////////////////////////
//// This content is shared by all Elastic Beats. Make sure you keep the
//// descriptions here generic enough to work for all Beats that include
//// this file. When using cross references, make sure that the cross
//// references resolve correctly for any files that include this one.
//// Use the appropriate variables defined in the index.asciidoc file to
//// resolve Beat names: beatname_uc and beatname_lc. This topic must
//// be included under a level 3 header.
//// Use the following include to pull this content into a doc file:
//// include::../../libbeat/docs/dashboards.asciidoc[]
//////////////////////////////////////////////////////////////////////////


[[load-kibana-dashboards]]
=== Importing the Beats Dashboards
==== Importing the Dashboards

[NOTE]
.Known Doc Issue in 5.0.0-alpha5
====
The instructions in this section describe how to use a script that's not available in the {beatname_uc} 5.0.0-alpha5
download package. If you are importing dashboards for 5.0.0-alpha5, you need to run one of the
import scripts in the `kibana` directory: `import_dashboards.sh` or `import_dashboards.ps1`.
Use the `-help` command to see the list of options for running the script. For example:
`./import_dashboards.sh -help`.

Kibana has a large set of visualization types that you can combine to create
the perfect dashboards for your needs. But this flexibility can be a bit
overwhelming at the beginning, so we have created some sample dashboards to get you
started and to demonstrate what is possible based on the Beats data.
====

Each Beat comes packaged with the `scripts/import_dashboards` script that you can use to import the example dashboards,
visualizations, and searches for that Beat. The script also creates index patterns, such as
`packetbeat-*` for Packetbeat, `metricbeat-*` for Metricbeat, and so on.
{beatname_uc} comes packaged with the `scripts/import_dashboards` script that you can use to import the example dashboards,
visualizations, and searches for {beatname_uc}. The script also creates an index pattern,
+{beatname_lc}-*+, for {beatname_uc}.

The steps in this section show how to import {beatname_uc} dashboards. You may want to import dashboards for more than
one Beat or specify import options that aren't described here. See {libbeat}/[Importing Existing Beat Dashboards]
in the _Beats Platform Reference_ for a full list of command-line options.

The command line options of the script, together with more examples, are available under the
<<import-dashboards,import_dashboards>> section.
To import the Kibana dashboards for {beatname_uc}:

Use the following command to import the Kibana dashboards for any of the Elastic Beats:
ifdef::allplatforms[]

*deb, rpm, and mac:*

From the directory where you installed the Beat, run the `import_dashboards` script.
From the directory where you installed {beatname_uc}, run the `import_dashboards` script.

["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------------
$ ./scripts/import_dashboards
./scripts/import_dashboards
----------------------------------------------------------------------

On deb and rpm, the `scripts` folder is located under the home path, which is `/usr/share/{beat_name}/` unless you change it.
On deb and rpm, the `scripts` folder is located under the home path, which is +/usr/share/{beatname_lc}/+ unless you change it.

By default, the script assumes that you are running Elasticsearch on `127.0.0.1:9200`. Use the `-es` option
to specify a different location. For example:

["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------------
$ ./scripts/import_dashboards -es http://192.168.33.60:9200
./scripts/import_dashboards -es http://192.168.33.60:9200
----------------------------------------------------------------------

The username and password to use for Elasticsearch authentication. There are a few ways to pass in the username and password. For example:
Use the `-user` option to specify the username and password to use for Elasticsearch authentication. There are a few ways to pass
in the username and password. For example:

["source","sh",subs="attributes,callouts"]
-----------------------------------------------------------------------
$ ./scripts/import_dashboards -es https://xyz.found.io -user user -pass password <1>
$ ./scripts/import_dashboards -es https://xyz.found.io -user admin -pass $(cat ~/pass-file) <2>
./scripts/import_dashboards -es https://xyz.found.io -user user -pass password <1>
./scripts/import_dashboards -es https://xyz.found.io -user admin -pass $(cat ~/pass-file) <2>
-----------------------------------------------------------------------

<1> Specify the username and password as options.
<2> Use a file to avoid polluting the bash history with the password.


*win:*

endif::allplatforms[]

Open a PowerShell prompt as an Administrator (right-click the PowerShell icon
and select *Run As Administrator*). If you are running Windows XP, you may need
to download and install PowerShell.

From the directory where you installed the Beat, run the `import_dashboards` script:
+
From the directory where you installed {beatname_uc}, run the `import_dashboards` script:

["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------------
PS > scripts\import_dashboards
Expand All @@ -72,21 +95,17 @@ NOTE: If script execution is disabled on your system, you need to set the execut
allow the script to run. For example: `PowerShell.exe -ExecutionPolicy UnRestricted -File scripts\import_dashboards -es http://192.168.33.60:9200`.


The username and password to use for authentication:
Use the `-user` option to specify the username and password to use for Elasticsearch authentication:

["source","sh",subs="attributes,callouts"]
-----------------------------------------------------------------------
PS > scripts\import_dashboards -es https://xyz.found.io -user user -pass password
-----------------------------------------------------------------------


Please see <<import-dashboards,import Kibana dashboards>> for more details about the `import_dashboards` script.

[[view-kibana-dashboards]]
=== Opening the Beats Dashboards in Kibana
==== Opening the Dashboards in Kibana

After <<load-kibana-dashboards,importing the Beats dashboards>>,
launch the Kibana web interface by pointing your browser
After importing the dashboards, launch the Kibana web interface by pointing your browser
to port 5601. For example, http://127.0.0.1:5601[http://127.0.0.1:5601].

If Kibana shows a `No default index pattern` warning, you must select or create
Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/gettingstarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A regular _Beats setup_ consists of:
* Logstash (optional) for inserting data into Elasticsearch. See <<logstash-installation,Installing Logstash>>.
* Kibana for the UI. See <<kibana-installation>>.
* One or more Beats. You install the Beats on your servers to capture operational data. See <<installing-beats>>.
* Kibana dashboards for visualizing the data. See <<load-kibana-dashboards>>.
* Kibana dashboards for visualizing the data.

See the https://www.elastic.co/support/matrix[Elastic Support Matrix] for information
about supported operating systems and product compatibility.
Expand Down
4 changes: 2 additions & 2 deletions libbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ include::./repositories.asciidoc[]

include::./config-file-format.asciidoc[]

include::./visualizing-data.asciidoc[]
// include::./visualizing-data.asciidoc[]

include::./dashboards.asciidoc[]
//include::./dashboards.asciidoc[]

pass::[<?page_header <b>PLEASE NOTE:</b><br/>Always refer to the documentation in master for the latest information about contributing to Beats.?>]

Expand Down
4 changes: 2 additions & 2 deletions libbeat/docs/shared-template-load.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,10 @@ cd {beatname_lc}-{version}-darwin
curl -XPUT 'http://localhost:9200/_template/{beatname_lc}' -d@{beatname_lc}.template.json
----------------------------------------------------------------------

endif::allplatforms[]

*win:*

endif::allplatforms[]

["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------------
PS C:\Program Files{backslash}{beatname_uc}> Invoke-WebRequest -Method Put -InFile {beatname_lc}.template.json -Uri http://localhost:9200/_template/{beatname_lc}?pretty
Expand Down
12 changes: 6 additions & 6 deletions metricbeat/docs/gettingstarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -232,12 +232,12 @@ URL.
=== Step 5: Loading Sample Kibana Dashboards

To make it easier for you to start monitoring your servers in Kibana,
we have created a sample Metricbeat dashboard. This dashboard is provided as
an example. We recommend that you
http://www.elastic.co/guide/en/kibana/current/dashboard.html[customize] it
we have created sample Metricbeat dashboards. The dashboards are provided as
examples. We recommend that you
http://www.elastic.co/guide/en/kibana/current/dashboard.html[customize] them
to meet your needs.

For more information, see
{libbeat}/load-kibana-dashboards.html[Loading the Beats Dashboards].

image:./images/metricbeat_system_dashboard.png[Metricbeat Dashboard]

:allplatforms
include::../../libbeat/docs/dashboards.asciidoc[]
Binary file added metricbeat/docs/images/kibana-created-indexes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added metricbeat/docs/images/kibana-navigation-vis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions packetbeat/docs/gettingstarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -258,12 +258,12 @@ instance. The command should return data about the HTTP transaction you just cre
=== Step 5: Loading Sample Kibana Dashboards

To make it easier for you to get application performance insights
from packet data, we have created a sample Packetbeat dashboard. This dashboard is provided as
an example. We recommend that you
http://www.elastic.co/guide/en/kibana/current/dashboard.html[customize] it
from packet data, we have created sample Packetbeat dashboards. The dashboards are provided as
examples. We recommend that you
http://www.elastic.co/guide/en/kibana/current/dashboard.html[customize] them
to meet your needs.

For more information, see
{libbeat}/load-kibana-dashboards.html[Loading the Beats Dashboards].

image:./images/packetbeat-statistics.png[Packetbeat statistics]

:allplatforms
include::../../libbeat/docs/dashboards.asciidoc[]
Binary file modified packetbeat/docs/images/kibana-created-indexes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packetbeat/docs/images/kibana-navigation-vis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions packetbeat/docs/visualizing-data-packetbeat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

[partintro]
--

Before trying to visualize Packetbeat data in Kibana, we recommend that you load the sample dashboards {libbeat}/visualizing-data.html[described here]. Then read the topics in this
section to learn how to work with Packetbeat data in Kibana:

Expand Down
10 changes: 4 additions & 6 deletions winlogbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -163,13 +163,11 @@ PS C:\Program Files\Winlogbeat> Stop-Service winlogbeat
=== Step 6: Loading Sample Kibana Dashboards

To make it easier for you to start monitoring your servers in Kibana,
we have created a sample Winlogbeat dashboard. This dashboard is provided as
an example. We recommend that you
http://www.elastic.co/guide/en/kibana/current/dashboard.html[customize] it
we have created sample Winlogbeat dashboards. The dashboards are provided as
examples. We recommend that you
http://www.elastic.co/guide/en/kibana/current/dashboard.html[customize] them
to meet your needs.

For more information, see
{libbeat}/load-kibana-dashboards.html[Loading the Beats Dashboards].

image:./images/winlogbeat-dashboard.png[Winlogbeat statistics]

include::../../libbeat/docs/dashboards.asciidoc[]
Binary file added winlogbeat/docs/images/kibana-created-indexes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added winlogbeat/docs/images/kibana-navigation-vis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.