/
common.go
807 lines (719 loc) · 25.7 KB
/
common.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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
// Copyright The OpenTelemetry Authors
//
// 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 pdata
// This file contains data structures that are common for all telemetry types,
// such as timestamps, attributes, etc.
import (
"sort"
otlpcommon "go.opentelemetry.io/collector/internal/data/protogen/common/v1"
)
// AttributeValueType specifies the type of AttributeValue.
type AttributeValueType int
const (
AttributeValueNULL AttributeValueType = iota
AttributeValueSTRING
AttributeValueINT
AttributeValueDOUBLE
AttributeValueBOOL
AttributeValueMAP
AttributeValueARRAY
)
func (avt AttributeValueType) String() string {
switch avt {
case AttributeValueNULL:
return "NULL"
case AttributeValueSTRING:
return "STRING"
case AttributeValueBOOL:
return "BOOL"
case AttributeValueINT:
return "INT"
case AttributeValueDOUBLE:
return "DOUBLE"
case AttributeValueMAP:
return "MAP"
case AttributeValueARRAY:
return "ARRAY"
}
return ""
}
// AttributeValue represents a value of an attribute. Typically used in AttributeMap.
// Must use one of NewAttributeValue+ functions below to create new instances.
//
// Intended to be passed by value since internally it is just a pointer to actual
// value representation. For the same reason passing by value and calling setters
// will modify the original, e.g.:
//
// function f1(val AttributeValue) { val.SetIntVal(234) }
// function f2() {
// v := NewAttributeValueString("a string")
// f1(v)
// _ := v.Type() // this will return AttributeValueINT
// }
//
// Important: zero-initialized instance is not valid for use. All AttributeValue functions bellow must
// be called only on instances that are created via NewAttributeValue+ functions.
type AttributeValue struct {
orig *otlpcommon.AnyValue
}
func newAttributeValue(orig *otlpcommon.AnyValue) AttributeValue {
return AttributeValue{orig}
}
// NewAttributeValueNull creates a new AttributeValue with a null value.
func NewAttributeValueNull() AttributeValue {
orig := &otlpcommon.AnyValue{}
return AttributeValue{orig: orig}
}
// Deprecated: Use NewAttributeValueNull()
func NewAttributeValue() AttributeValue {
return NewAttributeValueNull()
}
// NewAttributeValueString creates a new AttributeValue with the given string value.
func NewAttributeValueString(v string) AttributeValue {
orig := &otlpcommon.AnyValue{Value: &otlpcommon.AnyValue_StringValue{StringValue: v}}
return AttributeValue{orig: orig}
}
// NewAttributeValueInt creates a new AttributeValue with the given int64 value.
func NewAttributeValueInt(v int64) AttributeValue {
orig := &otlpcommon.AnyValue{Value: &otlpcommon.AnyValue_IntValue{IntValue: v}}
return AttributeValue{orig: orig}
}
// NewAttributeValueDouble creates a new AttributeValue with the given float64 value.
func NewAttributeValueDouble(v float64) AttributeValue {
orig := &otlpcommon.AnyValue{Value: &otlpcommon.AnyValue_DoubleValue{DoubleValue: v}}
return AttributeValue{orig: orig}
}
// NewAttributeValueBool creates a new AttributeValue with the given bool value.
func NewAttributeValueBool(v bool) AttributeValue {
orig := &otlpcommon.AnyValue{Value: &otlpcommon.AnyValue_BoolValue{BoolValue: v}}
return AttributeValue{orig: orig}
}
// NewAttributeValueMap creates a new AttributeValue of map type.
func NewAttributeValueMap() AttributeValue {
orig := &otlpcommon.AnyValue{Value: &otlpcommon.AnyValue_KvlistValue{KvlistValue: &otlpcommon.KeyValueList{}}}
return AttributeValue{orig: orig}
}
// NewAttributeValueArray creates a new AttributeValue of array type.
func NewAttributeValueArray() AttributeValue {
orig := &otlpcommon.AnyValue{Value: &otlpcommon.AnyValue_ArrayValue{ArrayValue: &otlpcommon.ArrayValue{}}}
return AttributeValue{orig: orig}
}
// Type returns the type of the value for this AttributeValue.
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) Type() AttributeValueType {
if a.orig.Value == nil {
return AttributeValueNULL
}
switch a.orig.Value.(type) {
case *otlpcommon.AnyValue_StringValue:
return AttributeValueSTRING
case *otlpcommon.AnyValue_BoolValue:
return AttributeValueBOOL
case *otlpcommon.AnyValue_IntValue:
return AttributeValueINT
case *otlpcommon.AnyValue_DoubleValue:
return AttributeValueDOUBLE
case *otlpcommon.AnyValue_KvlistValue:
return AttributeValueMAP
case *otlpcommon.AnyValue_ArrayValue:
return AttributeValueARRAY
}
return AttributeValueNULL
}
// StringVal returns the string value associated with this AttributeValue.
// If the Type() is not AttributeValueSTRING then returns empty string.
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) StringVal() string {
return a.orig.GetStringValue()
}
// IntVal returns the int64 value associated with this AttributeValue.
// If the Type() is not AttributeValueINT then returns int64(0).
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) IntVal() int64 {
return a.orig.GetIntValue()
}
// DoubleVal returns the float64 value associated with this AttributeValue.
// If the Type() is not AttributeValueDOUBLE then returns float64(0).
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) DoubleVal() float64 {
return a.orig.GetDoubleValue()
}
// BoolVal returns the bool value associated with this AttributeValue.
// If the Type() is not AttributeValueBOOL then returns false.
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) BoolVal() bool {
return a.orig.GetBoolValue()
}
// MapVal returns the map value associated with this AttributeValue.
// If the Type() is not AttributeValueMAP then returns an empty map. Note that modifying
// such empty map has no effect on this AttributeValue.
//
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) MapVal() AttributeMap {
kvlist := a.orig.GetKvlistValue()
if kvlist == nil {
return NewAttributeMap()
}
return newAttributeMap(&kvlist.Values)
}
// ArrayVal returns the array value associated with this AttributeValue.
// If the Type() is not AttributeValueARRAY then returns an empty array. Note that modifying
// such empty array has no effect on this AttributeValue.
//
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) ArrayVal() AnyValueArray {
arr := a.orig.GetArrayValue()
if arr == nil {
return NewAnyValueArray()
}
return newAnyValueArray(&arr.Values)
}
// SetStringVal replaces the string value associated with this AttributeValue,
// it also changes the type to be AttributeValueSTRING.
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) SetStringVal(v string) {
a.orig.Value = &otlpcommon.AnyValue_StringValue{StringValue: v}
}
// SetIntVal replaces the int64 value associated with this AttributeValue,
// it also changes the type to be AttributeValueINT.
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) SetIntVal(v int64) {
a.orig.Value = &otlpcommon.AnyValue_IntValue{IntValue: v}
}
// SetDoubleVal replaces the float64 value associated with this AttributeValue,
// it also changes the type to be AttributeValueDOUBLE.
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) SetDoubleVal(v float64) {
a.orig.Value = &otlpcommon.AnyValue_DoubleValue{DoubleValue: v}
}
// SetBoolVal replaces the bool value associated with this AttributeValue,
// it also changes the type to be AttributeValueBOOL.
// Calling this function on zero-initialized AttributeValue will cause a panic.
func (a AttributeValue) SetBoolVal(v bool) {
a.orig.Value = &otlpcommon.AnyValue_BoolValue{BoolValue: v}
}
// copyTo copies the value to AnyValue. Will panic if dest is nil.
func (a AttributeValue) copyTo(dest *otlpcommon.AnyValue) {
switch v := a.orig.Value.(type) {
case *otlpcommon.AnyValue_KvlistValue:
kv, ok := dest.Value.(*otlpcommon.AnyValue_KvlistValue)
if !ok {
kv = &otlpcommon.AnyValue_KvlistValue{KvlistValue: &otlpcommon.KeyValueList{}}
dest.Value = kv
}
if v.KvlistValue == nil {
kv.KvlistValue = nil
return
}
// Deep copy to dest.
newAttributeMap(&v.KvlistValue.Values).CopyTo(newAttributeMap(&kv.KvlistValue.Values))
case *otlpcommon.AnyValue_ArrayValue:
av, ok := dest.Value.(*otlpcommon.AnyValue_ArrayValue)
if !ok {
av = &otlpcommon.AnyValue_ArrayValue{ArrayValue: &otlpcommon.ArrayValue{}}
dest.Value = av
}
if v.ArrayValue == nil {
av.ArrayValue = nil
return
}
// Deep copy to dest.
newAnyValueArray(&v.ArrayValue.Values).CopyTo(newAnyValueArray(&av.ArrayValue.Values))
default:
// Primitive immutable type, no need for deep copy.
dest.Value = a.orig.Value
}
}
func (a AttributeValue) CopyTo(dest AttributeValue) {
a.copyTo(dest.orig)
}
// Equal checks for equality, it returns true if the objects are equal otherwise false.
func (a AttributeValue) Equal(av AttributeValue) bool {
if a.orig == av.orig {
return true
}
if a.orig.Value == nil || av.orig.Value == nil {
return a.orig.Value == av.orig.Value
}
switch v := a.orig.Value.(type) {
case *otlpcommon.AnyValue_StringValue:
return v.StringValue == av.orig.GetStringValue()
case *otlpcommon.AnyValue_BoolValue:
return v.BoolValue == av.orig.GetBoolValue()
case *otlpcommon.AnyValue_IntValue:
return v.IntValue == av.orig.GetIntValue()
case *otlpcommon.AnyValue_DoubleValue:
return v.DoubleValue == av.orig.GetDoubleValue()
case *otlpcommon.AnyValue_ArrayValue:
vv := v.ArrayValue.GetValues()
avv := av.orig.GetArrayValue().GetValues()
if len(vv) != len(avv) {
return false
}
for i, val := range avv {
val := val
av := newAttributeValue(&vv[i])
// According to the specification, array values must be scalar.
if avType := av.Type(); avType == AttributeValueARRAY || avType == AttributeValueMAP {
return false
}
if !av.Equal(newAttributeValue(&val)) {
return false
}
}
return true
}
// TODO: handle MAP data type
return false
}
func newAttributeKeyValueString(k string, v string) otlpcommon.KeyValue {
orig := otlpcommon.KeyValue{Key: k}
akv := AttributeValue{&orig.Value}
akv.SetStringVal(v)
return orig
}
func newAttributeKeyValueInt(k string, v int64) otlpcommon.KeyValue {
orig := otlpcommon.KeyValue{Key: k}
akv := AttributeValue{&orig.Value}
akv.SetIntVal(v)
return orig
}
func newAttributeKeyValueDouble(k string, v float64) otlpcommon.KeyValue {
orig := otlpcommon.KeyValue{Key: k}
akv := AttributeValue{&orig.Value}
akv.SetDoubleVal(v)
return orig
}
func newAttributeKeyValueBool(k string, v bool) otlpcommon.KeyValue {
orig := otlpcommon.KeyValue{Key: k}
akv := AttributeValue{&orig.Value}
akv.SetBoolVal(v)
return orig
}
func newAttributeKeyValueNull(k string) otlpcommon.KeyValue {
orig := otlpcommon.KeyValue{Key: k}
return orig
}
func newAttributeKeyValue(k string, av AttributeValue) otlpcommon.KeyValue {
orig := otlpcommon.KeyValue{Key: k}
av.copyTo(&orig.Value)
return orig
}
// AttributeMap stores a map of attribute keys to values.
type AttributeMap struct {
orig *[]otlpcommon.KeyValue
}
// NewAttributeMap creates a AttributeMap with 0 elements.
func NewAttributeMap() AttributeMap {
orig := []otlpcommon.KeyValue(nil)
return AttributeMap{&orig}
}
func newAttributeMap(orig *[]otlpcommon.KeyValue) AttributeMap {
return AttributeMap{orig}
}
// InitFromMap overwrites the entire AttributeMap and reconstructs the AttributeMap
// with values from the given map[string]string.
//
// Returns the same instance to allow nicer code like:
// assert.EqualValues(t, NewAttributeMap().InitFromMap(map[string]AttributeValue{...}), actual)
func (am AttributeMap) InitFromMap(attrMap map[string]AttributeValue) AttributeMap {
if len(attrMap) == 0 {
*am.orig = []otlpcommon.KeyValue(nil)
return am
}
origs := make([]otlpcommon.KeyValue, len(attrMap))
ix := 0
for k, v := range attrMap {
origs[ix].Key = k
v.copyTo(&origs[ix].Value)
ix++
}
*am.orig = origs
return am
}
// InitEmptyWithCapacity constructs an empty AttributeMap with predefined slice capacity.
func (am AttributeMap) InitEmptyWithCapacity(cap int) {
if cap == 0 {
*am.orig = []otlpcommon.KeyValue(nil)
return
}
*am.orig = make([]otlpcommon.KeyValue, 0, cap)
}
// Get returns the AttributeValue associated with the key and true. Returned
// AttributeValue is not a copy, it is a reference to the value stored in this map.
// It is allowed to modify the returned value using AttributeValue.Set* functions.
// Such modification will be applied to the value stored in this map.
//
// If the key does not exist returns an invalid instance of the KeyValue and false.
// Calling any functions on the returned invalid instance will cause a panic.
func (am AttributeMap) Get(key string) (AttributeValue, bool) {
for i := range *am.orig {
akv := &(*am.orig)[i]
if akv.Key == key {
return AttributeValue{&akv.Value}, true
}
}
return AttributeValue{nil}, false
}
// Delete deletes the entry associated with the key and returns true if the key
// was present in the map, otherwise returns false.
func (am AttributeMap) Delete(key string) bool {
for i := range *am.orig {
akv := &(*am.orig)[i]
if akv.Key == key {
*akv = (*am.orig)[len(*am.orig)-1]
*am.orig = (*am.orig)[:len(*am.orig)-1]
return true
}
}
return false
}
// Insert adds the AttributeValue to the map when the key does not exist.
// No action is applied to the map where the key already exists.
//
// Calling this function with a zero-initialized AttributeValue struct will cause a panic.
//
// Important: this function should not be used if the caller has access to
// the raw value to avoid an extra allocation.
func (am AttributeMap) Insert(k string, v AttributeValue) {
if _, existing := am.Get(k); !existing {
*am.orig = append(*am.orig, newAttributeKeyValue(k, v))
}
}
// InsertNull adds a null Value to the map when the key does not exist.
// No action is applied to the map where the key already exists.
func (am AttributeMap) InsertNull(k string) {
if _, existing := am.Get(k); !existing {
*am.orig = append(*am.orig, newAttributeKeyValueNull(k))
}
}
// InsertString adds the string Value to the map when the key does not exist.
// No action is applied to the map where the key already exists.
func (am AttributeMap) InsertString(k string, v string) {
if _, existing := am.Get(k); !existing {
*am.orig = append(*am.orig, newAttributeKeyValueString(k, v))
}
}
// InsertInt adds the int Value to the map when the key does not exist.
// No action is applied to the map where the key already exists.
func (am AttributeMap) InsertInt(k string, v int64) {
if _, existing := am.Get(k); !existing {
*am.orig = append(*am.orig, newAttributeKeyValueInt(k, v))
}
}
// InsertDouble adds the double Value to the map when the key does not exist.
// No action is applied to the map where the key already exists.
func (am AttributeMap) InsertDouble(k string, v float64) {
if _, existing := am.Get(k); !existing {
*am.orig = append(*am.orig, newAttributeKeyValueDouble(k, v))
}
}
// InsertBool adds the bool Value to the map when the key does not exist.
// No action is applied to the map where the key already exists.
func (am AttributeMap) InsertBool(k string, v bool) {
if _, existing := am.Get(k); !existing {
*am.orig = append(*am.orig, newAttributeKeyValueBool(k, v))
}
}
// Update updates an existing AttributeValue with a value.
// No action is applied to the map where the key does not exist.
//
// Calling this function with a zero-initialized AttributeValue struct will cause a panic.
//
// Important: this function should not be used if the caller has access to
// the raw value to avoid an extra allocation.
func (am AttributeMap) Update(k string, v AttributeValue) {
if av, existing := am.Get(k); existing {
v.copyTo(av.orig)
}
}
// UpdateString updates an existing string Value with a value.
// No action is applied to the map where the key does not exist.
func (am AttributeMap) UpdateString(k string, v string) {
if av, existing := am.Get(k); existing {
av.SetStringVal(v)
}
}
// UpdateInt updates an existing int Value with a value.
// No action is applied to the map where the key does not exist.
func (am AttributeMap) UpdateInt(k string, v int64) {
if av, existing := am.Get(k); existing {
av.SetIntVal(v)
}
}
// UpdateDouble updates an existing double Value with a value.
// No action is applied to the map where the key does not exist.
func (am AttributeMap) UpdateDouble(k string, v float64) {
if av, existing := am.Get(k); existing {
av.SetDoubleVal(v)
}
}
// UpdateBool updates an existing bool Value with a value.
// No action is applied to the map where the key does not exist.
func (am AttributeMap) UpdateBool(k string, v bool) {
if av, existing := am.Get(k); existing {
av.SetBoolVal(v)
}
}
// Upsert performs the Insert or Update action. The AttributeValue is
// insert to the map that did not originally have the key. The key/value is
// updated to the map where the key already existed.
//
// Calling this function with a zero-initialized AttributeValue struct will cause a panic.
//
// Important: this function should not be used if the caller has access to
// the raw value to avoid an extra allocation.
func (am AttributeMap) Upsert(k string, v AttributeValue) {
if av, existing := am.Get(k); existing {
v.copyTo(av.orig)
} else {
*am.orig = append(*am.orig, newAttributeKeyValue(k, v))
}
}
// UpsertString performs the Insert or Update action. The AttributeValue is
// insert to the map that did not originally have the key. The key/value is
// updated to the map where the key already existed.
func (am AttributeMap) UpsertString(k string, v string) {
if av, existing := am.Get(k); existing {
av.SetStringVal(v)
} else {
*am.orig = append(*am.orig, newAttributeKeyValueString(k, v))
}
}
// UpsertInt performs the Insert or Update action. The int Value is
// insert to the map that did not originally have the key. The key/value is
// updated to the map where the key already existed.
func (am AttributeMap) UpsertInt(k string, v int64) {
if av, existing := am.Get(k); existing {
av.SetIntVal(v)
} else {
*am.orig = append(*am.orig, newAttributeKeyValueInt(k, v))
}
}
// UpsertDouble performs the Insert or Update action. The double Value is
// insert to the map that did not originally have the key. The key/value is
// updated to the map where the key already existed.
func (am AttributeMap) UpsertDouble(k string, v float64) {
if av, existing := am.Get(k); existing {
av.SetDoubleVal(v)
} else {
*am.orig = append(*am.orig, newAttributeKeyValueDouble(k, v))
}
}
// UpsertBool performs the Insert or Update action. The bool Value is
// insert to the map that did not originally have the key. The key/value is
// updated to the map where the key already existed.
func (am AttributeMap) UpsertBool(k string, v bool) {
if av, existing := am.Get(k); existing {
av.SetBoolVal(v)
} else {
*am.orig = append(*am.orig, newAttributeKeyValueBool(k, v))
}
}
// Sort sorts the entries in the AttributeMap so two instances can be compared.
// Returns the same instance to allow nicer code like:
// assert.EqualValues(t, expected.Sort(), actual.Sort())
func (am AttributeMap) Sort() AttributeMap {
// Intention is to move the nil values at the end.
sort.SliceStable(*am.orig, func(i, j int) bool {
return (*am.orig)[i].Key < (*am.orig)[j].Key
})
return am
}
// Len returns the length of this map.
//
// Because the AttributeMap is represented internally by a slice of pointers, and the data are comping from the wire,
// it is possible that when iterating using "ForEach" to get access to fewer elements because nil elements are skipped.
func (am AttributeMap) Len() int {
return len(*am.orig)
}
// ForEach iterates over the every elements in the map by calling the provided func.
//
// Example:
//
// it := sm.ForEach(func(k string, v AttributeValue) {
// ...
// })
func (am AttributeMap) ForEach(f func(k string, v AttributeValue)) {
for i := range *am.orig {
kv := &(*am.orig)[i]
f(kv.Key, AttributeValue{&kv.Value})
}
}
// CopyTo copies all elements from the current map to the dest.
func (am AttributeMap) CopyTo(dest AttributeMap) {
newLen := len(*am.orig)
oldCap := cap(*dest.orig)
if newLen <= oldCap {
// New slice fits in existing slice, no need to reallocate.
*dest.orig = (*dest.orig)[:newLen:oldCap]
for i := range *am.orig {
akv := &(*am.orig)[i]
destAkv := &(*dest.orig)[i]
destAkv.Key = akv.Key
AttributeValue{&akv.Value}.copyTo(&destAkv.Value)
}
return
}
// New slice is bigger than exist slice. Allocate new space.
origs := make([]otlpcommon.KeyValue, len(*am.orig))
for i := range *am.orig {
akv := &(*am.orig)[i]
origs[i].Key = akv.Key
AttributeValue{&akv.Value}.copyTo(&origs[i].Value)
}
*dest.orig = origs
}
// StringMap stores a map of attribute keys to values.
type StringMap struct {
orig *[]otlpcommon.StringKeyValue
}
// NewStringMap creates a StringMap with 0 elements.
func NewStringMap() StringMap {
orig := []otlpcommon.StringKeyValue(nil)
return StringMap{&orig}
}
func newStringMap(orig *[]otlpcommon.StringKeyValue) StringMap {
return StringMap{orig}
}
// InitFromMap overwrites the entire StringMap and reconstructs the StringMap
// with values from the given map[string]string.
//
// Returns the same instance to allow nicer code like:
// assert.EqualValues(t, NewStringMap().InitFromMap(map[string]string{...}), actual)
func (sm StringMap) InitFromMap(attrMap map[string]string) StringMap {
if len(attrMap) == 0 {
*sm.orig = []otlpcommon.StringKeyValue(nil)
return sm
}
origs := make([]otlpcommon.StringKeyValue, len(attrMap))
ix := 0
for k, v := range attrMap {
origs[ix].Key = k
origs[ix].Value = v
ix++
}
*sm.orig = origs
return sm
}
// InitEmptyWithCapacity constructs an empty StringMap with predefined slice capacity.
func (sm StringMap) InitEmptyWithCapacity(cap int) {
if cap == 0 {
*sm.orig = []otlpcommon.StringKeyValue(nil)
return
}
*sm.orig = make([]otlpcommon.StringKeyValue, 0, cap)
}
// Get returns the StringValue associated with the key and true,
// otherwise an invalid instance of the StringKeyValue and false.
// Calling any functions on the returned invalid instance will cause a panic.
func (sm StringMap) Get(k string) (string, bool) {
skv, found := sm.get(k)
// GetValue handles the case where skv is nil.
return skv.GetValue(), found
}
// Delete deletes the entry associated with the key and returns true if the key
// was present in the map, otherwise returns false.
func (sm StringMap) Delete(k string) bool {
for i := range *sm.orig {
skv := &(*sm.orig)[i]
if skv.Key == k {
(*sm.orig)[i] = (*sm.orig)[len(*sm.orig)-1]
*sm.orig = (*sm.orig)[:len(*sm.orig)-1]
return true
}
}
return false
}
// Insert adds the string value to the map when the key does not exist.
// No action is applied to the map where the key already exists.
func (sm StringMap) Insert(k, v string) {
if _, existing := sm.Get(k); !existing {
*sm.orig = append(*sm.orig, newStringKeyValue(k, v))
}
}
// Update updates an existing string value with a value.
// No action is applied to the map where the key does not exist.
func (sm StringMap) Update(k, v string) {
if skv, existing := sm.get(k); existing {
skv.Value = v
}
}
// Upsert performs the Insert or Update action. The string value is
// insert to the map that did not originally have the key. The key/value is
// updated to the map where the key already existed.
func (sm StringMap) Upsert(k, v string) {
if skv, existing := sm.get(k); existing {
skv.Value = v
} else {
*sm.orig = append(*sm.orig, newStringKeyValue(k, v))
}
}
// Len returns the length of this map.
//
// Because the AttributeMap is represented internally by a slice of pointers, and the data are comping from the wire,
// it is possible that when iterating using "ForEach" to get access to fewer elements because nil elements are skipped.
func (sm StringMap) Len() int {
return len(*sm.orig)
}
// ForEach iterates over the every elements in the map by calling the provided func.
//
// Example:
//
// it := sm.ForEach(func(k string, v StringValue) {
// ...
// })
func (sm StringMap) ForEach(f func(k string, v string)) {
for i := range *sm.orig {
skv := &(*sm.orig)[i]
f(skv.Key, skv.Value)
}
}
// CopyTo copies all elements from the current map to the dest.
func (sm StringMap) CopyTo(dest StringMap) {
newLen := len(*sm.orig)
oldCap := cap(*dest.orig)
if newLen <= oldCap {
*dest.orig = (*dest.orig)[:newLen:oldCap]
} else {
*dest.orig = make([]otlpcommon.StringKeyValue, newLen)
}
for i := range *sm.orig {
skv := &(*sm.orig)[i]
(*dest.orig)[i].Key = skv.Key
(*dest.orig)[i].Value = skv.Value
}
}
func (sm StringMap) get(k string) (*otlpcommon.StringKeyValue, bool) {
for i := range *sm.orig {
skv := &(*sm.orig)[i]
if skv.Key == k {
return skv, true
}
}
return nil, false
}
// Sort sorts the entries in the StringMap so two instances can be compared.
// Returns the same instance to allow nicer code like:
// assert.EqualValues(t, expected.Sort(), actual.Sort())
func (sm StringMap) Sort() StringMap {
sort.SliceStable(*sm.orig, func(i, j int) bool {
// Intention is to move the nil values at the end.
return (*sm.orig)[i].Key < (*sm.orig)[j].Key
})
return sm
}
func newStringKeyValue(k, v string) otlpcommon.StringKeyValue {
return otlpcommon.StringKeyValue{Key: k, Value: v}
}