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 #1686

Closed

Conversation

pleshakov
Copy link
Contributor

@pleshakov pleshakov commented Mar 13, 2024

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.

CLOSES - #1563

REMANING THINGS:

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/

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
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 13, 2024
Makefile Show resolved Hide resolved
Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pleshakov pleshakov marked this pull request as ready for review March 15, 2024 16:04
@pleshakov pleshakov requested review from a team as code owners March 15, 2024 16:04
@pleshakov
Copy link
Contributor Author

closing this favor of #1699 because of pipeline issues

@pleshakov pleshakov closed this Mar 15, 2024
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
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants