github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add all APM configuration settings to the documentation (#114139) (#114488)

Browse source 
* Add APM configuration settings to the documentation

* Rename  the deprecated apm_oss.* configurations to xpack.apm.*

* Remove new lines

* Add ess icon to config settings

* Add link to the APM configuration settings docs

Co-authored-by: Søren Louv-Jansen <sorenlouv@gmail.com>

Co-authored-by: Søren Louv-Jansen <sorenlouv@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Søren Louv-Jansen <sorenlouv@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Giorgos Bamparopoulos 2021-10-11 16:42:04 +01:00 • committed by GitHub
parent db7794f536
commit 6047f03138
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -45,57 +45,71 @@ Changing these settings may disable features of the APM App.
[cols="2*<"]
|===
| `xpack.apm.enabled`
| `xpack.apm.enabled` {ess-icon}
| deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
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`.
| `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`.
| `xpack.apm.serviceMapFingerprintGlobalBucketSize`
| `xpack.apm.serviceMapFingerprintGlobalBucketSize` {ess-icon}
| Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.
| `xpack.apm.serviceMapEnabled` {ess-icon}
| Set to `false` to disable service maps. Defaults to `true`.
| `xpack.apm.serviceMapTraceIdBucketSize` {ess-icon}
| Maximum number of trace IDs sampled for generating service map focused on a specific service. Defaults to `65`.
| `xpack.apm.serviceMapTraceIdGlobalBucketSize` {ess-icon}
| Maximum number of trace IDs sampled for generating the global service map. Defaults to `6`.
| `xpack.apm.serviceMapMaxTracesPerRequest` {ess-icon}
| Maximum number of traces per request for generating the global service map. Defaults to `50`.
| `xpack.apm.ui.enabled` {ess-icon}
| 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`.
| `xpack.apm.ui.maxTraceItems` {ess-icon}
| 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`.
| `xpack.apm.searchAggregatedTransactions`
| `xpack.apm.searchAggregatedTransactions` {ess-icon}
| experimental[] Enables Transaction histogram metrics. Defaults to `never` and aggregated transactions are not used. When set to `auto`, the UI will use metric indices over transaction indices for transactions if aggregated transactions are found. When set to `always`, additional configuration in APM Server is required.
See {apm-server-ref-v}/transaction-metrics.html[Configure transaction metrics] for more information.
| `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-*`.
| `xpack.apm.metricsInterval` {ess-icon}
| Sets a `fixed_interval` for date histograms in metrics aggregations. Defaults to `30`.
| `apm_oss.errorIndices` {ess-icon}
| `xpack.apm.agent.migrations.enabled` {ess-icon}
| Set to `false` to disable cloud APM migrations. Defaults to `true`.
| `xpack.apm.errorIndices` {ess-icon}
| Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
| `apm_oss.onboardingIndices`
| `xpack.apm.onboardingIndices` {ess-icon}
| Matcher for all onboarding indices. Defaults to `apm-*`.
| `apm_oss.spanIndices` {ess-icon}
| `xpack.apm.spanIndices` {ess-icon}
| Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
| `apm_oss.transactionIndices` {ess-icon}
| `xpack.apm.transactionIndices` {ess-icon}
| Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
| `apm_oss.metricsIndices`
| `xpack.apm.metricsIndices` {ess-icon}
| Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
| `apm_oss.sourcemapIndices`
| `xpack.apm.sourcemapIndices` {ess-icon}
| Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.
|===
// end::general-apm-settings[]
// end::general-apm-settings[]

2
x-pack/plugins/apm/server/index.ts
View file

@ -74,6 +74,8 @@ export type APMXPackConfig = TypeOf<typeof configSchema>;
export type APMConfig = ReturnType<typeof mergeConfigs>;
// plugin config and ui indices settings
// All options should be documented in the APM configuration settings: https://github.com/elastic/kibana/blob/master/docs/settings/apm-settings.asciidoc
// and be included on cloud allow list unless there are specific reasons not to
export function mergeConfigs(
apmOssConfig: APMOSSConfig,
apmConfig: APMXPackConfig