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

docs: Remove txmetrics config #10140

Merged
merged 3 commits into from
Feb 7, 2023
Merged

docs: Remove txmetrics config #10140

merged 3 commits into from
Feb 7, 2023

Conversation

carsonip
Copy link
Member

Removing transaction metrics config as they are not officially supported.

@carsonip
docs: Remove txmetrics config
93158d0 
Removing transaction metrics config as they are not officially
supported.
@carsonip carsonip requested a review from simitt January 30, 2023 12:26
@carsonip carsonip marked this pull request as ready for review January 30, 2023 12:26
@mergify
Copy link
Contributor

mergify bot commented Jan 30, 2023

This pull request does not have a backport label. Could you fix it @carsonip? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-7.x is the label to automatically backport to the 7.x branch.
  • backport-7./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jan 30, 2023
@apmmachine
Copy link
Contributor

apmmachine commented Jan 30, 2023 •
edited
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-02-07T14:21:59.850+0000

  • Duration: 3 min 19 sec

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate and publish the docker images.

  • /test windows : Build & tests on Windows.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

kruskall
kruskall requested changes Jan 30, 2023
View reviewed changes
Copy link
Member

@kruskall kruskall left a comment

Choose a reason for hiding this comment

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

cc @bmorelli25 for visibility since he was the owner of the original PR

docs/legacy/configuring.asciidoc
@@ -73,8 +72,6 @@ include::{libbeat-dir}/shared-ssl-config.asciidoc[]
include::ssl-input-settings.asciidoc[]
// END SSL SECTION --------------------------------------------

include::./transaction-metrics.asciidoc[]
Copy link
Member

Choose a reason for hiding this comment

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

issue: this might require coordinating with the kibana team to remove the companion page on their documentation (should be a config option): elastic/kibana#82379

Copy link
Member

Choose a reason for hiding this comment

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

Yup. This will need to be removed and backported from the Kibana docs before docs ci will pass on this PR (as that content links to this content). I'll open a PR in the Kibana repo take care of that.

Copy link
Member

Choose a reason for hiding this comment

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

Opened elastic/kibana#149896

Copy link
Member

Choose a reason for hiding this comment

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

Merged and backported in the Kibana repo. Rerunning docs ci now...

docs/legacy/configuring.asciidoc Show resolved Hide resolved
@bmorelli25 bmorelli25 added backport-7.17 Automated backport with mergify to the 7.17 branch backport-8.6 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Jan 30, 2023
@bmorelli25 bmorelli25 mentioned this pull request Jan 30, 2023
Merged
bmorelli25 added a commit to elastic/kibana that referenced this pull request Jan 30, 2023
@bmorelli25
docs: remove xpack.apm.searchAggregatedTransactions (#149896)
b90ddba 
### Summary

This PR reverts #82379 and removes
`xpack.apm.searchAggregatedTransactions` from the documentation. This is
for elastic/apm-server#10140:

> Removing transaction metrics config as they are not officially
supported.
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jan 30, 2023
@bmorelli25
docs: remove xpack.apm.searchAggregatedTransactions (elastic#149896)
c4c35cd 
### Summary

This PR reverts elastic#82379 and removes
`xpack.apm.searchAggregatedTransactions` from the documentation. This is
for elastic/apm-server#10140:

> Removing transaction metrics config as they are not officially
supported.

(cherry picked from commit b90ddba)
@bmorelli25
Copy link
Member

@elasticmachine, run elasticsearch-ci/docs

bmorelli25 added a commit to bmorelli25/kibana that referenced this pull request Jan 30, 2023
@bmorelli25
docs: remove xpack.apm.searchAggregatedTransactions (elastic#149896)
9eca188 
### Summary

This PR reverts elastic#82379 and removes
`xpack.apm.searchAggregatedTransactions` from the documentation. This is
for elastic/apm-server#10140:

> Removing transaction metrics config as they are not officially
supported.

(cherry picked from commit b90ddba)

# Conflicts:
#	docs/settings/apm-settings.asciidoc
kibanamachine added a commit to elastic/kibana that referenced this pull request Jan 30, 2023
@kibanamachine @bmorelli25
[8.6] docs: remove xpack.apm.searchAggregatedTransactions (#149896) (…
1091305 
…#149901)

# Backport

This will backport the following commits from `main` to `8.6`:
- [docs: remove `xpack.apm.searchAggregatedTransactions`
(#149896)](#149896)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Brandon
Morelli","email":"brandon.morelli@elastic.co"},"sourceCommit":{"committedDate":"2023-01-30T22:33:03Z","message":"docs:
remove `xpack.apm.searchAggregatedTransactions` (#149896)\n\n###
Summary\r\n\r\nThis PR reverts
#82379 and
removes\r\n`xpack.apm.searchAggregatedTransactions` from the
documentation. This is\r\nfor
elastic/apm-server#10140> Removing
transaction metrics config as they are not
officially\r\nsupported.","sha":"b90ddba88244fdf81593737cbdb5211664090a0c","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:APM","release_note:skip","v8.7.0","v7.17.9","v8.6.2"],"number":149896,"url":"#149896:
remove `xpack.apm.searchAggregatedTransactions` (#149896)\n\n###
Summary\r\n\r\nThis PR reverts
#82379 and
removes\r\n`xpack.apm.searchAggregatedTransactions` from the
documentation. This is\r\nfor
elastic/apm-server#10140> Removing
transaction metrics config as they are not
officially\r\nsupported.","sha":"b90ddba88244fdf81593737cbdb5211664090a0c"}},"sourceBranch":"main","suggestedTargetBranches":["7.17","8.6"],"targetPullRequestStates":[{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"#149896:
remove `xpack.apm.searchAggregatedTransactions` (#149896)\n\n###
Summary\r\n\r\nThis PR reverts
#82379 and
removes\r\n`xpack.apm.searchAggregatedTransactions` from the
documentation. This is\r\nfor
elastic/apm-server#10140> Removing
transaction metrics config as they are not
officially\r\nsupported.","sha":"b90ddba88244fdf81593737cbdb5211664090a0c"}},{"branch":"7.17","label":"v7.17.9","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.6","label":"v8.6.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
bmorelli25 added a commit to elastic/kibana that referenced this pull request Jan 30, 2023
@bmorelli25
[7.17] docs: remove xpack.apm.searchAggregatedTransactions (#149896) (
57f1806 
#149902)

# Backport

This will backport the following commits from `main` to `7.17`:
- [docs: remove `xpack.apm.searchAggregatedTransactions`
(#149896)](#149896)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Brandon
Morelli","email":"brandon.morelli@elastic.co"},"sourceCommit":{"committedDate":"2023-01-30T22:33:03Z","message":"docs:
remove `xpack.apm.searchAggregatedTransactions` (#149896)\n\n###
Summary\r\n\r\nThis PR reverts
#82379 and
removes\r\n`xpack.apm.searchAggregatedTransactions` from the
documentation. This is\r\nfor
elastic/apm-server#10140> Removing
transaction metrics config as they are not
officially\r\nsupported.","sha":"b90ddba88244fdf81593737cbdb5211664090a0c","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:APM","release_note:skip","v8.7.0","v7.17.9","v8.6.2"],"number":149896,"url":"#149896:
remove `xpack.apm.searchAggregatedTransactions` (#149896)\n\n###
Summary\r\n\r\nThis PR reverts
#82379 and
removes\r\n`xpack.apm.searchAggregatedTransactions` from the
documentation. This is\r\nfor
elastic/apm-server#10140> Removing
transaction metrics config as they are not
officially\r\nsupported.","sha":"b90ddba88244fdf81593737cbdb5211664090a0c"}},"sourceBranch":"main","suggestedTargetBranches":["7.17"],"targetPullRequestStates":[{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"#149896:
remove `xpack.apm.searchAggregatedTransactions` (#149896)\n\n###
Summary\r\n\r\nThis PR reverts
#82379 and
removes\r\n`xpack.apm.searchAggregatedTransactions` from the
documentation. This is\r\nfor
elastic/apm-server#10140> Removing
transaction metrics config as they are not
officially\r\nsupported.","sha":"b90ddba88244fdf81593737cbdb5211664090a0c"}},{"branch":"7.17","label":"v7.17.9","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.6","label":"v8.6.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"#149901"}]}]
BACKPORT-->
@carsonip
Copy link
Member Author

carsonip commented Jan 31, 2023 •
edited
Loading

@bmorelli25 sorry for the unclear comms. The intention of this PR is to stop documenting these apm-server transaction aggregation configs because they are not officially supported. e.g. interval option has been removed, and a poor hdrhistogram_significant_figures value may cause the system to run out of memory.

I thought the change in kibana docs will be to only remove the pointer but not the paragraph. I'm not sure if we need to remove the paragraph as it is not exactly about apm-server but more about the UI, and they may still be valid and officially supported.

cc @simitt

@bmorelli25
Copy link
Member

Oops, I might've jumped the gun. Sorry about that. I can re-add the setting to the Kibana docs. What should we say about always?

`xpack.apm.searchAggregatedTransactions` {ess-icon}::
Enables Transaction histogram metrics. Defaults to `auto` so 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. When set to `never` and aggregated transactions are not used.

@carsonip
Copy link
Member Author

Oops, I might've jumped the gun. Sorry about that. I can re-add the setting to the Kibana docs. What should we say about always?

TBH I'm not very sure. Transaction aggregations should be always enabled in apm-server. I assume nothing extra is needed for transaction aggregation to run properly. @kruskall what do you think?

@carsonip
Copy link
Member Author

carsonip commented Feb 2, 2023

@simitt Do you know what "additional configuration" it is trying to imply in the kibana docs?

@simitt
Copy link
Contributor

simitt commented Feb 2, 2023

@bmorelli25, I discussed with @sqren that removing the paragraph from Kibana UI is fine, and even overdue.
@carsonip we had exposed the time interval, significant numbers etc in the config, the line refered to these options.

@carsonip
Copy link
Member Author

carsonip commented Feb 2, 2023

@bmorelli25 let me know if this PR is ready to merge or simply takeover from here. Thanks!

@sorenlouv
Copy link
Member

sorenlouv commented Feb 2, 2023 •
edited
Loading

I thought the change in kibana docs will be to only remove the pointer but not the paragraph. I'm not sure if we need to remove the paragraph as it is not exactly about apm-server but more about the UI, and they may still be valid and officially supported.

I'm in favour of removing the setting on the UI side as well. In the past we allowed the user to disable transaction metrics but I don't see any good reason for doing that anymore. When the setting is removed it'll keep the same default behaviour (auto) meaning the UI will attempt to use metrics first, and only fallback to transaction events if they are not available.

I've created elastic/kibana#150164 to remove the setting from Kibana.

@sorenlouv sorenlouv mentioned this pull request Feb 2, 2023
Open
kqualters-elastic pushed a commit to kqualters-elastic/kibana that referenced this pull request Feb 6, 2023
@bmorelli25 @kqualters-elastic
docs: remove xpack.apm.searchAggregatedTransactions (elastic#149896)
f063d35 
### Summary

This PR reverts elastic#82379 and removes
`xpack.apm.searchAggregatedTransactions` from the documentation. This is
for elastic/apm-server#10140:

> Removing transaction metrics config as they are not officially
supported.
darnautov pushed a commit to darnautov/kibana that referenced this pull request Feb 7, 2023
@bmorelli25 @darnautov
docs: remove xpack.apm.searchAggregatedTransactions (elastic#149896)
fa7401b 
### Summary

This PR reverts elastic#82379 and removes
`xpack.apm.searchAggregatedTransactions` from the documentation. This is
for elastic/apm-server#10140:

> Removing transaction metrics config as they are not officially
supported.
@carsonip carsonip merged commit 54698bd into elastic:main Feb 7, 2023
@mergify mergify bot mentioned this pull request Feb 7, 2023
Merged
mergify bot pushed a commit that referenced this pull request Feb 7, 2023
@carsonip @mergify
docs: Remove txmetrics config (#10140)
80fb669 
Removing transaction metrics config as they are not officially
supported.

(cherry picked from commit 54698bd)

# Conflicts:
#	docs/legacy/transaction-metrics.asciidoc
@mergify mergify bot mentioned this pull request Feb 7, 2023
Merged
mergify bot pushed a commit that referenced this pull request Feb 7, 2023
@carsonip @mergify
docs: Remove txmetrics config (#10140)
7eb5663 
Removing transaction metrics config as they are not officially
supported.

(cherry picked from commit 54698bd)
carsonip added a commit that referenced this pull request Feb 7, 2023
@carsonip
docs: Remove txmetrics config (#10140)
9a324e0 
Removing transaction metrics config as they are not officially
supported.
axw pushed a commit that referenced this pull request Feb 8, 2023
@mergify @carsonip
docs: Remove txmetrics config (#10140) (#10189)
e28e25b 
Removing transaction metrics config as they are not officially
supported.

(cherry picked from commit 54698bd)

Co-authored-by: Carson Ip <carsonip@users.noreply.github.com>
axw pushed a commit that referenced this pull request Feb 8, 2023
@mergify @carsonip
[7.17] docs: Remove txmetrics config (backport #10140) (#10188)
f4d3e4f 
* docs: Remove txmetrics config (#10140)

Removing transaction metrics config as they are not officially
supported.

(cherry picked from commit 54698bd)

# Conflicts:
#	docs/legacy/transaction-metrics.asciidoc

* docs: Remove txmetrics config (#10140)

Removing transaction metrics config as they are not officially
supported.

---------

Co-authored-by: Carson Ip <carsonip@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kruskall kruskall kruskall requested changes

@simitt simitt simitt approved these changes

@bmorelli25 bmorelli25 bmorelli25 approved these changes

Assignees
No one assigned
Labels
backport-7.17 Automated backport with mergify to the 7.17 branch backport-8.6 Automated backport with mergify
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@carsonip @apmmachine @bmorelli25 @simitt @sorenlouv @kruskall