-
Notifications
You must be signed in to change notification settings - Fork 118
Product Telemetry collection document #1614
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0565ea2
Product Telemetry collection document
sjberman 57cfe1a
Apply suggestions from code review
sjberman 61d0a25
Code review
sjberman 2b3de20
Architecture note
sjberman 096775b
Merge branch 'main' into docs/product-telemetry
sjberman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: "Product Telemetry" | ||
description: "Learn how NGINX Gateway Fabric collects product telemetry to identify areas to focus development on improving." | ||
weight: 500 | ||
toc: true | ||
--- | ||
|
||
## Overview | ||
|
||
NGINX Gateway Fabric collects telemetry by default, which allows its developers to understand what features are most popular with its user base. This data is used to triage development work, prioritizing features and functionality that will positively impact the most people. | ||
sjberman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Telemetry data is collected once every 24 hours and sent to a service managed by F5 over HTTPS. Personally identifiable information (PII) is **not** collected. The list of data points that are collected can be seen below. | ||
|
||
**If you would prefer to not have data collected, you can [opt-out](#opt-out) when installing NGINX Gateway Fabric.** | ||
|
||
## Collected data | ||
bjee19 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
sjberman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- **Kubernetes:** | ||
- **Platform:** the Kubernetes platform that NGINX Gateway Fabric is running on | ||
sjberman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- **Version:** the Kubernetes version that NGINX Gateway Fabric is running on. | ||
- **Architecture:** the architecture that the Kubernetes environment is running on. | ||
- **Cluster UID:** the UID of the `kube-system` Namespace in the cluster that NGINX Gateway Fabric is running in. | ||
- **Cluster Node Count:** the number of Nodes in the cluster. | ||
- **Version:** the version of the NGINX Gateway Fabric Deployment. | ||
- **Deployment UID:** the UID of the NGINX Gateway Fabric Deployment. | ||
- **Deployment Replica Count:** the count of NGINX Gateway Fabric Pods. | ||
- **Image Build Source:** whether the image was built by GitHub or locally (values are `gha`, `local`, or `unknown`). The source repository of the images is **not** collected. | ||
- **Deployment Flags:** a list of NGINX Gateway Fabric Deployment flags that are specified by a user. The actual values of non-boolean flags are **not** collected; we only record that they are either `true` or `false` for boolean flags and `default` or `user-defined` for the rest. | ||
- **Count of Resources:** the total count of resources related to NGINX Gateway Fabric. This includes `GatewayClasses`, `Gateways`, `HTTPRoutes`, `Secrets`, `Services`, and `Endpoints`. The data within these resources is **not** collected. | ||
|
||
This data is used to identify the following information: | ||
|
||
- The flavors of Kubernetes environments that are most popular among our users. | ||
- The number of unique NGINX Gateway Fabric installations. | ||
- The scale of NGINX Gateway Fabric Deployments. | ||
- The scale of Gateway API resources. | ||
- The used features of NGINX Gateway Fabric. | ||
|
||
Our goal is to publicly discuss data trends to drive roadmap discussions in our [Community Meeting](https://github.com/nginxinc/nginx-gateway-fabric/discussions/1472). | ||
|
||
## Opt out | ||
|
||
You can disable product telemetry when installing NGINX Gateway Fabric using an option dependent on your installation method: | ||
|
||
### Helm | ||
|
||
Set the `nginxGateway.productTelemetry.enable=false` flag either in the `values.yaml` file or when installing: | ||
|
||
```shell | ||
helm install ... --set nginxGateway.productTelemetry.enable=false | ||
``` | ||
|
||
### Manifests | ||
|
||
Add the `--product-telemetry-disable` flag to the `nginx-gateway` container in your Deployment manifest. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.