Skip to content

Commit 89ed145

Browse files
committed
Improve traffic events logs
1 parent 755df08 commit 89ed145

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

src/pages/how-to/traffic-events-logging.mdx

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ NetBird would log the blocked event on the peer that refused the connection.
3535
<img src="/docs-static/img/how-to-guides/traffic-events/p2p-traffic-events.png" alt="traffic-events-p2p-diagram" className="imagewrapper-big"/>
3636
</p>
3737

38-
#### Successful P2P Connection Events Correlation
38+
#### Successful P2P Connection Events
3939

4040
NetBird helps you better understand connection flows by correlating related events and presenting them in a clear, organized manner.
4141

@@ -53,7 +53,11 @@ On the other side, the destination peer `server` receives the connection request
5353
following the disconnection from `Alice`. Since `server` allows the connection, the log includes the policy `IT Admins to Servers`
5454
that authorized the connection over the `ICMP` protocol.
5555

56-
#### Blocked P2P Connections Events Correlation
56+
<Note>
57+
Use the `P2P` filter in the table to view only peer-to-peer connection events.
58+
</Note>
59+
60+
#### Blocked P2P Connections Events
5761

5862
If a connection is refused, NetBird logs the blocked event on the peer that denies the connection, in this case, `server`.
5963
The initiating peer `Alice` will still report the connection attempt but won't be aware that it was blocked.
@@ -67,7 +71,7 @@ meaning all `HTTP` requests are intentionally not allowed. The screenshot below
6771
### Peer-to-Network Resource Connections
6872

6973
When a peer connects to a [network resource](/how-to/networks#resources), NetBird captures and logs the traffic
70-
events for that connection on the peer that initiated the connection, and on the routing peer that connects the peer to
74+
events for that connection on the peer that initiated the connection, and on the [routing peer](/how-to/networks#routing-peers) that connects the peer to
7175
the internal network resource.
7276

7377
A slightly modified example of the CRM server connection scenario would be if instead of running the NetBird client on the CRM server,
@@ -79,28 +83,38 @@ routed the connection to the CRM server. If the connection was blocked, NetBird
7983
<img src="/docs-static/img/how-to-guides/traffic-events/routed-traffic-events.png" alt="traffic-events-routed-diagram" className="imagewrapper-big"/>
8084
</p>
8185

82-
#### Successful Peer-to-Network Resource Events Correlation
86+
#### Successful Peer-to-Network Resource Events
8387

8488
The screenshot below illustrates a successful connection from `Alice` to the network resource `CRM` running in the AWS VPC.
8589
The traffic is routed through a routing peer, which logs the connection event and reports it to the NetBird servers.
8690
The access is permitted by the policy `IT Admins to AWS Servers`, which allows connections over the `TCP` protocol on port `5432`.
8791
Note the `ROUTER` column in the table, which identifies the routing peer responsible for routing to the internal network resource.
88-
You can filter such events by using the `Routed` filter in the table.
8992

9093
<p>
9194
<img src="/docs-static/img/how-to-guides/traffic-events/network-resource-succesful-connection.png" alt="network-resource-succesful-connection" className="imagewrapper-big"/>
9295
</p>
9396

94-
#### Blocked Peer-to-Network Resource Events Correlation
97+
<Note>
98+
Use the `Routed` filter in the table to view only peer-to-network resource connection events.
99+
</Note>
100+
101+
#### Blocked Peer-to-Network Resource Events
95102

96103
In the event of a blocked connection, the initiating peer logs the connection attempt, while the routing peer records the blocked event.
97104
The screenshot below demonstrates this behavior: the routing peer blocks a connection to the network resource `CRM` because
98105
the policy `IT Admins to AWS Servers` does not permit connections over the `HTTP` protocol on port `6432`.
106+
You can see multiple blocked events from the routing peer, which indicates that the initiating peer `Alice` attempted to connect multiple times
107+
in one TCP session, but the routing peer blocked all attempts.
99108

100109
<p>
101110
<img src="/docs-static/img/how-to-guides/traffic-events/network-resource-blocked-connection.png" alt="network-resource-succesful-connection" className="imagewrapper-big"/>
102111
</p>
103112

113+
<Note>
114+
For all the examples above, we used the `nc` command to initiate the connection to the CRM server from the peer `Alice`.
115+
E.g., `nc -v crm.netbird.cloud 5432`.
116+
</Note>
117+
104118
## Enabling Traffic Events Logging
105119

106120
Traffic events logging feature is disabled by default. To enable it on the NetBird dashboard, navigate to `Settings > Networks`.
@@ -121,12 +135,12 @@ at the kernel level. Be aware that enabling this option may lead to higher CPU u
121135

122136
## Log Retention
123137

124-
While in experimental mode, logs are retained for **7 days**.
138+
While in experimental mode, logs are retained for **seven days**.
125139
Additionally, please note that the current API returns a maximum of **50,000 events**.
126140
We are actively working on expanding this limit in the coming days to support larger datasets and increased usage.
127141

128142
## Report rate
129-
The events might take up to 10 minutes to become available via API and Dashboard. For some TCP connections, the full event cycle might take longer, depending on OS settings and connection termination.
143+
The events might take up to **ten minutes** to become available via API and Dashboard. For some TCP connections, the full event cycle might take longer, depending on OS settings and connection termination.
130144

131145
## Enable Traffic Events Streaming to SIEM Systems
132146

0 commit comments

Comments
 (0)