Skip to content

Commit 707e7df

Browse files
authored
NGF: Update control data plane split telemetry (#485)
Update docs for CP/DP split telemetry changes. Problem: Some small docs changes are needed for the new telemetry metrics/changes introduced with the control data plane split. Solution: Add the new metrics. Also updated the data plane configuration document small error of including the namespace field in the gateway.infrastructure.parametersRef field since that does not exist.
1 parent b15d47e commit 707e7df

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

content/ngf/how-to/data-plane-configuration.md

-1
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,6 @@ infrastructure:
260260
group: gateway.nginx.org
261261
kind: NginxProxy
262262
name: ngf-proxy-config
263-
namespace: default
264263
```
265264

266265
After updating, you can check the status of the Gateway to see if the configuration is valid:

content/ngf/overview/product-telemetry.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,12 @@ Telemetry data is collected once every 24 hours and sent to a service managed by
2828
- **Cluster Node Count:** the number of Nodes in the cluster.
2929
- **Version:** the version of the NGINX Gateway Fabric Deployment.
3030
- **Deployment UID:** the UID of the NGINX Gateway Fabric Deployment.
31-
- **Deployment Replica Count:** the count of NGINX Gateway Fabric Pods.
3231
- **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.
3332
- **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.
3433
- **Count of Resources:** the total count of resources related to NGINX Gateway Fabric. This includes `GatewayClasses`, `Gateways`, `HTTPRoutes`,`GRPCRoutes`, `TLSRoutes`, `Secrets`, `Services`, `BackendTLSPolicies`, `ClientSettingsPolicies`, `NginxProxies`, `ObservabilityPolicies`, `UpstreamSettingsPolicies`, `SnippetsFilters`, and `Endpoints`. The data within these resources is **not** collected.
3534
- **SnippetsFilters Info**a list of directive-context strings from applied SnippetFilters and a total count per strings. The actual value of any NGINX directive is **not** collected.
35+
- **Control Plane Pod Count** the count of NGINX Gateway Fabric Pods.
36+
- **Data Plane Pod Count** the count of NGINX data plane Pods.
3637
This data is used to identify the following information:
3738

3839
- The flavors of Kubernetes environments that are most popular among our users.

0 commit comments

Comments
 (0)