Adoption Telemetry #793
Description
As a maintainer of NGF
I want users to send telemetry containing non-personal information on their environment
So that I know is the popularity of our product has increased over time, after a feature, or after another event
And so that I can use basic cluster information to build a persona of our typical user
And so that I can use the relative popularity of our features to prioritize future development.
Background
After 1.0, the NKG project needs a way to track adoption beyond just downloads. Specifically, we want to look at number of deployments, cluster size, which features are being used, and other non-identifying attributes. This data can be used to validate that we are delivering the right features and which new features will have the biggest impact.
We also want users to be able to view the data they are sending to gain valuable insights for their own cluster. What will be available on initial release will depend on the implementation we choose to store the data.
Users need a way to opt-out of any and all telemetry they do not want to participate in.
Acceptance Criteria
- Telemetry is enabled by default, with an easy option to disable before and after NGF is installed.
- Sent telemetry is associated with an identifier that is unique for each cluster.
- Sent telemetry contains the data outlined here
- Documentation is created that outlines what telemetry is sent and how to disable it.
### Tasks
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1382
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1303
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1304
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1306
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1307
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1308
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1309
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1310
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1312
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1315
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1316
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1318
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1317
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1319
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1374
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1375
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1377
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1521
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1522
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1561
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1562
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1563
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1640
For Discussion
- How can NGF work with NIC to build a common telemetry solution?
- Are there any elements above we want to avoid for the initial releases of telemetry due to excessive complexity?
- Should we include any of the following?
- CRD Type count - for Ingress only?
- Ingress Annotations
- Deployment flag options
- Installation method
- Is there any reason to use an OpenTelemetry Gateway at this stage?