mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
5be82c0e47
* Added support array attributes * Changed function signature for AsArray attribute * Fixed code comments for array attributes * Fixed typos in comments in value.go Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
174 lines
5.1 KiB
Go
174 lines
5.1 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 kv
|
|
|
|
import (
|
|
"go.opentelemetry.io/otel/api/kv/value"
|
|
)
|
|
|
|
// Key represents the key part in key-value pairs. It's a string. The
|
|
// allowed character set in the key depends on the use of the key.
|
|
type Key string
|
|
|
|
// Bool creates a KeyValue instance with a BOOL Value.
|
|
//
|
|
// If creating both key and a bool value at the same time, then
|
|
// instead of calling kv.Key(name).Bool(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Bool(name, value).
|
|
func (k Key) Bool(v bool) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Bool(v),
|
|
}
|
|
}
|
|
|
|
// Int64 creates a KeyValue instance with an INT64 Value.
|
|
//
|
|
// If creating both key and an int64 value at the same time, then
|
|
// instead of calling kv.Key(name).Int64(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Int64(name, value).
|
|
func (k Key) Int64(v int64) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Int64(v),
|
|
}
|
|
}
|
|
|
|
// Uint64 creates a KeyValue instance with a UINT64 Value.
|
|
//
|
|
// If creating both key and a uint64 value at the same time, then
|
|
// instead of calling kv.Key(name).Uint64(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Uint64(name, value).
|
|
func (k Key) Uint64(v uint64) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Uint64(v),
|
|
}
|
|
}
|
|
|
|
// Float64 creates a KeyValue instance with a FLOAT64 Value.
|
|
//
|
|
// If creating both key and a float64 value at the same time, then
|
|
// instead of calling kv.Key(name).Float64(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Float64(name, value).
|
|
func (k Key) Float64(v float64) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Float64(v),
|
|
}
|
|
}
|
|
|
|
// Int32 creates a KeyValue instance with an INT32 Value.
|
|
//
|
|
// If creating both key and an int32 value at the same time, then
|
|
// instead of calling kv.Key(name).Int32(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Int32(name, value).
|
|
func (k Key) Int32(v int32) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Int32(v),
|
|
}
|
|
}
|
|
|
|
// Uint32 creates a KeyValue instance with a UINT32 Value.
|
|
//
|
|
// If creating both key and a uint32 value at the same time, then
|
|
// instead of calling kv.Key(name).Uint32(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Uint32(name, value).
|
|
func (k Key) Uint32(v uint32) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Uint32(v),
|
|
}
|
|
}
|
|
|
|
// Float32 creates a KeyValue instance with a FLOAT32 Value.
|
|
//
|
|
// If creating both key and a float32 value at the same time, then
|
|
// instead of calling kv.Key(name).Float32(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Float32(name, value).
|
|
func (k Key) Float32(v float32) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Float32(v),
|
|
}
|
|
}
|
|
|
|
// String creates a KeyValue instance with a STRING Value.
|
|
//
|
|
// If creating both key and a string value at the same time, then
|
|
// instead of calling kv.Key(name).String(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.String(name, value).
|
|
func (k Key) String(v string) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.String(v),
|
|
}
|
|
}
|
|
|
|
// Int creates a KeyValue instance with either an INT32 or an INT64
|
|
// Value, depending on whether the int type is 32 or 64 bits wide.
|
|
//
|
|
// If creating both key and an int value at the same time, then
|
|
// instead of calling kv.Key(name).Int(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Int(name, value).
|
|
func (k Key) Int(v int) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Int(v),
|
|
}
|
|
}
|
|
|
|
// Uint creates a KeyValue instance with either a UINT32 or a UINT64
|
|
// Value, depending on whether the uint type is 32 or 64 bits wide.
|
|
//
|
|
// If creating both key and a uint value at the same time, then
|
|
// instead of calling kv.Key(name).Uint(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Uint(name, value).
|
|
func (k Key) Uint(v uint) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Uint(v),
|
|
}
|
|
}
|
|
|
|
// Defined returns true for non-empty keys.
|
|
func (k Key) Defined() bool {
|
|
return len(k) != 0
|
|
}
|
|
|
|
// Array creates a KeyValue instance with a ARRAY Value.
|
|
//
|
|
// If creating both key and a array value at the same time, then
|
|
// instead of calling kv.Key(name).String(value) consider using a
|
|
// convenience function provided by the api/key package -
|
|
// key.Array(name, value).
|
|
func (k Key) Array(v interface{}) KeyValue {
|
|
return KeyValue{
|
|
Key: k,
|
|
Value: value.Array(v),
|
|
}
|
|
}
|