Skip to content

Commit

Permalink
[docs][APM] Add runtime index config documentation (elastic#53907) (e…
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 authored Jan 14, 2020
1 parent 81d9c40 commit e8faa07
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 10 deletions.
14 changes: 11 additions & 3 deletions docs/apm/settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,16 @@
[[apm-settings-in-kibana]]
=== APM settings in Kibana

You do not need to configure any settings to use APM. It is enabled by default.
If you'd like to change any of the default values,
copy and paste the relevant settings below into your `kibana.yml` configuration file.
You do not need to configure any settings to use the APM app. It is enabled by default.

[float]
[[apm-indices-settings]]
==== APM Indices

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

[float]
[[general-apm-settings]]
==== General APM settings

include::./../settings/apm-settings.asciidoc[tag=general-apm-settings]
16 changes: 12 additions & 4 deletions docs/apm/troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This section can help with any of the following:
There are a number of factors that could be at play here.
One important thing to double-check first is your index template.

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

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

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

==== Unknown route

Expand Down
23 changes: 20 additions & 3 deletions docs/settings/apm-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,23 @@
<titleabbrev>APM settings</titleabbrev>
++++

You do not need to configure any settings to use APM. It is enabled by default.
If you'd like to change any of the default values,
copy and paste the relevant settings below into your `kibana.yml` configuration file.
You do not need to configure any settings to use the APM app. It is enabled by default.

[float]
[[apm-indices-settings-kb]]
==== APM Indices

// This content is reused in the APM app documentation.
// Any changes made in this file will be seen there as well.
// tag::apm-indices-settings[]

Index defaults can be changed in Kibana. Navigate to *APM* > *Settings* > *Indices*.
Index settings in the APM app take precedence over those set in `kibana.yml`.

[role="screenshot"]
image::settings/images/apm-settings.png[APM app settings in Kibana]

// end::apm-indices-settings[]

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

If you'd like to change any of the default values,
copy and paste the relevant settings below into your `kibana.yml` configuration file.

xpack.apm.enabled:: Set to `false` to disabled the APM plugin {kib}. Defaults to
`true`.

Expand Down
Binary file added docs/settings/images/apm-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e8faa07

Please sign in to comment.