-
Notifications
You must be signed in to change notification settings - Fork 119
/
centralized_sampling_rule_manifest.go
294 lines (235 loc) · 7.47 KB
/
centralized_sampling_rule_manifest.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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
// Copyright 2017-2017 Amazon.com, Inc. or its affiliates. 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. A copy of the License is located at
//
// http://aws.amazon.com/apache2.0/
//
// or in the "license" file accompanying this file. This file 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 sampling
import (
"fmt"
"sort"
"strings"
"sync"
xraySvc "github.com/aws/aws-sdk-go/service/xray"
"github.com/aws/aws-xray-sdk-go/utils"
)
const defaultRule = "Default"
const defaultInterval = int64(10)
const manifestTTL = 3600 // Seconds
// CentralizedManifest represents a full sampling ruleset, with a list of
// custom rules and default values for incoming requests that do
// not match any of the provided rules.
type CentralizedManifest struct {
Default *CentralizedRule
Rules []*CentralizedRule
Index map[string]*CentralizedRule
refreshedAt int64
clock utils.Clock
mu sync.RWMutex
}
// putRule updates the named rule if it already exists or creates it if it does not.
// May break ordering of the sorted rules array if it creates a new rule.
func (m *CentralizedManifest) putRule(svcRule *xraySvc.SamplingRule) (r *CentralizedRule, err error) {
defer func() {
if x := recover(); x != nil {
err = fmt.Errorf("%v", x)
}
}()
name := *svcRule.RuleName
// Default rule
if name == defaultRule {
m.mu.RLock()
r = m.Default
m.mu.RUnlock()
// Update rule if already exists
if r != nil {
m.updateDefaultRule(svcRule)
return
}
// Create Default rule
r = m.createDefaultRule(svcRule)
return
}
// User-defined rule
m.mu.RLock()
r, ok := m.Index[name]
m.mu.RUnlock()
// Create rule if it does not exist
if !ok {
r = m.createUserRule(svcRule)
return
}
// Update existing rule
m.updateUserRule(r, svcRule)
return
}
// createUserRule creates a user-defined CentralizedRule, appends it to the sorted array,
// adds it to the index, and returns the newly created rule.
// Appends new rule to the sorted array which may break its ordering.
// Panics if svcRule contains nil pointers
func (m *CentralizedManifest) createUserRule(svcRule *xraySvc.SamplingRule) *CentralizedRule {
// Create CentralizedRule from xraySvc.SamplingRule
clock := &utils.DefaultClock{}
rand := &utils.DefaultRand{}
p := &Properties{
ServiceName: *svcRule.ServiceName,
HTTPMethod: *svcRule.HTTPMethod,
URLPath: *svcRule.URLPath,
FixedTarget: *svcRule.ReservoirSize,
Rate: *svcRule.FixedRate,
Host: *svcRule.Host,
}
r := &reservoir{
capacity: *svcRule.ReservoirSize,
}
cr := &CentralizedReservoir{
reservoir: r,
interval: defaultInterval,
}
csr := &CentralizedRule{
ruleName: *svcRule.RuleName,
priority: *svcRule.Priority,
reservoir: cr,
Properties: p,
serviceType: *svcRule.ServiceType,
resourceARN: *svcRule.ResourceARN,
attributes: svcRule.Attributes,
clock: clock,
rand: rand,
}
m.mu.Lock()
defer m.mu.Unlock()
// Return early if rule already exists
if r, ok := m.Index[*svcRule.RuleName]; ok {
return r
}
// Update sorted array
m.Rules = append(m.Rules, csr)
// Update index
m.Index[*svcRule.RuleName] = csr
return csr
}
// updateUserRule updates the properties of the user-defined CentralizedRule using the given
// xraySvc.SamplingRule.
// Panics if svcRule contains nil pointers.
func (m *CentralizedManifest) updateUserRule(r *CentralizedRule, svcRule *xraySvc.SamplingRule) {
// Preemptively dereference xraySvc.SamplingRule fields and panic early on nil pointers.
// A panic in the middle of an update may leave the rule in an inconsistent state.
pr := &Properties{
ServiceName: *svcRule.ServiceName,
HTTPMethod: *svcRule.HTTPMethod,
URLPath: *svcRule.URLPath,
FixedTarget: *svcRule.ReservoirSize,
Rate: *svcRule.FixedRate,
Host: *svcRule.Host,
}
p, c := *svcRule.Priority, *svcRule.ReservoirSize
r.mu.Lock()
defer r.mu.Unlock()
r.Properties = pr
r.priority = p
r.reservoir.capacity = c
r.serviceType = *svcRule.ServiceType
r.resourceARN = *svcRule.ResourceARN
r.attributes = svcRule.Attributes
}
// createDefaultRule creates a default CentralizedRule and adds it to the manifest.
// Panics if svcRule contains nil values for FixedRate and ReservoirSize.
func (m *CentralizedManifest) createDefaultRule(svcRule *xraySvc.SamplingRule) *CentralizedRule {
// Create CentralizedRule from xraySvc.SamplingRule
clock := &utils.DefaultClock{}
rand := &utils.DefaultRand{}
p := &Properties{
FixedTarget: *svcRule.ReservoirSize,
Rate: *svcRule.FixedRate,
}
r := &reservoir{
capacity: *svcRule.ReservoirSize,
}
cr := &CentralizedReservoir{
reservoir: r,
interval: defaultInterval,
}
csr := &CentralizedRule{
ruleName: *svcRule.RuleName,
reservoir: cr,
Properties: p,
clock: clock,
rand: rand,
}
m.mu.Lock()
defer m.mu.Unlock()
// Return early if rule already exists
if d := m.Default; d != nil {
return d
}
// Update manifest if rule does not exist
m.Default = csr
// Update index
m.Index[*svcRule.RuleName] = csr
return csr
}
// updateDefaultRule updates the properties of the default CentralizedRule using the given
// xraySvc.SamplingRule.
// Panics if svcRule contains nil values for FixedRate and ReservoirSize.
func (m *CentralizedManifest) updateDefaultRule(svcRule *xraySvc.SamplingRule) {
r := m.Default
// Preemptively dereference xraySvc.SamplingRule fields and panic early on nil pointers.
// A panic in the middle of an update may leave the rule in an inconsistent state.
p := &Properties{
FixedTarget: *svcRule.ReservoirSize,
Rate: *svcRule.FixedRate,
}
c := *svcRule.ReservoirSize
r.mu.Lock()
defer r.mu.Unlock()
r.Properties = p
r.reservoir.capacity = c
}
// prune removes all rules in the manifest not present in the given list of active rules.
// Preserves ordering of sorted array.
func (m *CentralizedManifest) prune(actives map[*CentralizedRule]bool) {
m.mu.Lock()
defer m.mu.Unlock()
// Iterate in reverse order to avoid adjusting index for each deleted rule
for i := len(m.Rules) - 1; i >= 0; i-- {
r := m.Rules[i]
if _, ok := actives[r]; !ok {
m.deleteRule(i)
}
}
}
// deleteRule deletes the rule from the array, and the index.
// Assumes write lock is already held.
// Preserves ordering of sorted array.
func (m *CentralizedManifest) deleteRule(idx int) {
// Remove from index
delete(m.Index, m.Rules[idx].ruleName)
// Delete by reslicing without index
a := append(m.Rules[:idx], m.Rules[idx+1:]...)
// Set pointer to nil to free capacity from underlying array
m.Rules[len(m.Rules)-1] = nil
// Assign resliced rules
m.Rules = a
}
// sort sorts the rule array first by priority and then by rule name.
func (m *CentralizedManifest) sort() {
// Comparison function
less := func(i, j int) bool {
if m.Rules[i].priority == m.Rules[j].priority {
return strings.Compare(m.Rules[i].ruleName, m.Rules[j].ruleName) < 0
}
return m.Rules[i].priority < m.Rules[j].priority
}
m.mu.Lock()
defer m.mu.Unlock()
sort.Slice(m.Rules, less)
}
// expired returns true if the manifest has not been successfully refreshed in
// 'manifestTTL' seconds.
func (m *CentralizedManifest) expired() bool {
m.mu.RLock()
defer m.mu.RUnlock()
return m.refreshedAt < m.clock.Now().Unix()-manifestTTL
}