-
Notifications
You must be signed in to change notification settings - Fork 1
/
orchestrator.go
163 lines (144 loc) · 6.09 KB
/
orchestrator.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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
package obykeyset
import (
"strings"
"time"
"github.com/relex/gotils/logger"
"github.com/relex/gotils/promexporter/promreg"
"github.com/relex/slog-agent/base"
"github.com/relex/slog-agent/defs"
"github.com/relex/slog-agent/orchestrate/obase"
"github.com/relex/slog-agent/util/localcachedmap"
)
// byKeySetOrchestrator is used to ensure fair sharing of CPU resource among logs of different key sets,
//
// e.g. using "level" as key field allows priority processing of error logs when there are massive amounts of debug logs before them
//
// A per-connection version has been tried and abandoned because a client may create a new connection after the old one dies, and both need to share info here
type byKeySetOrchestrator struct {
logger logger.Logger
workerMap *localcachedmap.GlobalCachedMap[chan<- []*base.LogRecord, *channelInputBuffer] // append-only global map of merged keys => worker channel
keyLocators []base.LogFieldLocator
tagBuilder *obase.TagBuilder // builder to construct tag from keys, used when protected by globalPipelineChannelMap's mutex
metricCreator promreg.MetricCreator
metricKeyNames []string
startPipeline obase.PipelineStarter // start workers for new pipeline (one per key-set), invoked within globalPipelineChannelMap's mutex
}
// byKeySetOrchestratorSink is created for each of input sessions or incoming connections
//
// It holds local buffer of pending logs to a set of global channels to backend workers, used by this input sink and flushes on demand
type byKeySetOrchestratorSink struct {
logger logger.Logger
workerMap *localcachedmap.LocalCachedMap[chan<- []*base.LogRecord, *channelInputBuffer] // append-only locac cache of byKeySetOrchestrator.workerMap
keySetExtractor base.FieldSetExtractor // extractor to fetch keys from LogRecord(s)
}
// NewOrchestrator creates an Orchestrator to distribute logs to different pipelines by unique combinations of key labels (key set)
func NewOrchestrator(parentLogger logger.Logger, schema base.LogSchema, keyFields []string, tagTemplate string,
metricCreator promreg.MetricCreator, startPipeline obase.PipelineStarter, initialPipelineIDs []string,
) base.Orchestrator {
ologger := parentLogger.WithField(defs.LabelComponent, "ByKeySetOrchestrator")
keyLocators, lerr := schema.CreateFieldLocators(keyFields)
if lerr != nil {
ologger.Panicf("keyFields: %s", lerr.Error())
}
tagBuilder, terr := obase.NewTagBuilder(tagTemplate, keyFields)
if terr != nil {
ologger.Panicf("tagTemplate: %s", terr.Error())
}
metricKeyNames := make([]string, len(keyFields))
for i, key := range keyFields {
metricKeyNames[i] = "key_" + key
}
o := &byKeySetOrchestrator{
logger: ologger,
workerMap: nil,
keyLocators: keyLocators,
tagBuilder: tagBuilder,
metricCreator: metricCreator,
metricKeyNames: metricKeyNames,
startPipeline: startPipeline,
}
o.workerMap = localcachedmap.NewGlobalMap(
o.newPipeline,
func(ch chan<- []*base.LogRecord) { close(ch) },
newInputBufferForChannel,
)
if len(initialPipelineIDs) > 0 {
localMap := o.workerMap.MakeLocalMap()
onCreating := func([]string) {}
for _, pipelineID := range initialPipelineIDs {
keys := strings.Split(pipelineID, ",")
if len(keys) != len(keyFields) {
// FIXME: deal with new keys, shorter old keys should be okay
ologger.Warnf("ignore malformed existing pipeline ID: %s", pipelineID)
continue
}
localMap.GetOrCreate(keys, onCreating)
}
}
return o
}
func (o *byKeySetOrchestrator) NewSink(clientAddress string, clientNumber base.ClientNumber) base.BufferReceiverSink {
return &byKeySetOrchestratorSink{
logger: base.NewSinkLogger(o.logger, clientAddress, clientNumber),
workerMap: o.workerMap.MakeLocalMap(),
keySetExtractor: *base.NewFieldSetExtractor(o.keyLocators),
}
}
func (o *byKeySetOrchestrator) Shutdown() {
o.logger.Infof("shutting down pipeline workers count=%d", o.workerMap.PeekNumObjects())
o.workerMap.Destroy()
o.logger.Info("shut down all pipeline workers")
}
// newPipeline creates channel and pipeline workers for a new key-set, must be protected by global mutex
func (o *byKeySetOrchestrator) newPipeline(keys []string, onStopped func()) chan<- []*base.LogRecord {
outputTag := o.tagBuilder.Build(keys)
workerID := strings.Join(keys, ",")
inputChannel := make(chan []*base.LogRecord, defs.IntermediateBufferedChannelSize)
pipelineLogger := o.logger.WithField(defs.LabelName, workerID)
pipelineLogger.Infof("new pipeline tag=%s", outputTag)
pipelineMetricCreator := o.metricCreator.AddOrGetPrefix(
"process_",
append([]string{"orchestrator"}, o.metricKeyNames...),
append([]string{"byKeySet"}, keys...),
)
o.startPipeline(pipelineLogger, pipelineMetricCreator, inputChannel, workerID, outputTag, onStopped)
return inputChannel
}
// Accept accepts input logs from LogInput, the buffer is only usable within the function
func (oc *byKeySetOrchestratorSink) Accept(buffer []*base.LogRecord) {
now := time.Now()
keySetExtractor := oc.keySetExtractor
workerMap := oc.workerMap
for _, record := range buffer {
tempKeySet := keySetExtractor.Extract(record)
cache := workerMap.GetOrCreate(tempKeySet, oc.onNewLinkToPipeline)
if cache.Append(record) {
cache.Flush(now, oc.logger, tempKeySet)
}
}
}
// Tick renews internal timeout timer
func (oc *byKeySetOrchestratorSink) Tick() {
oc.flushAllLocalBuffers(false)
}
// Close flushes all pending logs
func (oc *byKeySetOrchestratorSink) Close() {
oc.logger.Info("close")
oc.flushAllLocalBuffers(true)
}
func (oc *byKeySetOrchestratorSink) onNewLinkToPipeline(permKeys []string) {
workerID := strings.Join(permKeys, ",")
oc.logger.WithField(defs.LabelName, workerID).Info("creating new link from input to pipeline worker")
}
func (oc *byKeySetOrchestratorSink) flushAllLocalBuffers(forceAll bool) {
now := time.Now()
oc.workerMap.Walk(func(mergedKey string, cache *channelInputBuffer) {
if len(cache.PendingLogs) == 0 {
return
}
if !forceAll && now.Sub(cache.LastFlushTime) < defs.IntermediateFlushInterval {
return
}
cache.Flush(now, oc.logger, mergedKey)
})
}