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

Product Telemetry collection document #1614

Merged
merged 5 commits into from
Mar 15, 2024

Conversation

sjberman
Copy link
Contributor

@sjberman sjberman commented Feb 23, 2024

Problem: Users will want to understand how and why we collect product telemetry, as well as how to opt-out if desired.

Solution: Add a document explaining these things.

Closes #1319

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

@sjberman sjberman requested review from a team as code owners February 23, 2024 19:54
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 23, 2024
Copy link
Member

@ciarams87 ciarams87 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

LGTM, though I made a number of suggestions about phrasing.

site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved

This comment was marked as off-topic.

site/content/overview/product-telemetry.md Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated Show resolved Hide resolved
site/content/overview/product-telemetry.md Outdated 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.

🚀

@sjberman sjberman requested a review from pleshakov March 5, 2024 22:26
Copy link
Contributor

@salonichf5 salonichf5 left a comment

Choose a reason for hiding this comment

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

LGTM, excepts for a couple of nits

site/content/overview/product-telemetry.md Show resolved Hide resolved
site/content/overview/product-telemetry.md Show resolved Hide resolved
@pleshakov
Copy link
Contributor

@sjberman would it make sense to add a connection to Telemetry service here https://github.com/nginxinc/nginx-gateway-fabric/blob/main/site/content/overview/gateway-architecture.md#the-nginx-gateway-fabric-pod ?

I think we can just add it to a list so that we don't clutter the diagram. For example:


  1. (HTTP, HTTPS) A client sends traffic to and receives traffic from any of the NGINX workers on ports 80 and 443.
  2. (HTTP, HTTPS) An NGINX worker sends traffic to and receives traffic from the backends.

Below are additional connections not depicted on the diagram:

  • (HTTPS) NGF sends product telemetry data to the F5 telemetry service.

sjberman and others added 4 commits March 15, 2024 11:13
Problem: Users will want to understand how and why we collect product telemetry, as well as how to opt-out if desired.

Solution: Add a document explaining these things.
@sjberman sjberman force-pushed the docs/product-telemetry branch from c9fe755 to 2b3de20 Compare March 15, 2024 17:15
Copy link

codecov bot commented Mar 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.93%. Comparing base (b6cb677) to head (2b3de20).

❗ Current head 2b3de20 differs from pull request most recent head 096775b. Consider uploading reports for the commit 096775b to get more accurate results

Additional details and impacted files
@@             Coverage Diff              @@
##              main    #1614       +/-   ##
============================================
- Coverage   100.00%   85.93%   -14.07%     
============================================
  Files            1       87       +86     
  Lines          209     5511     +5302     
  Branches        52       52               
============================================
+ Hits           209     4736     +4527     
- Misses           0      723      +723     
- Partials         0       52       +52     

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

@sjberman sjberman enabled auto-merge (squash) March 15, 2024 23:24
@sjberman sjberman merged commit 1e0c44b into nginxinc:main Mar 15, 2024
38 checks passed
@sjberman sjberman deleted the docs/product-telemetry branch March 19, 2024 18:31
amimimor pushed a commit to amimimor/nginx-gateway-fabric that referenced this pull request Apr 3, 2024
Problem: Users will want to understand how and why we collect product telemetry, as well as how to opt-out if desired.

Solution: Add a document explaining these things.
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
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Telemetry Documentation
8 participants