Skip to content

network_traffic: add docs for configuration options#3371

Merged
efd6 merged 2 commits intoelastic:mainfrom
efd6:network_traffic_docs
May 24, 2022
Merged

network_traffic: add docs for configuration options#3371
efd6 merged 2 commits intoelastic:mainfrom
efd6:network_traffic_docs

Conversation

@efd6
Copy link
Contributor

@efd6 efd6 commented May 18, 2022

What does this PR do?

This adds configuration documentation for the network_traffic integration.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

  • There is also a change in the flows manifest and hbs template removing the processes config options. This should have been done in network_traffic: expose configuration options to users #3157 but was missed. Formally this makes the change here a breaking change, though note that it could not have worked previously because the full set of monitored config options was not sent to packetbeat. Advice on how to proceed appreciated.

How to test this PR locally

Related issues

Screenshots

@efd6 efd6 self-assigned this May 18, 2022
@efd6 efd6 requested a review from andrewkroh May 18, 2022 01:53
@efd6 efd6 marked this pull request as ready for review May 18, 2022 01:55
@efd6 efd6 requested a review from a team as a code owner May 18, 2022 01:55
@elasticmachine
Copy link

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

@elasticmachine
Copy link

elasticmachine commented May 18, 2022

💚 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: 2022-05-23T14:19:44.324+0000

  • Duration: 71 min 43 sec

Test stats 🧪

Test Results
Failed 0
Passed 264
Skipped 0
Total 264

🤖 GitHub comments

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

  • /test : Re-trigger the build.

Comment on lines 24 to 26
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The documentation on interface is intentionally weak here (see query here).

@elasticmachine
Copy link

elasticmachine commented May 18, 2022

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (0/0) 💚
Files 100.0% (0/0) 💚 3.704
Classes 100.0% (0/0) 💚 3.704
Methods 71.875% (46/64) 👎 -16.245
Lines 100.0% (0/0) 💚 10.371
Conditionals 100.0% (0/0) 💚

@efd6 efd6 force-pushed the network_traffic_docs branch from 88efaea to 0d1a6d1 Compare May 23, 2022 14:19
@efd6 efd6 merged commit ce490b5 into elastic:main May 24, 2022
@efd6 efd6 deleted the network_traffic_docs branch February 5, 2025 22:13
@andrewkroh andrewkroh added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:network_traffic Network Packet Capture

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants