mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
0fe65e6bd2
* Add Valid method to KeyValue * Use KeyValue.Valid in attribute add on Span * Resource StringDetector errors for invalid attribute * Ignore invalid attr in NewWithAttributes The OpenTelemetry specification requires attributes conform to a standard evaluated and returned by attribute.KeyValue.Valid. To comply with the specification, Resources created from NewWithAttributes need to only contain valid attributes. This adds a check to ensure this and drops invalid attributes passed as arguments. * Add changes to changelog * Add nolint comment The attribute.Set is (possibly overly) optimized to avoid allocations. The returned value from the constructor is a value of a Set, not a pointer to the Set. A Set contains a lock value and pointer methods so passing the Set value raises the copylock go vet error. This copies the same nolint comment from the `NewSet` method this used to use. * Apply suggestions from code review Co-authored-by: Sam Xie <xsambundy@gmail.com> Co-authored-by: Sam Xie <xsambundy@gmail.com>
109 lines
3.0 KiB
Go
109 lines
3.0 KiB
Go
// 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 attribute // import "go.opentelemetry.io/otel/attribute"
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"reflect"
|
|
)
|
|
|
|
// KeyValue holds a key and value pair.
|
|
type KeyValue struct {
|
|
Key Key
|
|
Value Value
|
|
}
|
|
|
|
// Valid returns if kv is a valid OpenTelemetry attribute.
|
|
func (kv KeyValue) Valid() bool {
|
|
return kv.Key != "" && kv.Value.Type() != INVALID
|
|
}
|
|
|
|
// Bool creates a new key-value pair with a passed name and a bool
|
|
// value.
|
|
func Bool(k string, v bool) KeyValue {
|
|
return Key(k).Bool(v)
|
|
}
|
|
|
|
// Int64 creates a new key-value pair with a passed name and an int64
|
|
// value.
|
|
func Int64(k string, v int64) KeyValue {
|
|
return Key(k).Int64(v)
|
|
}
|
|
|
|
// Float64 creates a new key-value pair with a passed name and a float64
|
|
// value.
|
|
func Float64(k string, v float64) KeyValue {
|
|
return Key(k).Float64(v)
|
|
}
|
|
|
|
// String creates a new key-value pair with a passed name and a string
|
|
// value.
|
|
func String(k, v string) KeyValue {
|
|
return Key(k).String(v)
|
|
}
|
|
|
|
// Stringer creates a new key-value pair with a passed name and a string
|
|
// value generated by the passed Stringer interface.
|
|
func Stringer(k string, v fmt.Stringer) KeyValue {
|
|
return Key(k).String(v.String())
|
|
}
|
|
|
|
// Int creates a new key-value pair instance with a passed name and
|
|
// either an int32 or an int64 value, depending on whether the int
|
|
// type is 32 or 64 bits wide.
|
|
func Int(k string, v int) KeyValue {
|
|
return Key(k).Int(v)
|
|
}
|
|
|
|
// Array creates a new key-value pair with a passed name and a array.
|
|
// Only arrays of primitive type are supported.
|
|
func Array(k string, v interface{}) KeyValue {
|
|
return Key(k).Array(v)
|
|
}
|
|
|
|
// Any creates a new key-value pair instance with a passed name and
|
|
// automatic type inference. This is slower, and not type-safe.
|
|
func Any(k string, value interface{}) KeyValue {
|
|
if value == nil {
|
|
return String(k, "<nil>")
|
|
}
|
|
|
|
if stringer, ok := value.(fmt.Stringer); ok {
|
|
return String(k, stringer.String())
|
|
}
|
|
|
|
rv := reflect.ValueOf(value)
|
|
|
|
switch rv.Kind() {
|
|
case reflect.Array, reflect.Slice:
|
|
return Array(k, value)
|
|
case reflect.Bool:
|
|
return Bool(k, rv.Bool())
|
|
case reflect.Int, reflect.Int8, reflect.Int16:
|
|
return Int(k, int(rv.Int()))
|
|
case reflect.Int64:
|
|
return Int64(k, rv.Int())
|
|
case reflect.Float64:
|
|
return Float64(k, rv.Float())
|
|
case reflect.String:
|
|
return String(k, rv.String())
|
|
}
|
|
if b, err := json.Marshal(value); b != nil && err == nil {
|
|
return String(k, string(b))
|
|
}
|
|
return String(k, fmt.Sprint(value))
|
|
}
|