Skip to content

Commit

Permalink
[DOCS] Reformats the DevelopAPM settings tables into definition lists (
Browse files Browse the repository at this point in the history
…elastic#130303)

Co-authored-by: Kibana Machine <[email protected]>
(cherry picked from commit 9b1828a)
  • Loading branch information
KOTungseth committed May 10, 2022
1 parent 6004345 commit a1d6e26
Showing 1 changed file with 23 additions and 27 deletions.
50 changes: 23 additions & 27 deletions docs/settings/apm-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,42 +21,38 @@ If you'd like to change any of the default values,
copy and paste the relevant settings into your `kibana.yml` configuration file.
Changing these settings may disable features of the APM App.

[cols="2*<"]
|===
| `xpack.apm.enabled`
| Set to `false` to disable the APM app. Defaults to `true`.
`xpack.apm.enabled`::
Set to `false` to disable the APM app. Defaults to `true`.

| `xpack.apm.ui.enabled`
| Set to `false` to hide the APM app from the menu. Defaults to `true`.
`xpack.apm.ui.enabled`{ess-icon}::
Set to `false` to hide the APM app from the menu. Defaults to `true`.

| `xpack.apm.ui.transactionGroupBucketSize`
| Number of top transaction groups displayed in the APM app. Defaults to `100`.
`xpack.apm.ui.transactionGroupBucketSize` {ess-icon}::
Number of top transaction groups displayed in the APM app. Defaults to `1000`.

| `xpack.apm.ui.maxTraceItems`
| Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
`xpack.apm.ui.maxTraceItems` {ess-icon}::
Maximum number of child items displayed when viewing trace details. Defaults to `1000`.

| `apm_oss.indexPattern`
| The index pattern used for integrations with Machine Learning and Query Bar.
It must match all apm indices. Defaults to `apm-*`.
`apm_oss.indexPattern` {ess-icon}::
The index pattern used for integrations with Machine Learning and Query Bar.
It must match all apm indices. Defaults to `apm-*`.

| `apm_oss.errorIndices`
| Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
`apm_oss.errorIndices` {ess-icon}::
Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.

| `apm_oss.onboardingIndices`
| Matcher for all onboarding indices. Defaults to `apm-*`.
`apm_oss.onboardingIndices`::
Matcher for all onboarding indices. Defaults to `apm-*`.

| `apm_oss.spanIndices`
| Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
`apm_oss.spanIndices` {ess-icon}::
Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.

| `apm_oss.transactionIndices`
| Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
`apm_oss.transactionIndices` {ess-icon}::
Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.

| `apm_oss.metricsIndices`
| Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
`apm_oss.metricsIndices`::
Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.

| `apm_oss.sourcemapIndices`
| Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.

|===
`apm_oss.sourcemapIndices`::
Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.

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

0 comments on commit a1d6e26

Please sign in to comment.