mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
05aca23c19
* Decode values from OTEL_RESOURCE_ATTRIBUTES The W3C spec specifies that values must be percent-encoded so when reading the environment variable `OTEL_RESOURCE_ATTRIBUTES` the SDK should decode them. This is done by the `baggage` package, but its behaviour in case of errors is slightly different from the current implementation of the SDK, more specifically in cases where a key is missing a value. The SDK returns a partial resource while the `bagage` package returns nil. This may be considered a breaking change, so this commit fixes the current implementation instead of using `baggage.Parse`. * Add changelog entry for #2963 * Use otel.Handle on OTEL_RESOURCE_ATTRIBUTES decode error * retain original value when decoding fails * docs: update CHANGELOG Co-authored-by: Chester Cheung <cheung.zhy.csu@gmail.com> Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.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 resource // import "go.opentelemetry.io/otel/sdk/resource"
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/url"
|
|
"os"
|
|
"strings"
|
|
|
|
"go.opentelemetry.io/otel"
|
|
"go.opentelemetry.io/otel/attribute"
|
|
semconv "go.opentelemetry.io/otel/semconv/v1.12.0"
|
|
)
|
|
|
|
const (
|
|
// resourceAttrKey is the environment variable name OpenTelemetry Resource information will be read from.
|
|
resourceAttrKey = "OTEL_RESOURCE_ATTRIBUTES"
|
|
|
|
// svcNameKey is the environment variable name that Service Name information will be read from.
|
|
svcNameKey = "OTEL_SERVICE_NAME"
|
|
)
|
|
|
|
var (
|
|
// errMissingValue is returned when a resource value is missing.
|
|
errMissingValue = fmt.Errorf("%w: missing value", ErrPartialResource)
|
|
)
|
|
|
|
// fromEnv is a Detector that implements the Detector and collects
|
|
// resources from environment. This Detector is included as a
|
|
// builtin.
|
|
type fromEnv struct{}
|
|
|
|
// compile time assertion that FromEnv implements Detector interface.
|
|
var _ Detector = fromEnv{}
|
|
|
|
// Detect collects resources from environment.
|
|
func (fromEnv) Detect(context.Context) (*Resource, error) {
|
|
attrs := strings.TrimSpace(os.Getenv(resourceAttrKey))
|
|
svcName := strings.TrimSpace(os.Getenv(svcNameKey))
|
|
|
|
if attrs == "" && svcName == "" {
|
|
return Empty(), nil
|
|
}
|
|
|
|
var res *Resource
|
|
|
|
if svcName != "" {
|
|
res = NewSchemaless(semconv.ServiceNameKey.String(svcName))
|
|
}
|
|
|
|
r2, err := constructOTResources(attrs)
|
|
|
|
// Ensure that the resource with the service name from OTEL_SERVICE_NAME
|
|
// takes precedence, if it was defined.
|
|
res, err2 := Merge(r2, res)
|
|
|
|
if err == nil {
|
|
err = err2
|
|
} else if err2 != nil {
|
|
err = fmt.Errorf("detecting resources: %s", []string{err.Error(), err2.Error()})
|
|
}
|
|
|
|
return res, err
|
|
}
|
|
|
|
func constructOTResources(s string) (*Resource, error) {
|
|
if s == "" {
|
|
return Empty(), nil
|
|
}
|
|
pairs := strings.Split(s, ",")
|
|
attrs := []attribute.KeyValue{}
|
|
var invalid []string
|
|
for _, p := range pairs {
|
|
field := strings.SplitN(p, "=", 2)
|
|
if len(field) != 2 {
|
|
invalid = append(invalid, p)
|
|
continue
|
|
}
|
|
k := strings.TrimSpace(field[0])
|
|
v, err := url.QueryUnescape(strings.TrimSpace(field[1]))
|
|
if err != nil {
|
|
// Retain original value if decoding fails, otherwise it will be
|
|
// an empty string.
|
|
v = field[1]
|
|
otel.Handle(err)
|
|
}
|
|
attrs = append(attrs, attribute.String(k, v))
|
|
}
|
|
var err error
|
|
if len(invalid) > 0 {
|
|
err = fmt.Errorf("%w: %v", errMissingValue, invalid)
|
|
}
|
|
return NewSchemaless(attrs...), err
|
|
}
|