Skip to content

Commit 3915c40

Browse files
committed
Change naming of directiveContext and count variables
1 parent 409d5f3 commit 3915c40

File tree

6 files changed

+40
-41
lines changed

6 files changed

+40
-41
lines changed

internal/mode/static/telemetry/collector.go

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,16 @@ type Data struct {
5050
// at the same index.
5151
// Each value is either 'true' or 'false' for boolean flags and 'default' or 'user-defined' for non-boolean flags.
5252
FlagValues []string
53-
// SnippetsFiltersDirectiveContexts contains the directive-context strings of all applied SnippetsFilters.
53+
// SnippetsFiltersDirectives contains the directive-context strings of all applied SnippetsFilters.
5454
// Both lists are ordered first by count, then by lexicographical order of the context string,
5555
// then lastly by directive string.
56-
SnippetsFiltersDirectiveContexts []string
57-
// SnippetsFiltersDirectiveContextsCount contains the count of the directive-context strings, where each count
58-
// corresponds to the string from SnippetsFiltersDirectiveContexts at the same index.
56+
SnippetsFiltersDirectives []string
57+
// SnippetsFiltersDirectivesCount contains the count of the directive-context strings, where each count
58+
// corresponds to the string from SnippetsFiltersDirectives at the same index.
5959
// Both lists are ordered first by count, then by lexicographical order of the context string,
6060
// then lastly by directive string.
61-
SnippetsFiltersDirectiveContextsCount []int64
62-
NGFResourceCounts // embedding is required by the generator.
61+
SnippetsFiltersDirectivesCount []int64
62+
NGFResourceCounts // embedding is required by the generator.
6363
// NGFReplicaCount is the number of replicas of the NGF Pod.
6464
NGFReplicaCount int64
6565
}
@@ -163,7 +163,7 @@ func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error) {
163163
return Data{}, fmt.Errorf("failed to get NGF deploymentID: %w", err)
164164
}
165165

166-
snippetsFiltersDirectiveContexts, snippetsFiltersDirectiveContextsCount := collectSnippetsFilterSnippetsInfo(g)
166+
snippetsFiltersDirectives, snippetsFiltersDirectivesCount := collectSnippetsFilterDirectives(g)
167167

168168
data := Data{
169169
Data: tel.Data{
@@ -176,14 +176,13 @@ func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error) {
176176
InstallationID: deploymentID,
177177
ClusterNodeCount: int64(clusterInfo.NodeCount),
178178
},
179-
NGFResourceCounts: graphResourceCount,
180-
ImageSource: c.cfg.ImageSource,
181-
FlagNames: c.cfg.Flags.Names,
182-
FlagValues: c.cfg.Flags.Values,
183-
NGFReplicaCount: int64(replicaCount),
184-
// maybe SnippetValues?
185-
SnippetsFiltersDirectiveContexts: snippetsFiltersDirectiveContexts,
186-
SnippetsFiltersDirectiveContextsCount: snippetsFiltersDirectiveContextsCount,
179+
NGFResourceCounts: graphResourceCount,
180+
ImageSource: c.cfg.ImageSource,
181+
FlagNames: c.cfg.Flags.Names,
182+
FlagValues: c.cfg.Flags.Values,
183+
NGFReplicaCount: int64(replicaCount),
184+
SnippetsFiltersDirectives: snippetsFiltersDirectives,
185+
SnippetsFiltersDirectivesCount: snippetsFiltersDirectivesCount,
187186
}
188187

189188
return data, nil
@@ -406,7 +405,7 @@ type sfDirectiveContext struct {
406405
context string
407406
}
408407

409-
func collectSnippetsFilterSnippetsInfo(g *graph.Graph) ([]string, []int64) {
408+
func collectSnippetsFilterDirectives(g *graph.Graph) ([]string, []int64) {
410409
directiveContextMap := make(map[sfDirectiveContext]int)
411410

412411
for _, sf := range g.SnippetsFilters {

internal/mode/static/telemetry/collector_test.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -169,13 +169,13 @@ var _ = Describe("Collector", Ordered, func() {
169169
InstallationID: string(ngfReplicaSet.ObjectMeta.OwnerReferences[0].UID),
170170
ClusterNodeCount: 1,
171171
},
172-
NGFResourceCounts: telemetry.NGFResourceCounts{},
173-
NGFReplicaCount: 1,
174-
ImageSource: "local",
175-
FlagNames: flags.Names,
176-
FlagValues: flags.Values,
177-
SnippetsFiltersDirectiveContexts: []string{},
178-
SnippetsFiltersDirectiveContextsCount: []int64{},
172+
NGFResourceCounts: telemetry.NGFResourceCounts{},
173+
NGFReplicaCount: 1,
174+
ImageSource: "local",
175+
FlagNames: flags.Names,
176+
FlagValues: flags.Values,
177+
SnippetsFiltersDirectives: []string{},
178+
SnippetsFiltersDirectivesCount: []int64{},
179179
}
180180

181181
k8sClientReader = &eventsfakes.FakeReader{}
@@ -416,7 +416,7 @@ var _ = Describe("Collector", Ordered, func() {
416416
expData.ClusterVersion = "1.29.2"
417417
expData.ClusterPlatform = "kind"
418418

419-
expData.SnippetsFiltersDirectiveContexts = []string{
419+
expData.SnippetsFiltersDirectives = []string{
420420
"auth_delay-server",
421421
"aio-http",
422422
"keepalive_time-location",
@@ -427,7 +427,7 @@ var _ = Describe("Collector", Ordered, func() {
427427
"worker_rlimit_nofile-main",
428428
"ignore_invalid_headers-server",
429429
}
430-
expData.SnippetsFiltersDirectiveContextsCount = []int64{
430+
expData.SnippetsFiltersDirectivesCount = []int64{
431431
3,
432432
2,
433433
2,

internal/mode/static/telemetry/data.avdl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,16 @@ 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;
4747

48-
/** SnippetsFiltersDirectiveContexts contains the directive-context strings of all applied SnippetsFilters.
48+
/** SnippetsFiltersDirectives contains the directive-context strings of all applied SnippetsFilters.
4949
Both lists are ordered first by count, then by lexicographical order of the context string,
5050
then lastly by directive string. */
51-
union {null, array<string>} SnippetsFiltersDirectiveContexts = null;
51+
union {null, array<string>} SnippetsFiltersDirectives = null;
5252

53-
/** SnippetsFiltersDirectiveContextsCount contains the count of the directive-context strings, where each count
54-
corresponds to the string from SnippetsFiltersDirectiveContexts at the same index.
53+
/** SnippetsFiltersDirectivesCount contains the count of the directive-context strings, where each count
54+
corresponds to the string from SnippetsFiltersDirectives at the same index.
5555
Both lists are ordered first by count, then by lexicographical order of the context string,
5656
then lastly by directive string. */
57-
union {null, array<long>} SnippetsFiltersDirectiveContextsCount = null;
57+
union {null, array<long>} SnippetsFiltersDirectivesCount = null;
5858

5959
/** GatewayCount is the number of relevant Gateways. */
6060
long? GatewayCount = null;

internal/mode/static/telemetry/data_attributes_generated.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ func (d *Data) Attributes() []attribute.KeyValue {
1717
attrs = append(attrs, d.Data.Attributes()...)
1818
attrs = append(attrs, attribute.StringSlice("FlagNames", d.FlagNames))
1919
attrs = append(attrs, attribute.StringSlice("FlagValues", d.FlagValues))
20-
attrs = append(attrs, attribute.StringSlice("SnippetsFiltersDirectiveContexts", d.SnippetsFiltersDirectiveContexts))
21-
attrs = append(attrs, attribute.Int64Slice("SnippetsFiltersDirectiveContextsCount", d.SnippetsFiltersDirectiveContextsCount))
20+
attrs = append(attrs, attribute.StringSlice("SnippetsFiltersDirectives", d.SnippetsFiltersDirectives))
21+
attrs = append(attrs, attribute.Int64Slice("SnippetsFiltersDirectivesCount", d.SnippetsFiltersDirectivesCount))
2222
attrs = append(attrs, d.NGFResourceCounts.Attributes()...)
2323
attrs = append(attrs, attribute.Int64("NGFReplicaCount", d.NGFReplicaCount))
2424

internal/mode/static/telemetry/data_test.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ func TestDataAttributes(t *testing.T) {
4040
NginxProxyCount: 12,
4141
SnippetsFilterCount: 13,
4242
},
43-
NGFReplicaCount: 3,
44-
SnippetsFiltersDirectiveContexts: []string{"main-three-count", "http-two-count", "server-one-count"},
45-
SnippetsFiltersDirectiveContextsCount: []int64{3, 2, 1},
43+
NGFReplicaCount: 3,
44+
SnippetsFiltersDirectives: []string{"main-three-count", "http-two-count", "server-one-count"},
45+
SnippetsFiltersDirectivesCount: []int64{3, 2, 1},
4646
}
4747

4848
expected := []attribute.KeyValue{
@@ -59,10 +59,10 @@ func TestDataAttributes(t *testing.T) {
5959
attribute.StringSlice("FlagNames", []string{"test-flag"}),
6060
attribute.StringSlice("FlagValues", []string{"test-value"}),
6161
attribute.StringSlice(
62-
"SnippetsFiltersDirectiveContexts",
62+
"SnippetsFiltersDirectives",
6363
[]string{"main-three-count", "http-two-count", "server-one-count"},
6464
),
65-
attribute.IntSlice("SnippetsFiltersDirectiveContextsCount", []int{3, 2, 1}),
65+
attribute.IntSlice("SnippetsFiltersDirectivesCount", []int{3, 2, 1}),
6666
attribute.Int64("GatewayCount", 1),
6767
attribute.Int64("GatewayClassCount", 2),
6868
attribute.Int64("HTTPRouteCount", 3),
@@ -103,8 +103,8 @@ func TestDataAttributesWithEmptyData(t *testing.T) {
103103
attribute.Int64("ClusterNodeCount", 0),
104104
attribute.StringSlice("FlagNames", nil),
105105
attribute.StringSlice("FlagValues", nil),
106-
attribute.StringSlice("SnippetsFiltersDirectiveContexts", nil),
107-
attribute.IntSlice("SnippetsFiltersDirectiveContextsCount", nil),
106+
attribute.StringSlice("SnippetsFiltersDirectives", nil),
107+
attribute.IntSlice("SnippetsFiltersDirectivesCount", nil),
108108
attribute.Int64("GatewayCount", 0),
109109
attribute.Int64("GatewayClassCount", 0),
110110
attribute.Int64("HTTPRouteCount", 0),

tests/suite/telemetry_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ var _ = Describe("Telemetry test with OTel collector", Label("telemetry"), func(
7272
fmt.Sprintf("ClusterNodeCount: Int(%d)", info.NodeCount),
7373
"FlagNames: Slice",
7474
"FlagValues: Slice",
75-
"SnippetsFiltersDirectiveContexts: Slice",
76-
"SnippetsFiltersDirectiveContextsCount: Slice",
75+
"SnippetsFiltersDirectives: Slice",
76+
"SnippetsFiltersDirectivesCount: Slice",
7777
"GatewayCount: Int(0)",
7878
"GatewayClassCount: Int(1)",
7979
"HTTPRouteCount: Int(0)",

0 commit comments

Comments
 (0)