Skip to content

Commit 6bd8383

Browse files
committed
Align with beats, use deprecated.
1 parent 9daf594 commit 6bd8383

File tree

7 files changed

+22
-34
lines changed

7 files changed

+22
-34
lines changed

docs/configuring.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ The following topics describe how to configure APM Server:
1212
* <<configuration-ssl>>
1313
* <<configuration-template>>
1414
* <<configuration-logging>>
15-
* <<setup-kibana-endpoint, Set up the Kibana endpoint (deprecated)>>
16-
* <<configuration-dashboards, Load the Kibana dashboards (deprecated)>>
15+
* <<setup-kibana-endpoint>>
16+
* <<configuration-dashboards>>
1717
* <<configuration-rum>>
1818
* <<using-environ-vars>>
1919
* <<configuration-path>>

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

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ endif::[]
3434

3535
ifdef::deprecate_dashboard_loading[]
3636

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

4039
endif::[]
4140

@@ -409,25 +408,21 @@ the end of the file is reached. By default harvesters are closed after
409408

410409
endif::[]
411410

412-
ifndef::deprecate_dashboard_loading[]
413411
*`--setup`*::
414-
endif::[]
415-
416412
ifdef::deprecate_dashboard_loading[]
417-
*`--setup (deprecated)`*::
413+
deprecated[{deprecate_dashboard_loading}]
418414
endif::[]
419-
415+
+
420416
ifdef::has_ml_jobs[]
421417
Loads the initial setup, including Elasticsearch template, Kibana index pattern,
422418
Kibana dashboards and Machine learning jobs.
423419
endif::[]
424-
425420
ifndef::has_ml_jobs[]
426421
Loads the initial setup, including Elasticsearch template, Kibana index pattern and Kibana dashboards.
427422
endif::[]
428-
429423
If you want to use the command without running {beatname_uc}, use the <<setup-command,`setup`>> command instead.
430424

425+
431426
ifeval::["{beatname_lc}"=="metricbeat"]
432427

433428
*`--system.hostfs MOUNT_POINT`*::
@@ -465,15 +460,12 @@ Or:
465460
[[setup-command]]
466461
==== `setup` command
467462

468-
{setup-command-short-desc}.
463+
{setup-command-short-desc}
469464

470465
* The index template ensures that fields are mapped correctly in Elasticsearch.
471466

472467
* The Kibana dashboards make it easier for you to visualize {beatname_uc} data
473468
in Kibana.
474-
ifdef::deprecate_dashboard_loading[]
475-
(deprecated)
476-
endif::[]
477469

478470
ifdef::has_ml_jobs[]
479471
* The machine learning jobs contain the configuration information and metadata
@@ -502,7 +494,10 @@ in the _Beats Developer Guide_.
502494
endif::[]
503495

504496
ifdef::deprecate_dashboard_loading[]
505-
*`--dashboards` (deprecated)*::
497+
*`--dashboards`*::
498+
499+
deprecated[{deprecate_dashboard_loading}]
500+
+
506501
Sets up the Kibana dashboards only.
507502
endif::[]
508503

docs/copied-from-beats/dashboardsconfig.asciidoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@
1010
//////////////////////////////////////////////////////////////////////////
1111

1212
[[configuration-dashboards]]
13-
ifndef::deprecate_dashboard_loading[]
1413
== Load the Kibana dashboards
15-
endif::[]
16-
1714
ifdef::deprecate_dashboard_loading[]
18-
== Load the Kibana dashboards (deprecated)
15+
16+
deprecated[{deprecate_dashboard_loading}]
17+
1918
endif::[]
2019

2120
{beatname_uc} comes packaged with example Kibana dashboards, visualizations,

docs/copied-from-beats/outputconfig.asciidoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -218,17 +218,12 @@ The index name to write events to. The default is
218218
need to configure the `setup.template.name` and `setup.template.pattern` options
219219
(see <<configuration-template>>).
220220

221-
ifndef::deprecate_dashboard_loading[]
222-
223221
If you are using the pre-built Kibana dashboards,
224222
you also need to set the `setup.dashboards.index` option (see <<configuration-dashboards>>).
225223

226-
endif::[]
227-
228224
ifdef::deprecate_dashboard_loading[]
229225

230-
If you are using the pre-built Kibana dashboards,
231-
you also need to set the index pattern properly when loading the dashboards via the Kibana UI.
226+
deprecated[{deprecate_dashboard_loading}]
232227

233228
endif::[]
234229

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,12 @@
1010
//////////////////////////////////////////////////////////////////////////
1111

1212
[[setup-kibana-endpoint]]
13-
ifndef::deprecate_dashboard_loading[]
1413
== Set up the Kibana endpoint
15-
endif::[]
1614
ifdef::deprecate_dashboard_loading[]
17-
== Set up the Kibana endpoint (deprecated)
18-
endif::[]
1915

16+
deprecated[{deprecate_dashboard_loading}]
17+
18+
endif::[]
2019

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

docs/dashboards.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33

44
From APM Server and Kibana 6.4 on you can load dashboards directly via the Kibana UI.
55

6-
NOTE: Loading index pattern and dashboards through the APM Server is deprecated.
7-
It is recommended to use the Kibana UI instead.
6+
==== Setup via APM Server
7+
8+
deprecated[{deprecate_dashboard_loading}]
89

9-
==== Setup via APM Server (deprecated)
1010
Loading via APM Server requires a <<setup-kibana-endpoint,Kibana endpoint configuration>>.
1111
If you are accessing a secured Kibana instance, make sure you've configured credentials.
1212

docs/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
1717
:logstashdoc: https://www.elastic.co/guide/en/logstash/{doc-branch}
1818
:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/{doc-branch}
1919
:securitydoc: https://www.elastic.co/guide/en/elastic-stack-overview/{doc-branch}
20-
:deprecate_dashboard_loading: true
20+
:deprecate_dashboard_loading: 6.4.0
2121

2222
ifdef::env-github[]
2323
NOTE: For the best reading experience,

0 commit comments

Comments
 (0)