Skip to content

Commit

Permalink
Add steps for loading journalbeat dashboards (elastic#9167)
Browse files Browse the repository at this point in the history
* Add steps for loading and viewing dashboards

* Deprecate global options for backoff, max_backoff, seek, and include_matches

* Add screen capture

* Move tip to correct place in doc
  • Loading branch information
dedemorton committed Mar 6, 2019
1 parent 2658a6e commit 06dff1b
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 15 deletions.
10 changes: 6 additions & 4 deletions journalbeat/docs/general-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,28 @@ data path. See the <<directory-layout>> section for details. The default is `${p
----

[float]
==== `backoff`
==== `backoff` deprecated[5.6.1,Use the option under `paths` instead.]

This option is valid as a global setting under the +{beatname_lc}+ namespace
or under `paths`. For a description of this option, see
<<{beatname_lc}-backoff,`backoff`>>.

[float]
==== `max_backoff`
==== `max_backoff` deprecated[5.6.1,Use the option under `paths` instead.]

This option is valid as a global setting under the +{beatname_lc}+ namespace
or under `paths`. For a description of this option, see
<<{beatname_lc}-max-backoff,`max_backoff`>>.

[float]
==== `seek`
==== `seek` deprecated[5.6.1,Use the option under `paths` instead.]

This option is valid as a global setting under the +{beatname_lc}+ namespace
or under `paths`. For a description of this option, see
<<{beatname_lc}-seek,`seek`>>.

[float]
==== `include_matches`
==== `include_matches` deprecated[5.6.1,Use the option under `paths` instead.]

This option is valid as a global setting under the +{beatname_lc}+ namespace
or under `paths`. For a description of this option, see
Expand Down
34 changes: 26 additions & 8 deletions journalbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[]
* <<{beatname_lc}-installation>>
* <<{beatname_lc}-configuration>>
* <<{beatname_lc}-template>>
* <<load-kibana-dashboards>>
* <<{beatname_lc}-starting>>
* <<view-kibana-dashboards>>
* <<setup-repositories>>

[id="{beatname_lc}-installation"]
Expand Down Expand Up @@ -159,8 +161,15 @@ include::{libbeat-dir}/docs/step-look-at-config.asciidoc[]

include::{libbeat-dir}/docs/shared-template-load.asciidoc[]

[[load-kibana-dashboards]]
=== Step 4: Set up the Kibana dashboards

:requires-sudo: yes
include::../../libbeat/docs/dashboards.asciidoc[]
:requires-sudo!:

[id="{beatname_lc}-starting"]
=== Step 4: Start {beatname_uc}
=== Step 5: Start {beatname_uc}

Start {beatname_uc} by issuing the appropriate command for your platform. If you
are accessing a secured Elasticsearch cluster, make sure you've configured
Expand Down Expand Up @@ -193,18 +202,27 @@ in the _Beats Platform Reference_.
{beatname_uc} is now ready to send journal events to the defined output.

[[view-kibana-dashboards]]
=== Step 5: View your data in Kibana
=== Step 6: View the sample Kibana dashboards

To make it easier for you to visualize your log data, we have created example
{beatname_uc} dashboards. You loaded the dashboards earlier when you ran the
`setup` command.

include::../../libbeat/docs/opendashboards.asciidoc[]

The dashboards are provided as examples. We recommend that you
{kibana-ref}/dashboard.html[customize] them to meet your needs.

There are currently no example dashboards available for {beatname_uc}.
[role="screenshot"]
image:./images/journald-log-data.png[Journald data]

To learn how to view and explore your data, see the
_{kibana-ref}/index.html[{kib} User Guide]_.

[NOTE]
=====
By default, the Logs UI in {kib} only shows logs from `filebeat-*`
indexes. To show {beatname_uc} indexes, add the following settings to the {kib}
configuration:
You can also use the {infra-guide}/logs-ui-overview.html[Logs UI] in {kib} to
tail logs in real time. By default, however, the Logs UI only shows logs from
`filebeat-*` indexes. To show {beatname_uc} indexes, add the following settings
to the {kib} configuration:
[source,yaml]
----
Expand Down
Binary file added journalbeat/docs/images/journald-log-data.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 journalbeat/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 journalbeat/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: 0 additions & 1 deletion journalbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:rpm_os:
:linux_os:
:docker_platform:
:no_dashboards:

include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]

Expand Down
4 changes: 2 additions & 2 deletions libbeat/docs/opendashboards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ pattern is selected to see {beatname_uc} data.
[role="screenshot"]
image:./images/kibana-created-indexes.png[Discover tab with index selected]

Go to the *Dashboard* page and select the dashboard that you want to open.

TIP: If you don’t see data in {kib}, try changing the date range to a larger
range. By default, {kib} shows the last 15 minutes.

Go to the *Dashboard* page and select the dashboard that you want to open.

[role="screenshot"]
image:./images/kibana-navigation-vis.png[Navigation widget in Kibana]

0 comments on commit 06dff1b

Please sign in to comment.