github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity

[7.12] [DOCS] Reformats the DevelopAPM settings tables into definition lists (#130303) (#131976)

Browse source 
* [DOCS] Reformats the DevelopAPM settings tables into definition lists (#130303)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 9b1828ac77)

* Fixes broken link

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Kaarina Tungseth 2022-05-12 13:17:01 -05:00 • committed by GitHub
parent 7ed1072796
commit 5f3362b581
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

69
docs/settings/apm-settings.asciidoc
View file

@ -43,58 +43,53 @@ If you'd like to change any of the default values,
copy and paste the relevant settings into your `kibana.yml` configuration file. copy and paste the relevant settings into your `kibana.yml` configuration file.
Changing these settings may disable features of the APM App. 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.maxServiceEnvironments` `xpack.apm.maxServiceEnvironments` {ess-icon}::
| Maximum number of unique service environments recognized by the UI. Defaults to `100`. Maximum number of unique service environments recognized by the UI. Defaults to `100`.
| `xpack.apm.serviceMapFingerprintBucketSize` `xpack.apm.serviceMapFingerprintBucketSize` {ess-icon}::
| Maximum number of unique transaction combinations sampled for generating service map focused on a specific service. Defaults to `100`. Maximum number of unique transaction combinations sampled for generating service map focused on a specific service. Defaults to `100`.
| `xpack.apm.serviceMapFingerprintGlobalBucketSize` `xpack.apm.serviceMapFingerprintGlobalBucketSize` {ess-icon}::
| Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`. Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.
| `xpack.apm.ui.enabled` {ess-icon} `xpack.apm.ui.enabled` {ess-icon}::
| Set to `false` to hide the APM app from the main menu. Defaults to `true`. Set to `false` to hide the APM app from the main menu. Defaults to `true`.
| `xpack.apm.ui.transactionGroupBucketSize` `xpack.apm.ui.transactionGroupBucketSize` {ess-icon}::
| Number of top transaction groups displayed in the APM app. Defaults to `1000`. Number of top transaction groups displayed in the APM app. Defaults to `1000`.
| `xpack.apm.ui.maxTraceItems` {ess-icon} `xpack.apm.ui.maxTraceItems` {ess-icon}::
| Maximum number of child items displayed when viewing trace details. Defaults to `1000`. Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
| `xpack.observability.annotations.index` `xpack.observability.annotations.index` {ess-icon}::
| Index name where Observability annotations are stored. Defaults to `observability-annotations`. Index name where Observability annotations are stored. Defaults to `observability-annotations`.
| `xpack.apm.searchAggregatedTransactions` `xpack.apm.searchAggregatedTransactions` {ess-icon}::
| experimental[] Enables Transaction histogram metrics. Defaults to `false`. When `true`, additional configuration in APM Server is required. experimental[] Enables Transaction histogram metrics. Defaults to false. When true, additional configuration in APM Server is required. See {apm-server-ref-v}/transaction-metrics.html[Configure transaction metrics] for more information.
See {apm-server-ref-v}/transaction-metrics.html[Configure transaction metrics] for more information.
| `apm_oss.indexPattern` {ess-icon} `apm_oss.indexPattern` {ess-icon}::
| The index pattern used for integrations with Machine Learning and Query Bar. The index pattern used for integrations with Machine Learning and Query Bar.
It must match all apm indices. Defaults to `apm-*`. It must match all apm indices. Defaults to `apm-*`.
| `apm_oss.errorIndices` {ess-icon} `apm_oss.errorIndices` {ess-icon}::
| Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`. Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
| `apm_oss.onboardingIndices` `apm_oss.onboardingIndices`::
| Matcher for all onboarding indices. Defaults to `apm-*`. Matcher for all onboarding indices. Defaults to `apm-*`.
| `apm_oss.spanIndices` {ess-icon} `apm_oss.spanIndices` {ess-icon}::
| Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`. Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
| `apm_oss.transactionIndices` {ess-icon} `apm_oss.transactionIndices` {ess-icon}::
| Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`. Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
| `apm_oss.metricsIndices` `apm_oss.metricsIndices`::
| Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`. Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
| `apm_oss.sourcemapIndices` `apm_oss.sourcemapIndices`::
| Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`. Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.
|===
// end::general-apm-settings[] // end::general-apm-settings[]