forked from newrelic/node-newrelic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
prioritized-attributes.js
208 lines (171 loc) · 5.6 KB
/
prioritized-attributes.js
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
/*
* Copyright 2020 New Relic Corporation. All rights reserved.
* SPDX-License-Identifier: Apache-2.0
*/
'use strict'
const Config = require('./config')
const logger = require('./logger').child({ component: 'attributes' })
const isValidType = require('./util/attribute-types')
const byteUtils = require('./util/byte-limit')
const properties = require('./util/properties')
const ATTRIBUTE_PRIORITY = {
HIGH: Infinity,
LOW: -Infinity
}
class PrioritizedAttributes {
constructor(scope, limit = Infinity) {
this.filter = makeFilter(scope)
this.limit = limit
this.attributes = new Map()
}
isValidLength(str) {
return typeof str === 'number' || byteUtils.isValidLength(str, 255)
}
_set(destinations, key, value, truncateExempt, priority) {
this.attributes.set(key, { value, destinations, truncateExempt, priority })
}
get(dest) {
const attrs = Object.create(null)
for (const [key, attr] of this.attributes) {
if (!(attr.destinations & dest)) {
continue
}
attrs[key] =
typeof attr.value === 'string' && !attr.truncateExempt
? byteUtils.truncate(attr.value, 255)
: attr.value
}
return attrs
}
has(key) {
this.attributes.has(key)
}
reset() {
this.attributes = new Map()
}
addAttribute(
destinations,
key,
value,
truncateExempt = false,
priority = ATTRIBUTE_PRIORITY.HIGH
) {
const existingAttribute = this.attributes.get(key)
let droppableAttributeKey = null
if (!existingAttribute && this.attributes.size === this.limit) {
droppableAttributeKey = this._getDroppableAttributeKey(priority)
if (!droppableAttributeKey) {
logger.debug(
`Maximum number of custom attributes have been added.
Dropping attribute ${key} with ${value} type.`
)
return
}
}
if (existingAttribute && priority < existingAttribute.priority) {
logger.debug("incoming priority for '%s' is lower than existing, not updating.", key)
logger.trace(
'%s attribute retained value: %s, ignored value: %s',
key,
existingAttribute.value,
value
)
return
}
if (!isValidType(value)) {
logger.debug(
'Not adding attribute %s with %s value type. This is expected for undefined' +
'attributes and only an issue if an attribute is not expected to be undefined' +
'or not of the type expected.',
key,
typeof value
)
return
}
if (!this.isValidLength(key)) {
logger.warn('Length limit exceeded for attribute name, not adding: %s', key)
return
}
// Only set the attribute if at least one destination passed
const validDestinations = this.filter(destinations, key)
if (!validDestinations) {
return
}
if (droppableAttributeKey) {
logger.trace(
'dropping existing lower priority attribute %s ' + 'to add higher priority attribute %s',
droppableAttributeKey,
key
)
this.attributes.delete(droppableAttributeKey)
}
this._set(validDestinations, key, value, truncateExempt, priority)
}
addAttributes(destinations, attrs) {
for (const key in attrs) {
if (properties.hasOwn(attrs, key)) {
this.addAttribute(destinations, key, attrs[key])
}
}
}
/**
* Returns true if a given key is valid for any of the
* provided destinations.
*
* @param {DESTINATIONS} destinations
* @param {string} key
*/
hasValidDestination(destinations, key) {
const validDestinations = this.filter(destinations, key)
return !!validDestinations
}
_getDroppableAttributeKey(incomingPriority) {
// There will never be anything lower priority to drop
if (incomingPriority === ATTRIBUTE_PRIORITY.LOW) {
return null
}
this.lastFoundIndexCache = this.lastFoundIndexCache || Object.create(null)
const lastFoundIndex = this.lastFoundIndexCache[incomingPriority]
// We've already dropped all items lower than incomingPriority.
// We can honor the cache because at the point by which we've dropped
// all lower priority items, due to being at max capacity, there will never be another
// lower-priority item added. Lower priority items are unable to drop higher priority items.
if (lastFoundIndex === -1) {
return null
}
// We can't reverse iterate w/o creating an array that will iterate,
// so we just iterate forward stopping once we've checked the last cached index.
let lowerPriorityAttributeName = null
let foundIndex = -1
let index = 0
for (const [key, attribute] of this.attributes) {
// Don't search past last found lower priority item.
// At the point of dropping items for this priority,
// lower priority items will never be added.
if (lastFoundIndex && index > lastFoundIndex) {
break
}
if (attribute.priority < incomingPriority) {
lowerPriorityAttributeName = key
foundIndex = index
}
index++
}
// Item may not get dropped, so we simply store the index as
// an upper maximum and allow a future pass to clear out.
this.lastFoundIndexCache[incomingPriority] = foundIndex
return lowerPriorityAttributeName
}
}
function makeFilter(scope) {
const { attributeFilter } = Config.getInstance()
if (scope === 'transaction') {
return (d, k) => attributeFilter.filterTransaction(d, k)
} else if (scope === 'segment') {
return (d, k) => attributeFilter.filterSegment(d, k)
}
}
module.exports = {
PrioritizedAttributes: PrioritizedAttributes,
ATTRIBUTE_PRIORITY: ATTRIBUTE_PRIORITY
}