2022-11-29 21:53:28 +00:00
|
|
|
// 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"
|
2022-11-30 05:03:57 +00:00
|
|
|
"reflect"
|
2022-11-29 21:53:28 +00:00
|
|
|
"strconv"
|
|
|
|
|
|
|
|
"go.opentelemetry.io/otel/internal"
|
2022-11-30 05:03:57 +00:00
|
|
|
"go.opentelemetry.io/otel/internal/attribute"
|
2022-11-29 21:53:28 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
//go:generate stringer -type=Type
|
|
|
|
|
|
|
|
// Type describes the type of the data Value holds.
|
|
|
|
type Type int // nolint: revive // redefines builtin Type.
|
|
|
|
|
|
|
|
// Value represents the value part in key-value pairs.
|
|
|
|
type Value struct {
|
|
|
|
vtype Type
|
|
|
|
numeric uint64
|
|
|
|
stringly string
|
|
|
|
slice interface{}
|
|
|
|
}
|
|
|
|
|
|
|
|
const (
|
|
|
|
// INVALID is used for a Value with no value set.
|
|
|
|
INVALID Type = iota
|
|
|
|
// BOOL is a boolean Type Value.
|
|
|
|
BOOL
|
|
|
|
// INT64 is a 64-bit signed integral Type Value.
|
|
|
|
INT64
|
|
|
|
// FLOAT64 is a 64-bit floating point Type Value.
|
|
|
|
FLOAT64
|
|
|
|
// STRING is a string Type Value.
|
|
|
|
STRING
|
|
|
|
// BOOLSLICE is a slice of booleans Type Value.
|
|
|
|
BOOLSLICE
|
|
|
|
// INT64SLICE is a slice of 64-bit signed integral numbers Type Value.
|
|
|
|
INT64SLICE
|
|
|
|
// FLOAT64SLICE is a slice of 64-bit floating point numbers Type Value.
|
|
|
|
FLOAT64SLICE
|
|
|
|
// STRINGSLICE is a slice of strings Type Value.
|
|
|
|
STRINGSLICE
|
|
|
|
)
|
|
|
|
|
|
|
|
// BoolValue creates a BOOL Value.
|
|
|
|
func BoolValue(v bool) Value {
|
|
|
|
return Value{
|
|
|
|
vtype: BOOL,
|
|
|
|
numeric: internal.BoolToRaw(v),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// BoolSliceValue creates a BOOLSLICE Value.
|
|
|
|
func BoolSliceValue(v []bool) Value {
|
2023-03-12 09:49:12 +00:00
|
|
|
return Value{vtype: BOOLSLICE, slice: attribute.BoolSliceValue(v)}
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// IntValue creates an INT64 Value.
|
|
|
|
func IntValue(v int) Value {
|
|
|
|
return Int64Value(int64(v))
|
|
|
|
}
|
|
|
|
|
|
|
|
// IntSliceValue creates an INTSLICE Value.
|
|
|
|
func IntSliceValue(v []int) Value {
|
2022-11-30 05:03:57 +00:00
|
|
|
var int64Val int64
|
|
|
|
cp := reflect.New(reflect.ArrayOf(len(v), reflect.TypeOf(int64Val)))
|
|
|
|
for i, val := range v {
|
|
|
|
cp.Elem().Index(i).SetInt(int64(val))
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
return Value{
|
|
|
|
vtype: INT64SLICE,
|
2022-11-30 05:03:57 +00:00
|
|
|
slice: cp.Elem().Interface(),
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Int64Value creates an INT64 Value.
|
|
|
|
func Int64Value(v int64) Value {
|
|
|
|
return Value{
|
|
|
|
vtype: INT64,
|
|
|
|
numeric: internal.Int64ToRaw(v),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Int64SliceValue creates an INT64SLICE Value.
|
|
|
|
func Int64SliceValue(v []int64) Value {
|
2023-03-12 09:49:12 +00:00
|
|
|
return Value{vtype: INT64SLICE, slice: attribute.Int64SliceValue(v)}
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Float64Value creates a FLOAT64 Value.
|
|
|
|
func Float64Value(v float64) Value {
|
|
|
|
return Value{
|
|
|
|
vtype: FLOAT64,
|
|
|
|
numeric: internal.Float64ToRaw(v),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Float64SliceValue creates a FLOAT64SLICE Value.
|
|
|
|
func Float64SliceValue(v []float64) Value {
|
2023-03-12 09:49:12 +00:00
|
|
|
return Value{vtype: FLOAT64SLICE, slice: attribute.Float64SliceValue(v)}
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// StringValue creates a STRING Value.
|
|
|
|
func StringValue(v string) Value {
|
|
|
|
return Value{
|
|
|
|
vtype: STRING,
|
|
|
|
stringly: v,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// StringSliceValue creates a STRINGSLICE Value.
|
|
|
|
func StringSliceValue(v []string) Value {
|
2023-03-12 09:49:12 +00:00
|
|
|
return Value{vtype: STRINGSLICE, slice: attribute.StringSliceValue(v)}
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Type returns a type of the Value.
|
|
|
|
func (v Value) Type() Type {
|
|
|
|
return v.vtype
|
|
|
|
}
|
|
|
|
|
|
|
|
// AsBool returns the bool value. Make sure that the Value's type is
|
|
|
|
// BOOL.
|
|
|
|
func (v Value) AsBool() bool {
|
|
|
|
return internal.RawToBool(v.numeric)
|
|
|
|
}
|
|
|
|
|
|
|
|
// AsBoolSlice returns the []bool value. Make sure that the Value's type is
|
|
|
|
// BOOLSLICE.
|
|
|
|
func (v Value) AsBoolSlice() []bool {
|
2022-12-06 07:28:14 +00:00
|
|
|
if v.vtype != BOOLSLICE {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return v.asBoolSlice()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (v Value) asBoolSlice() []bool {
|
2023-03-12 09:49:12 +00:00
|
|
|
return attribute.AsBoolSlice(v.slice)
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// AsInt64 returns the int64 value. Make sure that the Value's type is
|
|
|
|
// INT64.
|
|
|
|
func (v Value) AsInt64() int64 {
|
|
|
|
return internal.RawToInt64(v.numeric)
|
|
|
|
}
|
|
|
|
|
|
|
|
// AsInt64Slice returns the []int64 value. Make sure that the Value's type is
|
|
|
|
// INT64SLICE.
|
|
|
|
func (v Value) AsInt64Slice() []int64 {
|
2022-12-06 07:28:14 +00:00
|
|
|
if v.vtype != INT64SLICE {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return v.asInt64Slice()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (v Value) asInt64Slice() []int64 {
|
2023-03-12 09:49:12 +00:00
|
|
|
return attribute.AsInt64Slice(v.slice)
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// AsFloat64 returns the float64 value. Make sure that the Value's
|
|
|
|
// type is FLOAT64.
|
|
|
|
func (v Value) AsFloat64() float64 {
|
|
|
|
return internal.RawToFloat64(v.numeric)
|
|
|
|
}
|
|
|
|
|
|
|
|
// AsFloat64Slice returns the []float64 value. Make sure that the Value's type is
|
|
|
|
// FLOAT64SLICE.
|
|
|
|
func (v Value) AsFloat64Slice() []float64 {
|
2022-12-06 07:28:14 +00:00
|
|
|
if v.vtype != FLOAT64SLICE {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return v.asFloat64Slice()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (v Value) asFloat64Slice() []float64 {
|
2023-03-12 09:49:12 +00:00
|
|
|
return attribute.AsFloat64Slice(v.slice)
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// AsString returns the string value. Make sure that the Value's type
|
|
|
|
// is STRING.
|
|
|
|
func (v Value) AsString() string {
|
|
|
|
return v.stringly
|
|
|
|
}
|
|
|
|
|
|
|
|
// AsStringSlice returns the []string value. Make sure that the Value's type is
|
|
|
|
// STRINGSLICE.
|
|
|
|
func (v Value) AsStringSlice() []string {
|
2022-12-06 07:28:14 +00:00
|
|
|
if v.vtype != STRINGSLICE {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return v.asStringSlice()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (v Value) asStringSlice() []string {
|
2023-03-12 09:49:12 +00:00
|
|
|
return attribute.AsStringSlice(v.slice)
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
type unknownValueType struct{}
|
|
|
|
|
|
|
|
// AsInterface returns Value's data as interface{}.
|
|
|
|
func (v Value) AsInterface() interface{} {
|
|
|
|
switch v.Type() {
|
|
|
|
case BOOL:
|
|
|
|
return v.AsBool()
|
|
|
|
case BOOLSLICE:
|
2022-12-06 07:28:14 +00:00
|
|
|
return v.asBoolSlice()
|
2022-11-29 21:53:28 +00:00
|
|
|
case INT64:
|
|
|
|
return v.AsInt64()
|
|
|
|
case INT64SLICE:
|
2022-12-06 07:28:14 +00:00
|
|
|
return v.asInt64Slice()
|
2022-11-29 21:53:28 +00:00
|
|
|
case FLOAT64:
|
|
|
|
return v.AsFloat64()
|
|
|
|
case FLOAT64SLICE:
|
2022-12-06 07:28:14 +00:00
|
|
|
return v.asFloat64Slice()
|
2022-11-29 21:53:28 +00:00
|
|
|
case STRING:
|
|
|
|
return v.stringly
|
|
|
|
case STRINGSLICE:
|
2022-12-06 07:28:14 +00:00
|
|
|
return v.asStringSlice()
|
2022-11-29 21:53:28 +00:00
|
|
|
}
|
|
|
|
return unknownValueType{}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Emit returns a string representation of Value's data.
|
|
|
|
func (v Value) Emit() string {
|
|
|
|
switch v.Type() {
|
|
|
|
case BOOLSLICE:
|
2022-12-06 07:28:14 +00:00
|
|
|
return fmt.Sprint(v.asBoolSlice())
|
2022-11-29 21:53:28 +00:00
|
|
|
case BOOL:
|
|
|
|
return strconv.FormatBool(v.AsBool())
|
|
|
|
case INT64SLICE:
|
2022-12-06 07:28:14 +00:00
|
|
|
return fmt.Sprint(v.asInt64Slice())
|
2022-11-29 21:53:28 +00:00
|
|
|
case INT64:
|
|
|
|
return strconv.FormatInt(v.AsInt64(), 10)
|
|
|
|
case FLOAT64SLICE:
|
2022-12-06 07:28:14 +00:00
|
|
|
return fmt.Sprint(v.asFloat64Slice())
|
2022-11-29 21:53:28 +00:00
|
|
|
case FLOAT64:
|
|
|
|
return fmt.Sprint(v.AsFloat64())
|
|
|
|
case STRINGSLICE:
|
2022-12-06 07:28:14 +00:00
|
|
|
return fmt.Sprint(v.asStringSlice())
|
2022-11-29 21:53:28 +00:00
|
|
|
case STRING:
|
|
|
|
return v.stringly
|
|
|
|
default:
|
|
|
|
return "unknown"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// MarshalJSON returns the JSON encoding of the Value.
|
|
|
|
func (v Value) MarshalJSON() ([]byte, error) {
|
|
|
|
var jsonVal struct {
|
|
|
|
Type string
|
|
|
|
Value interface{}
|
|
|
|
}
|
|
|
|
jsonVal.Type = v.Type().String()
|
|
|
|
jsonVal.Value = v.AsInterface()
|
|
|
|
return json.Marshal(jsonVal)
|
|
|
|
}
|