Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable Production Endpoint for Product Telemetry #1699

Merged
merged 4 commits into from
Mar 15, 2024

Conversation

pleshakov
Copy link
Contributor

Proposed changes

Problem:
Start sending product telemetry to the product F5 telemetry service.

Solution:

  • Use the production telemetry endpoint in production NGF image, built using:
    • goreleaser
    • make commands from building the images doc
  • Introduce new targets in the Makefile for building prod images.

Developer instructions for building NGF image remain unchanged, and such image will not send any telemetry, but will report it in the logs at the debug level.

Testing:

  • Confirmed production NGF image built using make command sends telemetry.
  • Confirmed developer NGF image build using make command doesn't send any telemetry but reports it in the logs.
  • Confirmed that data has been successfully stored in F5 telemetry service.

CLOSES - #1563

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

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

NGINX Gateway Fabric will collect and report product telemetry to an F5 telemetry service every 24h. Read https://docs.nginx.com/nginx-gateway-fabric/overview/product-telemetry/ for more info, including what gets collected and how to opt out.

The link above will give 404. Preview link -- https://deploy-preview-1614--nginx-gateway-fabric.netlify.app/nginx-gateway-fabric/overview/product-telemetry/

pleshakov and others added 3 commits March 13, 2024 16:38
Problem:
Start sending product telemetry to the product F5 telemetry service.

Solution:
- Use the production telemetry endpoint in production NGF image, built
  using:
  - goreleaser
  - make commands from building the images doc
- Introduce new targets in the Makefile for building prod images.

Developer instructions for building NGF image remain unchanged, and
such image will not send any telemetry, but will report it in the logs
at the debug level.

Testing:
- Confirmed production NGF image built using make command sends
  telemetry.
- Confirmed developer NGF image build using make command doesn't send
  any telemetry but reports it in the logs.

CLOSES - #1563
@pleshakov pleshakov requested review from a team as code owners March 15, 2024 16:21
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 15, 2024
@sjberman sjberman enabled auto-merge (squash) March 15, 2024 23:11
@sjberman sjberman merged commit b6cb677 into main Mar 15, 2024
40 checks passed
@sjberman sjberman deleted the feature/enable-prod-telemetry branch March 15, 2024 23:21
amimimor pushed a commit to amimimor/nginx-gateway-fabric that referenced this pull request Apr 3, 2024
Problem:
Start sending product telemetry to the product F5 telemetry service.

Solution:
- Use the production telemetry endpoint in production NGF image, built
  using:
  - goreleaser
  - make commands from building the images doc
- Introduce new targets in the Makefile for building prod images.

Developer instructions for building NGF image remain unchanged, and
such image will not send any telemetry, but will report it in the logs
at the debug level.

Testing:
- Confirmed production NGF image built using make command sends
  telemetry.
- Confirmed developer NGF image build using make command doesn't send
  any telemetry but reports it in the logs.

CLOSES - nginxinc#1563
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request release-notes
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants