starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Enable census collection #7939

New Issue
Closed
opened 2025-12-29 20:30:17 +01:00 by adam · 7 comments
adam commented 2025-12-29 20:30:17 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Apr 24, 2023).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.4.8

Feature type

New functionality

Proposed functionality

On startup, log the following metrics to census.netbox.dev using an HTTP POST request. (This collector is operated and maintained by the NetBox maintainers team.)

  • NetBox version
  • Python version
  • Random unique ID

This anonymized data will be collected and aggregated for analysis purposes (described below). This is very similar in nature to how many other open source applications track their user base. Only one log message will be sent per NetBox worker instance.

Additionally, introduce a CENSUS_REPORTING_ENABLED configuration parameter, which defaults to True. Setting this to False will disable all census reporting.

Use case

Ever since its initial open source release, we've struggled to ascertain just how many NetBox deployments exist in the world. (The closest analog we have is GitHub stars, which is of very limited utility.) Having NetBox automatically report this anonymized data will allow us to:

  • Form a rough idea about how many NetBox deployments exist
  • Measure the average intervals between version upgrades
  • Determine how long an old release remains in use (eventually)
  • Gauge resistance to the adoption of newer Python releases

Database changes

None

External dependencies

None; it should be feasible to implement a lightweight logging function natively.

Originally created by @jeremystretch on GitHub (Apr 24, 2023). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.4.8 ### Feature type New functionality ### Proposed functionality On startup, log the following metrics to `census.netbox.dev` using an HTTP `POST` request. (This collector is operated and maintained by the NetBox maintainers team.) - NetBox version - Python version - Random unique ID This anonymized data will be collected and aggregated for analysis purposes (described below). This is very similar in nature to how many other open source applications track their user base. Only one log message will be sent per NetBox worker instance. Additionally, introduce a `CENSUS_REPORTING_ENABLED` configuration parameter, which defaults to True. Setting this to False will disable all census reporting. ### Use case Ever since its initial open source release, we've struggled to ascertain just how many NetBox deployments exist in the world. (The closest analog we have is GitHub stars, which is of very limited utility.) Having NetBox automatically report this anonymized data will allow us to: - Form a rough idea about how many NetBox deployments exist - Measure the average intervals between version upgrades - Determine how long an old release remains in use (eventually) - Gauge resistance to the adoption of newer Python releases ### Database changes None ### External dependencies None; it should be feasible to implement a lightweight logging function natively.
adam added the status: acceptedtype: feature labels 2025-12-29 20:30:17 +01:00
adam closed this issue 2025-12-29 20:30:17 +01:00
adam commented 2025-12-29 20:30:17 +01:00
Author
Owner
Copy Link

@abhi1693 commented on GitHub (Apr 24, 2023):

Would this not cause issues in containerized deployments where people are running multiple replicas? Or, what if an instance came online due to restarts or downtime.

There has to be a very deterministic way to generate the UUID to avoid duplicate data to be posted to the endpoint.

@abhi1693 commented on GitHub (Apr 24, 2023): Would this not cause issues in containerized deployments where people are running multiple replicas? Or, what if an instance came online due to restarts or downtime. There has to be a very deterministic way to generate the UUID to avoid duplicate data to be posted to the endpoint.
adam commented 2025-12-29 20:30:18 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 25, 2023):

There has to be a very deterministic way to generate the UUID to avoid duplicate data to be posted to the endpoint.

The implication of using a UUID was an error on my part when drafting the implementation. I had been using UUIDs for testing, but in practice we can use the unique DEPLOYMENT_ID already generated by NetBox to support Sentry integration.

Ultimately though, it's not a problem if this changes over time, as we're primarily concerned with counting the number of total NetBox deployments at each version at any point in time, and identifying macro trends over long timelines.

@jeremystretch commented on GitHub (Apr 25, 2023): > There has to be a very deterministic way to generate the UUID to avoid duplicate data to be posted to the endpoint. The implication of using a UUID was an error on my part when drafting the implementation. I had been using UUIDs for testing, but in practice we can use the unique `DEPLOYMENT_ID` already generated by NetBox to support Sentry integration. Ultimately though, it's not a problem if this changes over time, as we're primarily concerned with counting the number of total NetBox deployments at each version at any point in time, and identifying macro trends over long timelines.
adam commented 2025-12-29 20:30:18 +01:00
Author
Owner
Copy Link

@decoupca commented on GitHub (Apr 26, 2023):

In the spirit of transparency I think it would be appropriate to add CENSUS_REPORTING_ENABLED to configuration_example.py as well.

@decoupca commented on GitHub (Apr 26, 2023): In the spirit of transparency I think it would be appropriate to add `CENSUS_REPORTING_ENABLED` to `configuration_example.py` as well.
adam commented 2025-12-29 20:30:18 +01:00
Author
Owner
Copy Link

@davekempe commented on GitHub (Apr 26, 2023):

Hey @jeremystretch what's the plan with the use of IP address data used in the request to census.netbox? I support this feature, just wondering what the plan is for transparency. I suppose you can get a breakdown of cloud vs on prem.

@davekempe commented on GitHub (Apr 26, 2023): Hey @jeremystretch what's the plan with the use of IP address data used in the request to census.netbox? I support this feature, just wondering what the plan is for transparency. I suppose you can get a breakdown of cloud vs on prem.
adam commented 2025-12-29 20:30:19 +01:00
Author
Owner
Copy Link

@davekempe commented on GitHub (Apr 26, 2023):

Oh another thought I had, lots of our on prem deployments need a proxy to get out to the internet. So netbox would need to know how to use that proxy if you want this to work.

@davekempe commented on GitHub (Apr 26, 2023): Oh another thought I had, lots of our on prem deployments need a proxy to get out to the internet. So netbox would need to know how to use that proxy if you want this to work.
adam commented 2025-12-29 20:30:19 +01:00
Author
Owner
Copy Link

@decoupca commented on GitHub (Apr 26, 2023):

Oh another thought I had, lots of our on prem deployments need a proxy to get out to the internet. So netbox would need to know how to use that proxy if you want this to work.

the call uses HTTP_PROXIES from configuration.py

@decoupca commented on GitHub (Apr 26, 2023): > Oh another thought I had, lots of our on prem deployments need a proxy to get out to the internet. So netbox would need to know how to use that proxy if you want this to work. the call uses `HTTP_PROXIES` from configuration.py
adam commented 2025-12-29 20:30:20 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 26, 2023):

Hey @jeremystretch what's the plan with the use of IP address data used in the request to census.netbox?

No plan; we're just counting unique deployments (identified by deployment ID) per NetBox release. I plan to share some stats after a few months.

@jeremystretch commented on GitHub (Apr 26, 2023): > Hey @jeremystretch what's the plan with the use of IP address data used in the request to census.netbox? No plan; we're just counting unique deployments (identified by deployment ID) per NetBox release. I plan to share some stats after a few months.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#7939
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?