Skip to content
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.

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

[APM] Make sure to document all APM options #113323

Closed
sorenlouv opened this issue Sep 28, 2021 · 2 comments · Fixed by #114139
Closed

[APM] Make sure to document all APM options #113323

sorenlouv opened this issue Sep 28, 2021 · 2 comments · Fixed by #114139
Assignees
Labels
Team:APM All issues that need APM UI Team support

Comments

@sorenlouv
Copy link
Member

sorenlouv commented Sep 28, 2021

Unless otherwise stated, every config option in APM should be publicly documented. The options can be found here:

const mergedConfig = {
/* eslint-disable @typescript-eslint/naming-convention */
// TODO: Remove all apm_oss options by 8.0
'apm_oss.transactionIndices': apmOssConfig.transactionIndices,
'apm_oss.spanIndices': apmOssConfig.spanIndices,
'apm_oss.errorIndices': apmOssConfig.errorIndices,
'apm_oss.metricsIndices': apmOssConfig.metricsIndices,
'apm_oss.sourcemapIndices': apmOssConfig.sourcemapIndices,
'apm_oss.onboardingIndices': apmOssConfig.onboardingIndices,
/* eslint-enable @typescript-eslint/naming-convention */
'xpack.apm.serviceMapEnabled': apmConfig.serviceMapEnabled,
'xpack.apm.serviceMapFingerprintBucketSize':
apmConfig.serviceMapFingerprintBucketSize,
'xpack.apm.serviceMapTraceIdBucketSize':
apmConfig.serviceMapTraceIdBucketSize,
'xpack.apm.serviceMapFingerprintGlobalBucketSize':
apmConfig.serviceMapFingerprintGlobalBucketSize,
'xpack.apm.serviceMapTraceIdGlobalBucketSize':
apmConfig.serviceMapTraceIdGlobalBucketSize,
'xpack.apm.serviceMapMaxTracesPerRequest':
apmConfig.serviceMapMaxTracesPerRequest,
'xpack.apm.ui.enabled': apmConfig.ui.enabled,
'xpack.apm.maxServiceEnvironments': apmConfig.maxServiceEnvironments,
'xpack.apm.maxServiceSelection': apmConfig.maxServiceSelection,
'xpack.apm.ui.maxTraceItems': apmConfig.ui.maxTraceItems,
'xpack.apm.ui.transactionGroupBucketSize':
apmConfig.ui.transactionGroupBucketSize,
'xpack.apm.autocreateApmIndexPattern': apmConfig.autocreateApmIndexPattern,
'xpack.apm.telemetryCollectionEnabled':
apmConfig.telemetryCollectionEnabled,
'xpack.apm.searchAggregatedTransactions':
apmConfig.searchAggregatedTransactions,
'xpack.apm.metricsInterval': apmConfig.metricsInterval,
'xpack.apm.agent.migrations.enabled': apmConfig.agent.migrations.enabled,
};

And documentation is located here:
https://github.com/elastic/kibana/blob/4fe8605c7b50e4a94e99fc63f64f05870ad449eb/docs/settings/apm-settings.asciidoc

Add to Cloud allow list
Additionally, every option should be allowed on cloud unless there are specific reasons not to. Cloud allow list can be found here:

https://github.com/elastic/cloud/blob/242a0485fdd07149797bfc9a3c86a2726f710be7/scala-services/adminconsole/src/main/resources/settings/kibana/apm.yml

@sorenlouv sorenlouv added [zube]: 7.16 Team:APM All issues that need APM UI Team support labels Sep 28, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:apm)

@gbamparop
Copy link
Contributor

Created a separate issue for the cloud allow list #114130

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:APM All issues that need APM UI Team support
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants