Skip to content

Commit

Permalink
Documentation on what Telemetry Data is collected + how to opt-in/opt…
Browse files Browse the repository at this point in the history
…-out (#5253)
  • Loading branch information
shaun-nx authored Mar 15, 2024
1 parent 323cce7 commit 71fd750
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions docs/content/overview/product-telemetry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "Product Telemetry"
description: "Learn why NGINX Ingress Controller collects telemetry, and understand how and what it gathers."
weight: 500
toc: true
---

## Overview

NGINX Ingress Controller collects product telemetry data to allow its developers to understand how it's deployed and configured by users.
This data is used to triage development work, prioritizing features and functionality that will benefit the most people.


Product telemetry is enabled by default, collected once every 24 hours. It's then sent to a service managed by F5 over HTTPS.

{{< note >}}
If you would prefer to avoid sending any telemetry data, you can [opt-out](#opt-out) when installing NGINX Ingress Controller.
{{< /note >}}

## Data Collected

These are the data points collected and reported by NGINX Ingress Controller:
- **Project Name** The name of the software, which will be labelled `NIC`.
- **Project Version** The NGINX Ingress Controller version.
- **Project Version** The NGINX Ingress Controller version.
- **Installation ID** Used to identify a unique installation of NGINX Ingress Controller.
- **VirtualServers** The number of VirtualServer resources managed by NGINX Ingress Controller.
- **VirtualServerRoutes** The number of VirtualServerRoute resources managed by NGINX Ingress Controller.
- **TransportServers** The number of TransportServer resources managed by the NGINX Ingress Controller.

## Opt out

Product telemetry can be disabled when installing NGINX Ingress Controller.

### Helm


When installing or upgrading NGINX Ingress Controller with Helm, set the `controller.telemetry.enable` option to `false`
This can be set directly in the `values.yaml` file, or using the `--set` option

```shell
helm upgrade --install ... --set controller.telemetry.enable=false
```

### Manifests

When installing NGINX Ingress Controller with Manifests, set the `-enable-telemetry-reporting` flag to `false`

0 comments on commit 71fd750

Please sign in to comment.