Skip to content
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
1 change: 0 additions & 1 deletion heartbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ The following topics describe how to configure Heartbeat:
* <<{beatname_lc}-geoip>>
* <<configuration-path>>
* <<setup-kibana-endpoint>>
* <<configuration-dashboards>>
* <<configuration-template>>
* <<configuration-logging>>
* <<using-environ-vars>>
Expand Down
7 changes: 4 additions & 3 deletions heartbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ include::{libbeat-dir}/docs/shared-template-load.asciidoc[]
[[load-kibana-dashboards]]
=== Step 4: Set up the Kibana dashboards

Dashboards for heartbeat can be found in the https://github.com/elastic/uptime-contrib[uptime-contrib] github repository.
Dashboards for Heartbeat can be found in the https://github.com/elastic/uptime-contrib[uptime-contrib] github repository.

[[heartbeat-starting]]
=== Step 5: Start Heartbeat
Expand Down Expand Up @@ -262,8 +262,9 @@ events to your defined output.
=== Step 6: View the sample Kibana dashboards

To make it easier for you to visualize the status of your services, we have
created example {beatname_uc} dashboards. You loaded the dashboards earlier when
you ran the `setup` command.
created example {beatname_uc} dashboards in the
https://github.com/elastic/uptime-contrib[uptime-contrib] github repository. If
you loaded them earlier, open them now.

include::{libbeat-dir}/docs/opendashboards.asciidoc[]

Expand Down
1 change: 1 addition & 0 deletions heartbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:linux_os:
:docker_platform:
:win_os:
:no_dashboards:

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

Expand Down
11 changes: 11 additions & 0 deletions libbeat/docs/command-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -656,12 +656,23 @@ modules to load pipelines for.
endif::[]

ifeval::["{beatname_lc}"!="filebeat"]

ifndef::no_dashboards[]
["source","sh",subs="attributes"]
-----
{beatname_lc} setup --dashboards
{beatname_lc} setup --machine-learning
{beatname_lc} setup --template
-----
endif::no_dashboards[]
ifdef::no_dashboards[]
["source","sh",subs="attributes"]
-----
{beatname_lc} setup --machine-learning
{beatname_lc} setup --template
-----
endif::no_dashboards[]

endif::[]

[[test-command]]
Expand Down
6 changes: 5 additions & 1 deletion libbeat/docs/shared-docker.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ ifndef::apm-server[]
==== Run the {beatname_uc} setup

Running {beatname_uc} with the setup command will create the index pattern and
load visualizations, dashboards, and machine learning jobs. Run this command:
load visualizations
ifndef::no_dashboards[]
, dashboards,
endif::no_dashboards[]
and machine learning jobs. Run this command:

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="metricbeat") or ("{beatname_lc}"=="heartbeat") or ("{beatname_lc}"=="journalbeat")]
["source", "sh", subs="attributes"]
Expand Down