-
Notifications
You must be signed in to change notification settings - Fork 73
[management] Network traffic events docs #291
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
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
f85cac1
Rename Network Activity Logging to Audit Activity Logging
bcmmbaga 1e1a7cb
refactor the audit events doc
bcmmbaga fc630b0
add management traffic event doc
bcmmbaga 311a363
Update audit events logging image
bcmmbaga 47abe1c
Update event streaming image
bcmmbaga 63d0d08
Update src/pages/how-to/traffic-events-logging.mdx
bcmmbaga fe9be13
Update src/pages/how-to/traffic-events-logging.mdx
bcmmbaga 4ca539e
Update src/pages/how-to/traffic-events-logging.mdx
bcmmbaga 19605a7
Update docs to clarify feature availability
bcmmbaga f0dfc47
add link
mlsmaycon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file modified
BIN
+14.1 KB
(100%)
...atic/img/how-to-guides/activity-event-streaming/event-streaming-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+359 KB
(350%)
public/docs-static/img/how-to-guides/activity-monitoring.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added
BIN
+428 KB
public/docs-static/img/how-to-guides/traffic-events-logging-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Traffic Events Logging | ||
|
||
<Note> | ||
This feature is available only in the NetBird cloud and on the [Business plan](https://www.netbird.io/pricing?utm_source=docs&utm_content=traffic-events). | ||
It is an experimental feature, and its functionality and behavior may evolve, including changes to how data is collected | ||
or reported. | ||
To use this feature, ensure you have NetBird client version 0.39 or higher. | ||
</Note> | ||
|
||
|
||
The traffic events logging functionality enables comprehensive monitoring and analysis of connections across your infrastructure. | ||
It captures network activity, including peer-to-peer, site-to-site, peer-to-resource, and other network traffic events. | ||
|
||
It provides detailed visibility into connections and network traffic flow, helping to answer key questions such as who initiated | ||
the connection, what resource was accessed, when it happened, where it originated, and why it was allowed. By enhancing | ||
network monitoring capabilities, it strengthens security measures and delivers actionable operational insights, empowering | ||
you to better manage and secure your environment. | ||
|
||
|
||
## Enabling Traffic Events Logging | ||
|
||
Traffic events logging is disabled by default. To enable it on the NetBird dashboard, navigate to `Settings > Networks`. | ||
Under the Experimental section, you’ll find the `Enable Traffic Events` option. Toggle the switch to enable traffic event logging. | ||
|
||
By default, traffic reporting in userspace is always enabled, providing basic logging of network interactions. | ||
However, packet size reporting at the kernel level is disabled by default to minimize CPU usage. | ||
|
||
<Note> | ||
You can optionally enable `Traffic Reporting (Kernel)` to capture additional details, such as network packet sizes, | ||
at the kernel level. Be aware that enabling this option may lead to higher CPU usage on the NetBird client. | ||
</Note> | ||
|
||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/traffic-events-logging-settings.png" alt="traffic-events-logging-settings" className="imagewrapper-big"/> | ||
</p> | ||
|
||
|
||
## Enable Traffic Events Streaming to SIEM Systems | ||
|
||
NetBird allows you to stream traffic events directly to your Security Information and Event Management (SIEM) system in real time. | ||
By enabling this feature, you can seamlessly monitor and analyze NetBird network flow events within your existing SIEM infrastructure, | ||
enhancing your ability to detect and respond to security events. | ||
|
||
For detailed instructions on supported integrations and how to set them up, refer to the [integrations guide](/how-to/activity-event-streaming). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.