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

packetbeat/beater: make Npcap installation lazy #35935

Merged
merged 4 commits into from
Aug 1, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Jun 27, 2023

What does this PR do?

Defer installation until we have a valid config with streams configured so that we can determine whether the user has blocked install and whether we need the DLL.

Why is it important?

In the fleet-managed case New is called without a complete config, which means that we have no stream to tell us not to install the Npcap DLL.

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 — tested manually in a production environment with the changes in V8 8 1 test #35918 (essentially the same as here but with a single extra logging commit omitted in this change)
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@efd6 efd6 self-assigned this Jun 27, 2023
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Jun 27, 2023
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jun 27, 2023

💚 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-08-01T07:08:54.440+0000

  • Duration: 46 min 30 sec

Test stats 🧪

Test Results
Failed 0
Passed 2357
Skipped 25
Total 2382

💚 Flaky test report

Tests succeeded.

🤖 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 the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

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

@efd6 efd6 marked this pull request as ready for review June 28, 2023 00:12
@efd6 efd6 requested a review from a team as a code owner June 28, 2023 00:12
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

Copy link
Contributor

@bhapas bhapas left a comment

Choose a reason for hiding this comment

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

Minor comment. LGTM.

Not well versed in the packetbeat area , so would want another review from a more experienced team member.

@@ -213,7 +213,7 @@ func TestCanInstallNpcap(t *testing.T) {
BeatConfig: cfg,
Manager: boolManager{managed: test.managed},
}
got, err := canInstallNpcap(b)
got, err := canInstallNpcap(b, b.BeatConfig)
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor thought : Can we pass cfg instead? Just to avoid the minor confusion that https://github.com/elastic/beats/pull/35935/files#diff-69402794a921b13ab8019aa16a00528596ce02e9ab1b40d7d266c44cc0bed664L122 has changed b.BeatConfig to rawCfg

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, OK. It shouldn't be any more confusing than it already is.

@mergify

This comment was marked as outdated.

efd6 added 2 commits July 31, 2023 07:32
In the fleet-managed case New is called without a complete config, which means
that we have no stream to tell us not to install the Npcap DLL.

Defer installation until we have a valid config with streams configured so that
we can determine whether the user has blocked install and whether we need the DLL.
@efd6 efd6 force-pushed the agent-npcap-non-install branch 3 times, most recently from 1987a00 to 3c117c0 Compare July 31, 2023 21:54
Copy link
Contributor

@kcreddy kcreddy left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏼
Following tests were run:

  • npcap isn't getting installed if never_install: true in Network Packet Integration.
    • Packetbeat throws error when there is no pre-existing npcap dll, and honors the existing npcap version if it was already installed on the host.
  • npcap is correctly getting installed from the provided bundle if never_install: false and the host doesn't contain prior npcap installation.

@efd6 efd6 merged commit 0a655a1 into elastic:main Aug 1, 2023
8 checks passed
mergify bot pushed a commit that referenced this pull request Aug 1, 2023
Defer installation until we have a valid config with streams configured
so that we can determine whether the user has blocked install and
whether we need the DLL.

In the fleet-managed case New is called without a complete config, which
means that we have no stream to tell us not to install the Npcap DLL.

(cherry picked from commit 0a655a1)
efd6 added a commit that referenced this pull request Aug 1, 2023
#36190)

Defer installation until we have a valid config with streams configured
so that we can determine whether the user has blocked install and
whether we need the DLL.

In the fleet-managed case New is called without a complete config, which
means that we have no stream to tell us not to install the Npcap DLL.

(cherry picked from commit 0a655a1)

Co-authored-by: Dan Kortschak <[email protected]>
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
Defer installation until we have a valid config with streams configured
so that we can determine whether the user has blocked install and
whether we need the DLL.

In the fleet-managed case New is called without a complete config, which
means that we have no stream to tell us not to install the Npcap DLL.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants