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.

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

Jump to bottom

Add all APM configuration settings to the documentation #114139

Merged
merged 6 commits into from
Oct 11, 2021
Merged

Add all APM configuration settings to the documentation #114139

merged 6 commits into from
Oct 11, 2021

Conversation

gbamparop
Copy link
Contributor

@gbamparop gbamparop commented Oct 6, 2021 •
edited
Loading

Summary

Some APM configuration settings are not documented. This PR adds all the options to the docs.

apm_oss.* configuration settings are deprecated (#113364) and are renamed to xpack.apm.*.

Closes #113323.

@gbamparop gbamparop added auto-backport Deprecated - use backport:version if exact versions are needed Team:APM - DEPRECATED Use Team:obs-ux-infra_services. labels Oct 6, 2021
@elasticmachine
Copy link
Contributor

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

sorenlouv
sorenlouv reviewed Oct 6, 2021
View reviewed changes
docs/settings/apm-settings.asciidoc
| Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.

| `apm_oss.transactionIndices` {ess-icon}
| `xpack.apm.transactionIndices` {ess-icon}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fyi: the {ess-icon} means that the setting is available on cloud. If you add the setting to cloud's allow list you should also add the {ess-icon} badge here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ess-icons added

sorenlouv
sorenlouv approved these changes Oct 6, 2021
View reviewed changes
Copy link
Member

@sorenlouv sorenlouv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

sorenlouv
sorenlouv reviewed Oct 7, 2021
View reviewed changes
docs/settings/apm-settings.asciidoc Outdated
| `xpack.apm.agent.migrations.enabled`
| Set to `false` to disable cloud APM migrations. Defaults to `true`.

| `xpack.apm.indexPattern` {ess-icon}
Copy link
Member

@sorenlouv sorenlouv Oct 7, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is deprecated/unused and should be removed from the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for letting me know, I've removed this

@gbamparop gbamparop requested a review from a team as a code owner October 7, 2021 18:41
@gbamparop gbamparop requested a review from sorenlouv October 7, 2021 18:42
@gbamparop
Copy link
Contributor Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

merge conflict between base and head

@gbamparop gbamparop force-pushed the apm-settings-documentation branch from 8d0f4a0 to 6919e6b Compare October 7, 2021 18:52
@gbamparop @sorenlouv
Add link to the APM configuration settings docs
5562dbd 
Co-authored-by: Søren Louv-Jansen <sorenlouv@gmail.com>
@gbamparop
Copy link
Contributor Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@gbamparop gbamparop merged commit b2108f4 into elastic:master Oct 11, 2021
@gbamparop gbamparop deleted the apm-settings-documentation branch October 11, 2021 10:53
@kibanamachine
Copy link
Contributor

💔 Backport failed

The backport operation could not be completed due to the following error:
An unhandled error occurred: Command failed: git clone https://x-access-token:@github.com/elastic/kibana.git --progress
Cloning into 'kibana'...
fatal: unable to access 'https://github.com/elastic/kibana.git/': Failed to connect to github.com port 443: Connection timed out

The backport PRs will be merged automatically after passing CI.

To backport manually run:
node scripts/backport --pr 114139

@gbamparop gbamparop mentioned this pull request Oct 11, 2021
Merged
gbamparop added a commit to gbamparop/kibana that referenced this pull request Oct 11, 2021
@gbamparop @sorenlouv @kibanamachine
Add all APM configuration settings to the documentation (elastic#114139)
cbc92f9 
* 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>
gbamparop added a commit that referenced this pull request Oct 11, 2021
@gbamparop @sorenlouv @kibanamachine
Add all APM configuration settings to the documentation (#114139) (#1…
6047f03 
…14488)

* 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>
@bmorelli25 bmorelli25 mentioned this pull request Oct 13, 2021
Closed
@gbamparop gbamparop mentioned this pull request Jan 16, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sorenlouv sorenlouv sorenlouv approved these changes

Assignees
No one assigned
Labels
auto-backport Deprecated - use backport:version if exact versions are needed release_note:fix Team:APM - DEPRECATED Use Team:obs-ux-infra_services. v7.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[APM] Make sure to document all APM options
4 participants
@gbamparop @elasticmachine @kibanamachine @sorenlouv