Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example refactor of goldmane #10153

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Example refactor of goldmane #10153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
401 changes: 212 additions & 189 deletions goldmane/pkg/aggregator/aggregator.go
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 4 additions & 5 deletions goldmane/pkg/aggregator/aggregator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import (
googleproto "google.golang.org/protobuf/proto"

"github.com/projectcalico/calico/goldmane/pkg/aggregator"
"github.com/projectcalico/calico/goldmane/pkg/aggregator/bucketing"
"github.com/projectcalico/calico/goldmane/pkg/internal/utils"
"github.com/projectcalico/calico/goldmane/pkg/testutils"
"github.com/projectcalico/calico/goldmane/pkg/types"
Expand Down Expand Up @@ -733,7 +732,7 @@ func TestSink(t *testing.T) {
now := c.Now().Unix()

// Configure the aggregator with a test sink.
sink := &testSink{buckets: []*bucketing.FlowCollection{}}
sink := &testSink{buckets: []*aggregator.FlowCollection{}}
roller := &rolloverController{
ch: make(chan time.Time),
aggregationWindowSecs: 1,
Expand Down Expand Up @@ -784,7 +783,7 @@ func TestSink(t *testing.T) {
return len(sink.buckets)
}, waitTimeout, retryTime).Should(Equal(1), "Expected 1 bucket to be pushed to the sink")
require.Len(t, sink.buckets[0].Flows, 1, "Expected 1 flow in the bucket")
sink.buckets = []*bucketing.FlowCollection{}
sink.buckets = []*aggregator.FlowCollection{}

// We've rolled over once. The next emission should happen after
// bucktsToCombine more rollovers, which is the point at which the first bucket
Expand Down Expand Up @@ -869,7 +868,7 @@ func TestSink(t *testing.T) {
now := c.Now().Unix()

// Configure the aggregator with a test sink.
sink := &testSink{buckets: []*bucketing.FlowCollection{}}
sink := &testSink{buckets: []*aggregator.FlowCollection{}}
roller := &rolloverController{
ch: make(chan time.Time),
aggregationWindowSecs: 1,
Expand Down Expand Up @@ -936,7 +935,7 @@ func TestSink(t *testing.T) {
now := c.Now().Unix()

// Configure the aggregator with a test sink.
sink := &testSink{buckets: []*bucketing.FlowCollection{}}
sink := &testSink{buckets: []*aggregator.FlowCollection{}}
roller := &rolloverController{
ch: make(chan time.Time),
aggregationWindowSecs: 1,
Expand Down
126 changes: 35 additions & 91 deletions goldmane/pkg/aggregator/bucketing/bucket.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,113 +1,57 @@
// Copyright (c) 2025 Tigera, Inc. All rights reserved.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package bucketing

import (
"time"

"github.com/sirupsen/logrus"

"github.com/projectcalico/calico/goldmane/pkg/types"
"github.com/projectcalico/calico/goldmane/proto"
"github.com/projectcalico/calico/libcalico-go/lib/set"
)

// An aggregation bucket represents a bucket of aggregated flows across a time range.
type AggregationBucket struct {
// index is the index of the bucket in the ring.
index int
import "github.com/sirupsen/logrus"

// The start and end time of the bucket.
StartTime int64
EndTime int64

// Pushed indicates whether this bucket has been pushed to the emitter.
Pushed bool

// LookupFlow is a function that can be used to look up a DiachronicFlow by its key.
lookupFlow lookupFn
type Mergeable[E any] interface {
*E
Merge(E) E
}

// Flows contains an indication of the flows that are part of this bucket.
Flows set.Set[*types.DiachronicFlow]
type BucketMap[K comparable, V any, M Mergeable[V]] map[K]*V

// Tracker for statistics within this bucket.
stats *statisticsIndex
type BucketMeta[V any] interface {
Update(V)
}

func (b *AggregationBucket) AddFlow(flow *types.Flow) {
if b.Pushed {
logrus.WithField("flow", flow).Warn("Adding flow to already published bucket")
}
type Bucket[Meta BucketMeta[S], K Key[R], V Mergeable[S], R comparable, S any] struct {
Meta Meta
index int
timeRing *timeRing

if flow == nil {
logrus.Fatal("BUG: Attempted to add nil flow to bucket")
}
if flow.Key == nil {
logrus.WithField("flow", flow).Fatal("BUG: Attempted to add flow with nil key to bucket")
}
if b.lookupFlow == nil {
logrus.WithField("flow", flow).Fatal("BUG: Attempted to add flow to bucket with no lookup function")
}
d := b.lookupFlow(*flow.Key)
if d == nil {
logrus.WithField("flow", flow).Fatal("BUG: Attempted to add flow with no corresponding DiachronicFlow")
}
// TODO Rename from windows.
Windows map[K]S
}

// Mark this Flow as part of this bucket.
b.Flows.Add(d)
func (b *Bucket[Meta, K, V, R, S]) StartTime() int64 {
return b.timeRing.indexToTime(b.index)
}

// Track policy stats.
b.stats.AddFlow(flow)
func (b *Bucket[Meta, K, V, R, S]) MidTime() int64 {
return (b.StartTime() + b.EndTime()) / 2
}

func NewAggregationBucket(start, end time.Time) *AggregationBucket {
return &AggregationBucket{
StartTime: start.Unix(),
EndTime: end.Unix(),
Flows: set.New[*types.DiachronicFlow](),
stats: newStatisticsIndex(),
}
func (b *Bucket[Meta, K, V, R, S]) EndTime() int64 {
return b.timeRing.indexToTime(b.timeRing.indexAdd(b.index, 1))
}

func (b *AggregationBucket) Fields() logrus.Fields {
func (b *Bucket[Meta, K, V, R, S]) Fields() logrus.Fields {
return logrus.Fields{
"start_time": b.StartTime,
"end_time": b.EndTime,
"flows": b.Flows.Len(),
"index": b.index,
"bucketLength": len(b.Windows),
}
}

func (b *AggregationBucket) Reset(start, end int64) {
b.StartTime = start
b.EndTime = end
b.Pushed = false
b.stats = newStatisticsIndex()
type ReadOnlyBucket[K comparable, V any, M Mergeable[V]] interface {
StartTime() int64
EndTime() int64
HasKey(key *K) bool
Value(key *K) V
}

if b.Flows == nil {
// When resetting a nil bucket, we need to initialize the Flows set.
b.Flows = set.New[*types.DiachronicFlow]()
} else {
// Otherwise, use the existing set but clear it.
b.Flows.Iter(func(item *types.DiachronicFlow) error {
b.Flows.Discard(item)
return nil
})
}
func (b *Bucket[Meta, K, V, R, S]) Value(key K) S {
return b.Windows[key]
}

func (b *AggregationBucket) QueryStatistics(q *proto.StatisticsRequest) map[StatisticsKey]*counts {
return b.stats.QueryStatistics(q)
func (b *Bucket[Meta, K, V, R, S]) HasKey(key K) bool {
_, ok := b.Windows[key]
return ok
}
Loading