Skip to content

[docs][APM] Add APM settings page #53172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 16, 2019
Merged

[docs][APM] Add APM settings page #53172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3309a9
docs: add apm settings page
bmorelli25 Dec 16, 2019
b9ee89f
docs: add settings overview
bmorelli25 Dec 16, 2019
6be8d1c
docs: update jump table while I’m here
bmorelli25 Dec 16, 2019
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
10 changes: 10 additions & 0 deletions docs/apm/settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Do not link directly to this page.
// Link to the anchor in `/docs/settings/apm-settings.asciidoc` instead.
[[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.

include::./../settings/apm-settings.asciidoc[tag=general-apm-settings]
23 changes: 14 additions & 9 deletions docs/apm/using-the-apm-ui.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,18 @@ Not to worry, we've created this guide to help you get the most out of Elastic A

APM is available via the navigation sidebar in {Kib}.

* <<filters,Filters>>
* <<services,Services overview>>
* <<traces,Traces overview>>
* <<transactions,Transaction overview>>
* <<spans,Span timeline visualization>>
* <<errors,Debug errors>>
* <<metrics,Metrics overview>>
* <<machine-learning-integration,Machine learning integration>>
* <<query-bar,Advanced queries>>
* <<filters>>
* <<services>>
* <<traces>>
* <<transactions>>
* <<spans>>
* <<errors>>
* <<metrics>>
* <<machine-learning-integration>>
* <<agent-configuration>>
* <<advanced-queries>>
* <<apm-settings-in-kibana>>
* <<troubleshooting>>

include::filters.asciidoc[]

Expand All @@ -36,4 +39,6 @@ include::agent-configuration.asciidoc[]

include::advanced-queries.asciidoc[]

include::settings.asciidoc[]

include::troubleshooting.asciidoc[]
5 changes: 5 additions & 0 deletions docs/settings/apm-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ copy and paste the relevant settings below into your `kibana.yml` configuration
[[general-apm-settings-kb]]
==== General APM settings

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

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

Expand All @@ -37,3 +41,4 @@ apm_oss.metricsIndices:: Matcher for indices containing metric documents. Defaul

apm_oss.sourcemapIndices:: Matcher for indices containing sourcemap documents. Defaults to `apm-*`.

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