Skip to content

Add nginx one console connection telemetry field #3717

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

Merged
merged 3 commits into from
Aug 13, 2025

Conversation

salonichf5
Copy link
Contributor

@salonichf5 salonichf5 commented Aug 11, 2025

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: We want to know how many clusters are connected to NGINX One console.

Solution: Reports product telemetry to report if cluster is connected to NGINX One console

Testing: Unit tests, functional tests

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

Closes #3119

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.

NONE

@github-actions github-actions bot added enhancement New feature or request tests Pull requests that update tests labels Aug 11, 2025
@salonichf5
Copy link
Contributor Author

Do we add release notes for adding telemetry fields since its user information?

@salonichf5 salonichf5 marked this pull request as ready for review August 11, 2025 16:44
@salonichf5 salonichf5 requested a review from a team as a code owner August 11, 2025 16:44
Copy link

codecov bot commented Aug 11, 2025

Codecov Report

❌ Patch coverage is 40.00000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.91%. Comparing base (ca42cd7) to head (b16f122).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
internal/controller/manager.go 0.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3717      +/-   ##
==========================================
- Coverage   86.95%   86.91%   -0.04%     
==========================================
  Files         128      128              
  Lines       15962    15965       +3     
  Branches       62       62              
==========================================
- Hits        13879    13876       -3     
- Misses       1917     1922       +5     
- Partials      166      167       +1     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sjberman
Copy link
Collaborator

Do we add release notes for adding telemetry fields since its user information?

@salonichf5 I don't think we have in the past, though we do update our documentation page that talks about this.

@salonichf5 salonichf5 requested a review from sjberman August 11, 2025 17:31
Copy link
Contributor

@bjee19 bjee19 left a comment

Choose a reason for hiding this comment

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

Have you already done the testing on the xcdf side and updated the schema on that side?

@salonichf5
Copy link
Contributor Author

Have you already done the testing on the xcdf side and updated the schema on that side?

no, waiting on databricks to start working for me.

Copy link
Contributor

@bjee19 bjee19 left a comment

Choose a reason for hiding this comment

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

Approving for now, though probably shouldnt be merged until xcdf testing is completed, also should update https://github.com/nginx/documentation/blob/main/content/ngf/overview/product-telemetry.md

@salonichf5
Copy link
Contributor Author

Docs PR - nginx/documentation#944

@salonichf5 salonichf5 force-pushed the feat/nginx-one-telemetry branch from 37a5ec8 to 92e640b Compare August 13, 2025 19:37
@salonichf5
Copy link
Contributor Author

verified that the field shows up as expected on Dev and prod endpoints.

@salonichf5 salonichf5 enabled auto-merge (squash) August 13, 2025 20:18
@salonichf5 salonichf5 merged commit b280a93 into main Aug 13, 2025
127 of 132 checks passed
@salonichf5 salonichf5 deleted the feat/nginx-one-telemetry branch August 13, 2025 22:41
@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in NGINX Gateway Fabric Aug 13, 2025
salonichf5 added a commit that referenced this pull request Aug 13, 2025
Problem: We want to know how many clusters are connected to NGINX One console.

Solution: Reports product telemetry to report if cluster is connected to NGINX One console
salonichf5 added a commit that referenced this pull request Aug 13, 2025
Problem: We want to know how many clusters are connected to NGINX One console.

Solution: Reports product telemetry to report if cluster is connected to NGINX One console
salonichf5 added a commit that referenced this pull request Aug 13, 2025
Add nginx one console connection telemetry field (#3717)

Problem: We want to know how many clusters are connected to NGINX One console.

Solution: Reports product telemetry to report if cluster is connected to NGINX One console
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request tests Pull requests that update tests
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Product Telemetry (Yes/No) for NGINX One Console Connection
4 participants