Skip to content

Commit c924c06

Browse files
committed
update beats docs.
1 parent aa6b8cd commit c924c06

File tree

6 files changed

+33
-23
lines changed

6 files changed

+33
-23
lines changed

docs/copied-from-beats/command-reference.asciidoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
:modules-command-short-desc: Manages configured modules
2121
:run-command-short-desc: Runs {beatname_uc}. This command is used by default if you start {beatname_uc} without specifying a command
2222

23-
ifndef::deprecate_dashboard_loading[]
23+
ifndef::deprecate_dashboard_loading[]
2424

2525
ifdef::has_ml_jobs[]
2626
:setup-command-short-desc: Sets up the initial environment, including the index template, Kibana dashboards (when available), and machine learning jobs (when available)
@@ -32,9 +32,9 @@ endif::[]
3232

3333
endif::[]
3434

35-
ifdef::deprecate_dashboard_loading[]
35+
ifdef::deprecate_dashboard_loading[]
3636

37-
:setup-command-short-desc: Sets up the initial environment,
37+
:setup-command-short-desc: Sets up the initial environment,
3838
including the ES index template and Kibana dashboards (deprecated).
3939

4040
endif::[]
@@ -50,12 +50,12 @@ endif::[]
5050
<titleabbrev>Command reference</titleabbrev>
5151
++++
5252

53-
ifndef::deprecate_dashboard_loading[]
53+
ifndef::deprecate_dashboard_loading[]
5454
{beatname_uc} provides a command-line interface for starting {beatname_uc} and
55-
performing common tasks, like testing configuration files and loading dashboards.
55+
performing common tasks, like testing configuration files and loading dashboards.
5656
endif::[]
5757

58-
ifdef::deprecate_dashboard_loading[]
58+
ifdef::deprecate_dashboard_loading[]
5959
{beatname_uc} provides a command-line interface for starting {beatname_uc} and
6060
performing common tasks, like testing configuration files and loading dashboards (deprecated).
6161
endif::[]
@@ -409,16 +409,16 @@ the end of the file is reached. By default harvesters are closed after
409409

410410
endif::[]
411411

412-
ifndef::deprecate_dashboard_loading[]
413-
*`--setup`*::
412+
ifndef::deprecate_dashboard_loading[]
413+
*`--setup`*::
414414
endif::[]
415415

416-
ifdef::deprecate_dashboard_loading[]
417-
*`--setup (deprecated)`*::
416+
ifdef::deprecate_dashboard_loading[]
417+
*`--setup (deprecated)`*::
418418
endif::[]
419419

420420
ifdef::has_ml_jobs[]
421-
Loads the initial setup, including Elasticsearch template, Kibana index pattern,
421+
Loads the initial setup, including Elasticsearch template, Kibana index pattern,
422422
Kibana dashboards and Machine learning jobs.
423423
endif::[]
424424

@@ -471,7 +471,7 @@ Or:
471471

472472
* The Kibana dashboards make it easier for you to visualize {beatname_uc} data
473473
in Kibana.
474-
ifdef::deprecate_dashboard_loading[]
474+
ifdef::deprecate_dashboard_loading[]
475475
(deprecated)
476476
endif::[]
477477

@@ -493,15 +493,15 @@ environment without actually running {beatname_uc} and ingesting data.
493493

494494
*FLAGS*
495495

496-
ifndef::deprecate_dashboard_loading[]
496+
ifndef::deprecate_dashboard_loading[]
497497
*`--dashboards`*::
498498
Sets up the Kibana dashboards only. This option loads the dashboards from the
499499
{beatname_uc} package. For more options, such as loading customized dashboards,
500500
see {beatsdevguide}/import-dashboards.html[Importing Existing Beat Dashboards]
501501
in the _Beats Developer Guide_.
502502
endif::[]
503503

504-
ifdef::deprecate_dashboard_loading[]
504+
ifdef::deprecate_dashboard_loading[]
505505
*`--dashboards` (deprecated)*::
506506
Sets up the Kibana dashboards only.
507507
endif::[]

docs/copied-from-beats/dashboardsconfig.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@
1010
//////////////////////////////////////////////////////////////////////////
1111

1212
[[configuration-dashboards]]
13+
ifndef::deprecate_dashboard_loading[]
14+
== Load the Kibana dashboards
15+
endif::[]
16+
17+
ifdef::deprecate_dashboard_loading[]
1318
== Load the Kibana dashboards (deprecated)
19+
endif::[]
1420

1521
{beatname_uc} comes packaged with example Kibana dashboards, visualizations,
1622
and searches for visualizing {beatname_uc} data in Kibana.

docs/copied-from-beats/outputconfig.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -216,18 +216,18 @@ The index name to write events to. The default is
216216
+"{beatname_lc}-%\{[beat.version]\}-%\{+yyyy.MM.dd\}"+ (for example,
217217
+"{beatname_lc}-{version}-2017.04.26"+). If you change this setting, you also
218218
need to configure the `setup.template.name` and `setup.template.pattern` options
219-
(see <<configuration-template>>).
219+
(see <<configuration-template>>).
220220

221-
ifndef::deprecate_dashboard_loading[]
221+
ifndef::deprecate_dashboard_loading[]
222222

223-
If you are using the pre-built Kibana dashboards,
223+
If you are using the pre-built Kibana dashboards,
224224
you also need to set the `setup.dashboards.index` option (see <<configuration-dashboards>>).
225225

226226
endif::[]
227227

228-
ifdef::deprecate_dashboard_loading[]
228+
ifdef::deprecate_dashboard_loading[]
229229

230-
If you are using the pre-built Kibana dashboards,
230+
If you are using the pre-built Kibana dashboards,
231231
you also need to set the index pattern properly when loading the dashboards via the Kibana UI.
232232

233233
endif::[]

docs/copied-from-beats/shared-kibana-config.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@
1010
//////////////////////////////////////////////////////////////////////////
1111

1212
[[setup-kibana-endpoint]]
13+
ifndef::deprecate_dashboard_loading[]
14+
== Set up the Kibana endpoint
15+
endif::[]
16+
ifdef::deprecate_dashboard_loading[]
1317
== Set up the Kibana endpoint (deprecated)
18+
endif::[]
19+
1420

1521
ifeval::["{beatname_lc}" == "apm-server"]
1622
The Kibana dashboards are loaded into Kibana via the Kibana API.

docs/copied-from-beats/shared-ssl-config.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ You can specify SSL options when you configure:
55

66
* <<configuring-output,outputs>> that support SSL
77
* the <<setup-kibana-endpoint,Kibana endpoint>>
8-
98
ifeval::["{beatname_lc}"=="heartbeat"]
109
* <<configuration-heartbeat-options,{beatname_uc} monitors>> that support SSL
1110
endif::[]
@@ -24,7 +23,6 @@ ifndef::only-elasticsearch[]
2423
Also see <<configuring-ssl-logstash>>.
2524
endif::[]
2625

27-
2826
Example Kibana endpoint config with SSL enabled:
2927

3028
[source,yaml]

docs/copied-from-beats/shared-template-load.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ that you specify should include the root name of the index plus version and
9494
date information. You also need to configure the `setup.template.name` and
9595
`setup.template.pattern` options to match the new name. For example:
9696
+
97-
ifndef::deprecate_dashboard_loading[]
97+
ifndef::deprecate_dashboard_loading[]
9898

9999
["source","sh",subs="attributes,callouts"]
100100
-----
@@ -111,7 +111,7 @@ pattern.
111111

112112
endif::[]
113113

114-
ifdef::deprecate_dashboard_loading[]
114+
ifdef::deprecate_dashboard_loading[]
115115

116116
["source","sh",subs="attributes,callouts"]
117117
-----

0 commit comments

Comments
 (0)