Telemetry Job

[shaun-nx]

Proposed changes

This PR adds the base telemetry job that will be responsible for collecting telemetry data for each deployment of the Ingress Controller.

The current implementation of the Job writes collected, fake data to a dummy exporter.

Tasks to gather and report specific telemetry data points are outlined here: #4877

Tests

• Ensure only the leader pod reports data:

I0124 15:43:17.788228       1 leaderelection.go:260] successfully acquired lease nginx-ingress/nginx-ingress-leader-election
I0124 15:43:17.789698       1 leader.go:60] started leading
I0124 15:43:17.789842       1 leader.go:77] updating VirtualServer and VirtualServerRoutes status
I0124 15:43:17.791000       1 telemetry.go:104] Collecting telemetry data
I0124 15:43:17.791729       1 telemetry.go:113] Exported telemetry data

• Ensure new leader pod start reporting if leader is lost
• Ensure telemetry data is not reported when enable-telemetry-reporting flag is set to false
• Ensure telemetry is reported at the period that it is configured at
• Update Helm values to add new CLI arguments
• Confirm telemetry is not reported when enable-telemetry-reporting it set to false in Helm values
• Update Helm install documentation

Checklist

Before creating a PR, run through this checklist and mark each as complete.

• I have read the CONTRIBUTING doc
• I have added tests that prove my fix is effective or that my feature works
• I have checked that all unit tests pass after adding my changes
• I have updated necessary documentation
• I have rebased my branch onto main
• I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

[codecov]

Codecov Report

Attention: 47 lines in your changes are missing coverage. Please review.

Comparison is base (8a2c9a9) 52.32% compared to head (22ca1e8) 52.29%.
Report is 8 commits behind head on main.

❗ Current head 22ca1e8 differs from pull request most recent head cebd70c. Consider uploading reports for the commit cebd70c to get more accurate results

Files	Patch %	Lines
internal/telemetry/telemetry.go	61.53%	16 Missing and 4 partials ⚠️
internal/k8s/controller.go	0.00%	16 Missing ⚠️
cmd/nginx-ingress/flags.go	69.23%	4 Missing ⚠️
internal/k8s/leader.go	0.00%	4 Missing ⚠️
cmd/nginx-ingress/main.go	0.00%	2 Missing ⚠️
internal/nginx/fake_manager.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4896      +/-   ##
==========================================
- Coverage   52.32%   52.29%   -0.03%     
==========================================
  Files          61       62       +1     
  Lines       17502    17589      +87     
==========================================
+ Hits         9158     9199      +41     
- Misses       8015     8057      +42     
- Partials      329      333       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ADubhlaoich]

Should this be mentioned somewhere in user-facing documentation?

[shaun-nx]

Should this be mentioned somewhere in user-facing documentation?

There will be documentation added as part of the overall implementation.
This specific piece of work is just to create the base "dummy" job. It currently doesn't actually export any data.
It still needs to be fleshed out, but the issue is tracked here: #4898

[vepatel]

@jjngx maybe we can implement a something like https://github.com/nginxinc/nginx-gateway-fabric/blob/9f4248e0d629f7953fde17f4f03bd95034306f7f/internal/mode/static/telemetry/telemetryfakes/fake_exporter.go for completeness in unit testing

[jjngx]

We need consensus on how the telemetry job time period is handled - as string (that comes at the moment from flags) or as time.Duration. If the latter, then unit tests would need to be updated.

[jjngx]

👍🏻