2021-08-09 07:19:24 +00:00
|
|
|
// Copyright The OpenTelemetry Authors
|
2024-08-19 08:01:33 +00:00
|
|
|
// SPDX-License-Identifier: Apache-2.0
|
2021-08-09 07:19:24 +00:00
|
|
|
|
|
|
|
package resource // import "go.opentelemetry.io/otel/sdk/resource"
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"fmt"
|
2023-12-18 20:31:00 +00:00
|
|
|
"net/url"
|
2021-08-09 07:19:24 +00:00
|
|
|
"os"
|
|
|
|
"strings"
|
|
|
|
|
2023-12-18 20:31:00 +00:00
|
|
|
"go.opentelemetry.io/otel"
|
2021-08-09 07:19:24 +00:00
|
|
|
"go.opentelemetry.io/otel/attribute"
|
2024-08-19 08:01:33 +00:00
|
|
|
semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
|
2021-08-09 07:19:24 +00:00
|
|
|
)
|
|
|
|
|
2023-02-01 17:06:36 +00:00
|
|
|
const (
|
|
|
|
// resourceAttrKey is the environment variable name OpenTelemetry Resource information will be read from.
|
2023-12-21 16:20:48 +00:00
|
|
|
resourceAttrKey = "OTEL_RESOURCE_ATTRIBUTES" //nolint:gosec // False positive G101: Potential hardcoded credentials
|
2023-02-01 17:06:36 +00:00
|
|
|
|
|
|
|
// svcNameKey is the environment variable name that Service Name information will be read from.
|
|
|
|
svcNameKey = "OTEL_SERVICE_NAME"
|
|
|
|
)
|
2021-08-09 07:19:24 +00:00
|
|
|
|
2023-12-21 16:20:48 +00:00
|
|
|
// errMissingValue is returned when a resource value is missing.
|
|
|
|
var errMissingValue = fmt.Errorf("%w: missing value", ErrPartialResource)
|
2021-08-09 07:19:24 +00:00
|
|
|
|
2023-02-01 17:06:36 +00:00
|
|
|
// fromEnv is a Detector that implements the Detector and collects
|
2021-08-09 07:19:24 +00:00
|
|
|
// resources from environment. This Detector is included as a
|
2023-02-01 17:06:36 +00:00
|
|
|
// builtin.
|
|
|
|
type fromEnv struct{}
|
2021-08-09 07:19:24 +00:00
|
|
|
|
2023-02-01 17:06:36 +00:00
|
|
|
// compile time assertion that FromEnv implements Detector interface.
|
|
|
|
var _ Detector = fromEnv{}
|
2021-08-09 07:19:24 +00:00
|
|
|
|
2023-02-01 17:06:36 +00:00
|
|
|
// Detect collects resources from environment.
|
|
|
|
func (fromEnv) Detect(context.Context) (*Resource, error) {
|
|
|
|
attrs := strings.TrimSpace(os.Getenv(resourceAttrKey))
|
|
|
|
svcName := strings.TrimSpace(os.Getenv(svcNameKey))
|
2021-08-09 07:19:24 +00:00
|
|
|
|
2023-02-01 17:06:36 +00:00
|
|
|
if attrs == "" && svcName == "" {
|
2021-08-09 07:19:24 +00:00
|
|
|
return Empty(), nil
|
|
|
|
}
|
2023-02-01 17:06:36 +00:00
|
|
|
|
|
|
|
var res *Resource
|
|
|
|
|
|
|
|
if svcName != "" {
|
2023-12-18 20:31:00 +00:00
|
|
|
res = NewSchemaless(semconv.ServiceName(svcName))
|
2023-02-01 17:06:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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
|
2021-08-09 07:19:24 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func constructOTResources(s string) (*Resource, error) {
|
2023-02-01 17:06:36 +00:00
|
|
|
if s == "" {
|
|
|
|
return Empty(), nil
|
|
|
|
}
|
2021-08-09 07:19:24 +00:00
|
|
|
pairs := strings.Split(s, ",")
|
2023-12-18 20:31:00 +00:00
|
|
|
var attrs []attribute.KeyValue
|
2021-08-09 07:19:24 +00:00
|
|
|
var invalid []string
|
|
|
|
for _, p := range pairs {
|
2023-12-18 20:31:00 +00:00
|
|
|
k, v, found := strings.Cut(p, "=")
|
|
|
|
if !found {
|
2021-08-09 07:19:24 +00:00
|
|
|
invalid = append(invalid, p)
|
|
|
|
continue
|
|
|
|
}
|
2023-12-18 20:31:00 +00:00
|
|
|
key := strings.TrimSpace(k)
|
2023-12-21 16:20:48 +00:00
|
|
|
val, err := url.PathUnescape(strings.TrimSpace(v))
|
2023-12-18 20:31:00 +00:00
|
|
|
if err != nil {
|
|
|
|
// Retain original value if decoding fails, otherwise it will be
|
|
|
|
// an empty string.
|
|
|
|
val = v
|
|
|
|
otel.Handle(err)
|
|
|
|
}
|
|
|
|
attrs = append(attrs, attribute.String(key, val))
|
2021-08-09 07:19:24 +00:00
|
|
|
}
|
|
|
|
var err error
|
|
|
|
if len(invalid) > 0 {
|
|
|
|
err = fmt.Errorf("%w: %v", errMissingValue, invalid)
|
|
|
|
}
|
2023-02-01 17:06:36 +00:00
|
|
|
return NewSchemaless(attrs...), err
|
2021-08-09 07:19:24 +00:00
|
|
|
}
|