Skip to content

Commit 2d52c60

Browse files
sarthypartybjee19
authored andcommitted
finish update to data schema and site
1 parent 0141165 commit 2d52c60

File tree

5 files changed

+34
-26
lines changed

5 files changed

+34
-26
lines changed

internal/mode/static/telemetry/data.avdl

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,82 +8,85 @@
88
/** The time our edge ingested the event */
99
long ingestTime;
1010

11-
11+
1212
/** ImageSource tells whether the image was built by GitHub or locally (values are 'gha', 'local', or 'unknown') */
1313
string? ImageSource = null;
14-
14+
1515
/** ProjectName is the name of the project. */
1616
string? ProjectName = null;
17-
17+
1818
/** ProjectVersion is the version of the project. */
1919
string? ProjectVersion = null;
20-
20+
2121
/** ProjectArchitecture is the architecture of the project. For example, "amd64". */
2222
string? ProjectArchitecture = null;
23-
23+
2424
/** ClusterID is the unique id of the Kubernetes cluster where the project is installed.
2525
It is the UID of the `kube-system` Namespace. */
2626
string? ClusterID = null;
27-
27+
2828
/** ClusterVersion is the Kubernetes version of the cluster. */
2929
string? ClusterVersion = null;
30-
30+
3131
/** ClusterPlatform is the Kubernetes platform of the cluster. */
3232
string? ClusterPlatform = null;
33-
33+
3434
/** InstallationID is the unique id of the project installation in the cluster. */
3535
string? InstallationID = null;
36-
36+
3737
/** ClusterNodeCount is the number of nodes in the cluster. */
3838
long? ClusterNodeCount = null;
39-
39+
4040
/** FlagNames contains the command-line flag names. */
4141
union {null, array<string>} FlagNames = null;
42-
42+
4343
/** FlagValues contains the values of the command-line flags, where each value corresponds to the flag from FlagNames
4444
at the same index.
4545
Each value is either 'true' or 'false' for boolean flags and 'default' or 'user-defined' for non-boolean flags. */
4646
union {null, array<string>} FlagValues = null;
47-
47+
4848
/** GatewayCount is the number of relevant Gateways. */
4949
long? GatewayCount = null;
50-
50+
5151
/** GatewayClassCount is the number of relevant GatewayClasses. */
5252
long? GatewayClassCount = null;
53-
53+
5454
/** HTTPRouteCount is the number of relevant HTTPRoutes. */
5555
long? HTTPRouteCount = null;
56-
56+
57+
/** TLSRouteCount is the number of relevant TLSRoutes. */
58+
long? TLSRouteCount = null;
59+
5760
/** SecretCount is the number of relevant Secrets. */
5861
long? SecretCount = null;
59-
62+
6063
/** ServiceCount is the number of relevant Services. */
6164
long? ServiceCount = null;
62-
65+
6366
/** EndpointCount include the total count of Endpoints(IP:port) across all referenced services. */
6467
long? EndpointCount = null;
65-
68+
6669
/** GRPCRouteCount is the number of relevant GRPCRoutes. */
6770
long? GRPCRouteCount = null;
68-
71+
6972
/** BackendTLSPolicyCount is the number of relevant BackendTLSPolicies. */
7073
long? BackendTLSPolicyCount = null;
71-
74+
7275
/** GatewayAttachedClientSettingsPolicyCount is the number of relevant ClientSettingsPolicies
7376
attached at the Gateway level. */
7477
long? GatewayAttachedClientSettingsPolicyCount = null;
75-
78+
7679
/** RouteAttachedClientSettingsPolicyCount is the number of relevant ClientSettingsPolicies attached at the Route level. */
7780
long? RouteAttachedClientSettingsPolicyCount = null;
78-
81+
7982
/** ObservabilityPolicyCount is the number of relevant ObservabilityPolicies. */
8083
long? ObservabilityPolicyCount = null;
81-
84+
8285
/** NginxProxyCount is the number of NginxProxies. */
8386
long? NginxProxyCount = null;
84-
87+
8588
/** NGFReplicaCount is the number of replicas of the NGF Pod. */
8689
long? NGFReplicaCount = null;
87-
90+
8891
}
8992
}

internal/mode/static/telemetry/data_test.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ func TestDataAttributes(t *testing.T) {
3131
ServiceCount: 5,
3232
EndpointCount: 6,
3333
GRPCRouteCount: 7,
34+
TLSRouteCount: 5,
3435
BackendTLSPolicyCount: 8,
3536
GatewayAttachedClientSettingsPolicyCount: 9,
3637
RouteAttachedClientSettingsPolicyCount: 10,
@@ -56,6 +57,7 @@ func TestDataAttributes(t *testing.T) {
5657
attribute.Int64("GatewayCount", 1),
5758
attribute.Int64("GatewayClassCount", 2),
5859
attribute.Int64("HTTPRouteCount", 3),
60+
attribute.Int64("TLSRouteCount", 5),
5961
attribute.Int64("SecretCount", 4),
6062
attribute.Int64("ServiceCount", 5),
6163
attribute.Int64("EndpointCount", 6),
@@ -93,6 +95,7 @@ func TestDataAttributesWithEmptyData(t *testing.T) {
9395
attribute.Int64("GatewayCount", 0),
9496
attribute.Int64("GatewayClassCount", 0),
9597
attribute.Int64("HTTPRouteCount", 0),
98+
attribute.Int64("TLSRouteCount", 0),
9699
attribute.Int64("SecretCount", 0),
97100
attribute.Int64("ServiceCount", 0),
98101
attribute.Int64("EndpointCount", 0),

internal/mode/static/telemetry/ngfresourcecounts_attributes_generated.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ func (d *NGFResourceCounts) Attributes() []attribute.KeyValue {
1515
attrs = append(attrs, attribute.Int64("GatewayCount", d.GatewayCount))
1616
attrs = append(attrs, attribute.Int64("GatewayClassCount", d.GatewayClassCount))
1717
attrs = append(attrs, attribute.Int64("HTTPRouteCount", d.HTTPRouteCount))
18+
attrs = append(attrs, attribute.Int64("TLSRouteCount", d.TLSRouteCount))
1819
attrs = append(attrs, attribute.Int64("SecretCount", d.SecretCount))
1920
attrs = append(attrs, attribute.Int64("ServiceCount", d.ServiceCount))
2021
attrs = append(attrs, attribute.Int64("EndpointCount", d.EndpointCount))

site/content/overview/product-telemetry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Telemetry data is collected once every 24 hours and sent to a service managed by
2727
- **Deployment Replica Count:** the count of NGINX Gateway Fabric Pods.
2828
- **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.
2929
- **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.
30-
- **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.
30+
- **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`, and `Endpoints`. The data within these resources is **not** collected.
3131

3232
This data is used to identify the following information:
3333

tests/suite/telemetry_test.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ var _ = Describe("Telemetry test with OTel collector", Label("telemetry"), func(
7575
"GatewayCount: Int(0)",
7676
"GatewayClassCount: Int(1)",
7777
"HTTPRouteCount: Int(0)",
78+
"TLSRouteCount: Int(0)",
7879
"SecretCount: Int(0)",
7980
"ServiceCount: Int(0)",
8081
"EndpointCount: Int(0)",

0 commit comments

Comments
 (0)