Skip to content

Commit

Permalink
GITBOOK-317: change request with no subject merged in GitBook
Browse files Browse the repository at this point in the history
  • Loading branch information
defguard-community authored and gitbook-bot committed Dec 16, 2024
1 parent 84d9075 commit fd069de
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@

* [Roadmap](features/roadmap.md)
* [Architecture](in-depth/architecture/README.md)
* [How do VPN statistics work](in-depth/architecture/how-do-vpn-statistics-work.md)
* [Security concepts](in-depth/architecture/security-concepts.md)

## For Developers
Expand Down
13 changes: 13 additions & 0 deletions in-depth/architecture/how-do-vpn-statistics-work.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# How do VPN statistics work

1. Each defguard gateway reads kernel data from the WireGuard® interface for each peer.
2. If any change is detected between previous stats (bytes in/out) then through the gRPC interface the gateway sends those statistics to defguard core.

{% hint style="info" %}
If the gateway doesn't detect any changes in stats, doesn't send anything to core.

The period for each gateway to gather stats from the interfaces is defined by `DEFGUARD_STATS_PERIOD` ENV value (or -p argument) - default 30sec.
{% endhint %}

3. Core stores all the data send trough gRPC in the database (table `wireguard_peer_stats`).
4. Then when displaying the VPN overview does all the calculations and aggregations of the data to display them.

0 comments on commit fd069de

Please sign in to comment.