-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
option.go
123 lines (107 loc) · 3.99 KB
/
option.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Cilium
package observer
import (
"fmt"
"time"
"github.com/sirupsen/logrus"
"google.golang.org/grpc"
observerpb "github.com/cilium/cilium/api/v1/observer"
"github.com/cilium/cilium/pkg/hubble/relay/defaults"
poolTypes "github.com/cilium/cilium/pkg/hubble/relay/pool/types"
"github.com/cilium/cilium/pkg/logging"
"github.com/cilium/cilium/pkg/logging/logfields"
)
type observerClientBuilder interface {
observerClient(p *poolTypes.Peer) observerpb.ObserverClient
}
type defaultObserverClientBuilder struct{}
func (d defaultObserverClientBuilder) observerClient(p *poolTypes.Peer) observerpb.ObserverClient {
if p == nil {
return nil
}
if conn, ok := p.Conn.(*grpc.ClientConn); ok {
return observerpb.NewObserverClient(conn)
}
return nil
}
// DefaultOptions is the reference point for default values.
var defaultOptions = options{
sortBufferMaxLen: defaults.SortBufferMaxLen,
sortBufferDrainTimeout: defaults.SortBufferDrainTimeout,
errorAggregationWindow: defaults.ErrorAggregationWindow,
log: logging.DefaultLogger.WithField(logfields.LogSubsys, "hubble-relay"),
ocb: defaultObserverClientBuilder{},
}
// Option customizes the configuration of the Manager.
type Option func(o *options) error
// Options stores all the configuration values for peer manager.
type options struct {
sortBufferMaxLen int
sortBufferDrainTimeout time.Duration
errorAggregationWindow time.Duration
log logrus.FieldLogger
// this is not meant to be user configurable as it's only useful to
// override when testing
ocb observerClientBuilder
}
// WithSortBufferMaxLen sets the maximum number of flows that can be buffered
// for sorting before being sent to the client. The provided value must be
// greater than 0 and is to be understood per client request. Therefore, it is
// advised to keep the value moderate (a value between 30 and 100 should
// constitute a good choice in most cases).
func WithSortBufferMaxLen(i int) Option {
return func(o *options) error {
if i <= 0 {
return fmt.Errorf("value for SortBufferMaxLen must be greater than 0: %d", i)
}
o.sortBufferMaxLen = i
return nil
}
}
// WithSortBufferDrainTimeout sets the sort buffer drain timeout value. For
// flows requests where the total number of flows cannot be determined
// (typically for flows requests in follow mode), a flow is taken out of the
// buffer and sent to the client after duration d if the buffer is not full.
// This value must be greater than 0. Setting this value too low would render
// the flows sorting operation ineffective. A value between 500 milliseconds
// and 3 seconds should be constitute a good choice in most cases.
func WithSortBufferDrainTimeout(d time.Duration) Option {
return func(o *options) error {
if d <= 0 {
return fmt.Errorf("value for SortBufferDrainTimeout must be greater than 0: %d", d)
}
o.sortBufferDrainTimeout = d
return nil
}
}
// WithErrorAggregationWindow sets a time window during which errors with the
// same error message are coalesced. The aggregated error is forwarded to the
// downstream consumer either when the window expires or when a new, different
// error occurs (whichever happens first)
func WithErrorAggregationWindow(d time.Duration) Option {
return func(o *options) error {
if d <= 0 {
return fmt.Errorf("value for ErrorAggregationWindow must be greater than 0: %d", d)
}
o.errorAggregationWindow = d
return nil
}
}
// WithLogger sets the logger to use for logging.
func WithLogger(l logrus.FieldLogger) Option {
return func(o *options) error {
o.log = l
return nil
}
}
// withObserverClientBuilder sets the observerClientBuilder that is used to
// create a new ObserverClient from a poolTypes.ClientConn. This is private as
// it is only useful to override the default in the context of implemeting unit
// tests.
func withObserverClientBuilder(b observerClientBuilder) Option {
return func(o *options) error {
o.ocb = b
return nil
}
}