diff --git a/internal/mode/static/telemetry/collector.go b/internal/mode/static/telemetry/collector.go index dbb7eda4a6..3dee1e602b 100644 --- a/internal/mode/static/telemetry/collector.go +++ b/internal/mode/static/telemetry/collector.go @@ -79,8 +79,8 @@ type NGFResourceCounts struct { RouteAttachedClientSettingsPolicyCount int64 // ObservabilityPolicyCount is the number of relevant ObservabilityPolicies. ObservabilityPolicyCount int64 - // NGINXProxyCount is the number of NGINXProxies. - NGINXProxyCount int64 + // NginxProxyCount is the number of NginxProxies. + NginxProxyCount int64 } // DataCollectorConfig holds configuration parameters for DataCollectorImpl. @@ -218,7 +218,7 @@ func collectGraphResourceCount( } if g.NginxProxy != nil { - ngfResourceCounts.NGINXProxyCount = 1 + ngfResourceCounts.NginxProxyCount = 1 } return ngfResourceCounts, nil diff --git a/internal/mode/static/telemetry/collector_test.go b/internal/mode/static/telemetry/collector_test.go index 2fd026ee98..09b14b0c54 100644 --- a/internal/mode/static/telemetry/collector_test.go +++ b/internal/mode/static/telemetry/collector_test.go @@ -374,7 +374,7 @@ var _ = Describe("Collector", Ordered, func() { GatewayAttachedClientSettingsPolicyCount: 1, RouteAttachedClientSettingsPolicyCount: 2, ObservabilityPolicyCount: 1, - NGINXProxyCount: 1, + NginxProxyCount: 1, } expData.ClusterVersion = "1.29.2" expData.ClusterPlatform = "kind" @@ -610,7 +610,7 @@ var _ = Describe("Collector", Ordered, func() { GatewayAttachedClientSettingsPolicyCount: 1, RouteAttachedClientSettingsPolicyCount: 1, ObservabilityPolicyCount: 1, - NGINXProxyCount: 1, + NginxProxyCount: 1, } data, err := dataCollector.Collect(ctx) @@ -634,7 +634,7 @@ var _ = Describe("Collector", Ordered, func() { GatewayAttachedClientSettingsPolicyCount: 0, RouteAttachedClientSettingsPolicyCount: 0, ObservabilityPolicyCount: 0, - NGINXProxyCount: 0, + NginxProxyCount: 0, } data, err := dataCollector.Collect(ctx) diff --git a/internal/mode/static/telemetry/data.avdl b/internal/mode/static/telemetry/data.avdl index c1a1c3aa0e..7d32720600 100644 --- a/internal/mode/static/telemetry/data.avdl +++ b/internal/mode/static/telemetry/data.avdl @@ -78,8 +78,8 @@ attached at the Gateway level. */ /** ObservabilityPolicyCount is the number of relevant ObservabilityPolicies. */ long? ObservabilityPolicyCount = null; - /** NGINXProxyCount is the number of NGINXProxies. */ - long? NGINXProxyCount = null; + /** NginxProxyCount is the number of NginxProxies. */ + long? NginxProxyCount = null; /** NGFReplicaCount is the number of replicas of the NGF Pod. */ long? NGFReplicaCount = null; diff --git a/internal/mode/static/telemetry/data_test.go b/internal/mode/static/telemetry/data_test.go index d0d9a18876..cb4b09df86 100644 --- a/internal/mode/static/telemetry/data_test.go +++ b/internal/mode/static/telemetry/data_test.go @@ -35,7 +35,7 @@ func TestDataAttributes(t *testing.T) { GatewayAttachedClientSettingsPolicyCount: 9, RouteAttachedClientSettingsPolicyCount: 10, ObservabilityPolicyCount: 11, - NGINXProxyCount: 12, + NginxProxyCount: 12, }, NGFReplicaCount: 3, } @@ -64,7 +64,7 @@ func TestDataAttributes(t *testing.T) { attribute.Int64("GatewayAttachedClientSettingsPolicyCount", 9), attribute.Int64("RouteAttachedClientSettingsPolicyCount", 10), attribute.Int64("ObservabilityPolicyCount", 11), - attribute.Int64("NGINXProxyCount", 12), + attribute.Int64("NginxProxyCount", 12), attribute.Int64("NGFReplicaCount", 3), } @@ -101,7 +101,7 @@ func TestDataAttributesWithEmptyData(t *testing.T) { attribute.Int64("GatewayAttachedClientSettingsPolicyCount", 0), attribute.Int64("RouteAttachedClientSettingsPolicyCount", 0), attribute.Int64("ObservabilityPolicyCount", 0), - attribute.Int64("NGINXProxyCount", 0), + attribute.Int64("NginxProxyCount", 0), attribute.Int64("NGFReplicaCount", 0), } diff --git a/internal/mode/static/telemetry/ngfresourcecounts_attributes_generated.go b/internal/mode/static/telemetry/ngfresourcecounts_attributes_generated.go index cc4199f183..1224cb096a 100644 --- a/internal/mode/static/telemetry/ngfresourcecounts_attributes_generated.go +++ b/internal/mode/static/telemetry/ngfresourcecounts_attributes_generated.go @@ -26,7 +26,7 @@ func (d *NGFResourceCounts) Attributes() []attribute.KeyValue { attrs = append(attrs, attribute.Int64("GatewayAttachedClientSettingsPolicyCount", d.GatewayAttachedClientSettingsPolicyCount)) attrs = append(attrs, attribute.Int64("RouteAttachedClientSettingsPolicyCount", d.RouteAttachedClientSettingsPolicyCount)) attrs = append(attrs, attribute.Int64("ObservabilityPolicyCount", d.ObservabilityPolicyCount)) - attrs = append(attrs, attribute.Int64("NGINXProxyCount", d.NGINXProxyCount)) + attrs = append(attrs, attribute.Int64("NginxProxyCount", d.NginxProxyCount)) return attrs diff --git a/site/content/overview/product-telemetry.md b/site/content/overview/product-telemetry.md index aa7e1b0283..f69b641718 100644 --- a/site/content/overview/product-telemetry.md +++ b/site/content/overview/product-telemetry.md @@ -26,7 +26,7 @@ Telemetry data is collected once every 24 hours and sent to a service managed by - **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`,`GRPCRoutes`, `Secrets`, `Services`, `BackendTLSPolicies`, `ClientSettingsPolicies`, `NGINXProxies`, `ObservabilityPolicies`, and `Endpoints`. The data within these resources is **not** collected. +- **Count of Resources:** the total count of resources related to NGINX Gateway Fabric. This includes `GatewayClasses`, `Gateways`, `HTTPRoutes`,`GRPCRoutes`, `Secrets`, `Services`, `BackendTLSPolicies`, `ClientSettingsPolicies`, `NginxProxies`, `ObservabilityPolicies`, and `Endpoints`. The data within these resources is **not** collected. This data is used to identify the following information: diff --git a/tests/suite/telemetry_test.go b/tests/suite/telemetry_test.go index 7000e66897..c6a8b65fc0 100644 --- a/tests/suite/telemetry_test.go +++ b/tests/suite/telemetry_test.go @@ -83,7 +83,7 @@ var _ = Describe("Telemetry test with OTel collector", Label("telemetry"), func( "GatewayAttachedClientSettingsPolicyCount: Int(0)", "RouteAttachedClientSettingsPolicyCount: Int(0)", "ObservabilityPolicyCount: Int(0)", - "NGINXProxyCount: Int(0)", + "NginxProxyCount: Int(0)", "NGFReplicaCount: Int(1)", }, )