Skip to content

Commit

Permalink
Update metrics faq (#201)
Browse files Browse the repository at this point in the history
* Update metrics faq

* Update src/pages/about-netbird/faq.mdx

Co-authored-by: Misha Bragin <[email protected]>

---------

Co-authored-by: Misha Bragin <[email protected]>
  • Loading branch information
mlsmaycon and braginini authored Jul 4, 2024
1 parent ce8a2da commit 9b2eb25
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions src/pages/about-netbird/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,28 +30,27 @@ Below is the list of NetBird hosted endpoints and ports they listen to:

## Why and what are the anonymous usage metrics?

### Why we added metrics collection?
As an open-source project and business, making decisions based on data is essential. We will know our adoption rate, feature usage, and client type with anonymous metrics.
### Why did we add metrics collection?
As an open-source project and business, making data-driven decisions is essential. By collecting anonymous metrics, we can understand our adoption rate, feature usage, and the types of client operating systems in use. We kindly ask our community users to keep metrics enabled, as this helps us assess the impact of bugs and measure the quality of our software over time.

<Note>
The collection is strict to our management system.
</Note>

If the metric collection infringes any internal regulation or policy, it can be disabled by setting the flag `--disable-anonymous-metrics=true` to the management service startup command.
If the metric collection infringes any internal regulation or policy, it can be disabled by setting the flag `--disable-anonymous-metrics=true` to the management service startup command. the default interval is 12 hours, but it can be adjusted with the environment variable `NETBIRD_METRICS_INTERVAL_IN_SECONDS`.

### What are the metrics being collected?
We are collecting the following metrics:
* Number of accounts
* Number of users
* Number of peers
* Number of peers
* Number of active peers in the last 24 hours
* Number of peers per operating system
* Number of setup keys usage
* Number of peers activated by users
* Number of rules
* Number of groups
* Number of routes
* Number of nameservers
* Feature usage, like number of routes, access control policies and nameservers
* Service uptime
* Service version
* Metrics generation time
Expand Down

0 comments on commit 9b2eb25

Please sign in to comment.