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

Remove ManagerV2 unnecessary reload when apm tracing config is nil #41794

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Remove ManagerV2 unnecessary reload when apm tracing config is nil #41794

wants to merge 5 commits into from

Conversation

carsonip
Copy link
Member

@carsonip carsonip commented Nov 26, 2024 •
edited
Loading

Proposed commit message

Remove unnecessary reload due to apm tracing config change in ManagerV2 when apm tracing config changes from nil to nil.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Disruptive User Impact

Author's Checklist

  • [ ]

How to test this PR locally

Trigger input unit config change. With this PR, there should be no Reloading APM tracing logged when reloading.

Related issues

Use cases

Screenshots

Logs

@carsonip carsonip requested a review from a team as a code owner November 26, 2024 16:26
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Nov 26, 2024
@carsonip carsonip added the bug label Nov 26, 2024
@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 26, 2024

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @carsonip? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

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

@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 26, 2024

backport-8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

@carsonip carsonip added backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify labels Nov 26, 2024
@carsonip carsonip mentioned this pull request Nov 26, 2024
Closed
6 tasks
carsonip
carsonip commented Nov 26, 2024
View reviewed changes
CHANGELOG.next.asciidoc
@@ -112,6 +112,7 @@ https://github.com/elastic/beats/compare/v8.8.1\...main[Check the HEAD diff]
- Ensure Elasticsearch output can always recover from network errors {pull}40794[40794]
- Add `translate_ldap_attribute` processor. {pull}41472[41472]
- Remove unnecessary debug logs during idle connection teardown {issue}40824[40824]
- Remove unnecessary reload for Elastic Agent managed beats when apm tracing config changes from nil to nil {pull}41794[41794]
Copy link
Member Author

Choose a reason for hiding this comment

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

[To reviewer] Is this an accurate description? Is this the right place to put the changelog if it is backported to 8.16 and 8.17?

@pierrehilbert pierrehilbert added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Nov 26, 2024
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Nov 26, 2024
@carsonip carsonip changed the title Remove unneccessary apm tracing reload Remove ManagerV2 unnecessary reload when apm tracing config is nil Nov 28, 2024
carsonip
carsonip commented Nov 28, 2024
View reviewed changes
x-pack/libbeat/management/managerV2.go
@@ -893,6 +893,13 @@ func (cm *BeatV2Manager) reloadAPM(unit *agentUnit) {
apmConfig = expected.APMConfig
}
}

if (cm.lastAPMCfg == nil && apmConfig == nil) || (cm.lastAPMCfg != nil && gproto.Equal(cm.lastAPMCfg, apmConfig)) {
Copy link
Member Author

Choose a reason for hiding this comment

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

[To reviewer] With this change, apm.Reload(nil) is never called if apmConfig is always nil, even when starting the beat. I assume that is fine.

Copy link
Member

Choose a reason for hiding this comment

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

Skipping the apm.Reload(nil) would potentially skip setting the initial configuration to an empty one to disable tracing. The implementation of this is on the APM server side. https://github.com/elastic/apm-server/blob/840fe6c8cb328bbb07ce49c21d6a3068be64d9e4/internal/beatcmd/reloader.go#L213-L227

This depends on what the default state is, or if it would ever change. If the default state is that APM tracing is disabled the initial apm.Reload(nil) has no effect. If it isn't disabled then skipping it has a consequence.

@pierrehilbert pierrehilbert requested review from blakerouse and faec and removed request for khushijain21 November 29, 2024 14:21
cmacknz
cmacknz approved these changes Nov 29, 2024
View reviewed changes
Copy link
Member

@cmacknz cmacknz left a comment

Choose a reason for hiding this comment

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

LGTM under the assumption that skipping an initial nil reload of the APM configuration is fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cmacknz cmacknz cmacknz approved these changes

@leehinman leehinman Awaiting requested review from leehinman leehinman is a code owner automatically assigned from elastic/elastic-agent-data-plane

@blakerouse blakerouse Awaiting requested review from blakerouse

@faec faec Awaiting requested review from faec

Assignees

@carsonip carsonip

Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify bug Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Unnecessary extra reload on integration policy change under EA managed mode
4 participants
@carsonip @elasticmachine @cmacknz @pierrehilbert