Skip to content

Commit e8faa07

Browse files
authored
[docs][APM] Add runtime index config documentation (#53907) (#54320)
1 parent 81d9c40 commit e8faa07

File tree

4 files changed

+43
-10
lines changed

4 files changed

+43
-10
lines changed

docs/apm/settings.asciidoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,16 @@
33
[[apm-settings-in-kibana]]
44
=== APM settings in Kibana
55

6-
You do not need to configure any settings to use APM. It is enabled by default.
7-
If you'd like to change any of the default values,
8-
copy and paste the relevant settings below into your `kibana.yml` configuration file.
6+
You do not need to configure any settings to use the APM app. It is enabled by default.
7+
8+
[float]
9+
[[apm-indices-settings]]
10+
==== APM Indices
11+
12+
include::./../settings/apm-settings.asciidoc[tag=apm-indices-settings]
13+
14+
[float]
15+
[[general-apm-settings]]
16+
==== General APM settings
917

1018
include::./../settings/apm-settings.asciidoc[tag=general-apm-settings]

docs/apm/troubleshooting.asciidoc

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ This section can help with any of the following:
1717
There are a number of factors that could be at play here.
1818
One important thing to double-check first is your index template.
1919

20+
*Index template*
2021
An APM index template must exist for the APM app to work correctly.
2122
By default, this index template is created by APM Server on startup.
2223
However, this only happens if `setup.template.enabled` is `true` in `apm-server.yml`.
@@ -34,14 +35,21 @@ GET /_template/apm-{version}
3435
--------------------------------------------------
3536
// CONSOLE
3637

38+
*Using Logstash, Kafka, etc.*
3739
If you're not outputting data directly from APM Server to Elasticsearch (perhaps you're using Logstash or Kafka),
3840
then the index template will not be set up automatically. Instead, you'll need to
39-
{apm-server-ref}/_manually_loading_template_configuration.html#load-template-manually-alternate[load the template manually].
41+
{apm-server-ref}/_manually_loading_template_configuration.html[load the template manually].
4042

41-
Finally, this problem can also occur if you've changed the index name that you write APM data to.
42-
The default index pattern can be found {apm-server-ref}/elasticsearch-output.html#index-option-es[here].
43-
If you change this setting, you must also configure the `setup.template.name` and `setup.template.pattern` options.
43+
*Using a custom index names*
44+
This problem can also occur if you've customized the index name that you write APM data to.
45+
The default index name that APM writes events to can be found
46+
{apm-server-ref}/elasticsearch-output.html#index-option-es[here].
47+
If you change the default, you must also configure the `setup.template.name` and `setup.template.pattern` options.
4448
See {apm-server-ref}/configuration-template.html[Load the Elasticsearch index template].
49+
If the Elasticsearch index template has already been successfully loaded to the index,
50+
you can customize the indices that the APM app uses to display data.
51+
Navigate to *APM* > *Settings* > *Indices*, and change all `apm_oss.*Pattern` values to
52+
include the new index pattern. For example: `customIndexName-*`.
4553

4654
==== Unknown route
4755

docs/settings/apm-settings.asciidoc

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,23 @@
55
<titleabbrev>APM settings</titleabbrev>
66
++++
77

8-
You do not need to configure any settings to use APM. It is enabled by default.
9-
If you'd like to change any of the default values,
10-
copy and paste the relevant settings below into your `kibana.yml` configuration file.
8+
You do not need to configure any settings to use the APM app. It is enabled by default.
9+
10+
[float]
11+
[[apm-indices-settings-kb]]
12+
==== APM Indices
13+
14+
// This content is reused in the APM app documentation.
15+
// Any changes made in this file will be seen there as well.
16+
// tag::apm-indices-settings[]
17+
18+
Index defaults can be changed in Kibana. Navigate to *APM* > *Settings* > *Indices*.
19+
Index settings in the APM app take precedence over those set in `kibana.yml`.
20+
21+
[role="screenshot"]
22+
image::settings/images/apm-settings.png[APM app settings in Kibana]
23+
24+
// end::apm-indices-settings[]
1125

1226
[float]
1327
[[general-apm-settings-kb]]
@@ -17,6 +31,9 @@ copy and paste the relevant settings below into your `kibana.yml` configuration
1731
// Any changes made in this file will be seen there as well.
1832
// tag::general-apm-settings[]
1933

34+
If you'd like to change any of the default values,
35+
copy and paste the relevant settings below into your `kibana.yml` configuration file.
36+
2037
xpack.apm.enabled:: Set to `false` to disabled the APM plugin {kib}. Defaults to
2138
`true`.
2239

292 KB
Loading

0 commit comments

Comments
 (0)