Epic - Adoption Telemetry

[shaun-nx]

Overview

As a maintainer of NIC, I would like to provide the product with a means to collect Product Telemetry so that I can better understand how our users configure our product

Add/updating data points

When collecting a new data point, or updating an existing data point, the Schema file should also be update.
This document contains the necessary steps to do this: https://github.com/nginxinc/kubernetes-ingress/blob/main/docs/developer/telemetry-schema-generation.md

Data Collection

Some data points that NIC is interested in collecting has been implemented by the nginx-cluster-connector
Details can be found in the data-design for the cluster connector

Tasks

Preview Give feedback

1. Update all int data types to int64
2. Confirm data is sent to XCDF devendpoint
3. Create PR on XCDF gitlab repo for Schmea
4. Enable Telemetry Job to configure an endpoint for the exporter #5221
   2 of 2
   +0
   
5. Document process for changes/updates to schema #5220
   3 of 3
   backlog +1
   
6. Create Documentation detailing what Telemetry Data is collected, and how to opt-in/opt-out #4898
   2 of 2
   backlog +1
   
7. Telemetry Job #4863
   5 of 5
   backlog +1
   

   
8. Count of VirtualServers in watched namespaces #4902
   2 of 2
   backlog +1
   
9. Count of TransportServers in watched namespaces #4903
   3 of 3
   backlog +1
   
10. Collect Node Count in Cluster #5123
    backlog +1
    
11. Collect the Cluster ID #4883
    backlog +1
    
12. Collect version and name of project #5136
    backlog +1
    
13. Collect version of k8s #5143
    backlog +1
    
14. Collect architecture - x86, ARM, s390, unknown other #5151
    backlog +1
    
15. Collect the InstallationID #4882
    backlog +1
    
16. Collect deployment platform #5144
    backlog +1
    
17. Collect number of deployment/daemonset replicas of NIC #5135
    backlog +1
    
18. Collect count of Ingresses #5138
    backlog +1
    
19. Collect count of Secrets #5140
    backlog +1
    
20. Collect count of IngressClasses #5137
    backlog +1
    
21. Collect count of Services #5139
    backlog +1
    
22. Collect use of GlobalConfiguration #5141
    backlog +1
    
23. Collect count of Policies #5142
    0 of 2
    backlog +1
    
24. List of configured Ingress Annotations #4884
    0 of 1
    backlog +1
    
25. Collect installation flag options #5416
    backlog +1
    
26. Collect version of App protect #5417
    backlog +1
    
27. Collect whether the deployment is using nginx plus or not #5419
    0 of 1
    backlog good first issue +2
    
28. Define Schema for NIC
29. Add Telemetry opt-out option in Helm
30. Add telemetry-exporter dependency & update otel library to latest #5210
    dependencies +1
    
31. Granularise Ingress Counts #5454
    +0
    
32. Granularise Service Counts #5452
    +0
    
33. Granularise Policy Counts #5453
    +0
    

Aha! Link: https://nginx.aha.io/epics/NIC-E-121

[github-actions]

Hi @shaun-nx thanks for reporting!

Be sure to check out the docs and the Contributing Guidelines while you wait for a human to take a look at this 🙂

Cheers!

[shaun-nx]

re-opening. Was closed after I linked an issue to it