[pkg/ottl] Add client metadata access to OTTL contexts

.chloggen/33288-metadata.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: pkg/ottl
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Added metadata access path to all OTTL contexts for accessing client request metadata
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [33288]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

connector/countconnector/go.mod

@@ -82,6 +82,7 @@ require (
 	github.com/yusufpapurcu/wmi v1.2.4 // indirect
 	github.com/zeebo/xxh3 v1.1.0 // indirect
 	go.opentelemetry.io/auto/sdk v1.2.1 // indirect
+	go.opentelemetry.io/collector/client v1.52.1-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/component/componentstatus v0.146.2-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/config/configtelemetry v0.146.2-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/confmap/provider/envprovider v1.52.1-0.20260227062254-168030d61d7d // indirect

connector/signaltometricsconnector/go.mod

@@ -63,6 +63,7 @@ require (
 	github.com/ua-parser/uap-go v0.0.0-20240611065828-3a4781585db6 // indirect
 	github.com/zeebo/xxh3 v1.1.0 // indirect
 	go.opentelemetry.io/auto/sdk v1.2.1 // indirect
+	go.opentelemetry.io/collector/client v1.52.1-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/consumer/xconsumer v0.146.2-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/featuregate v1.52.1-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/internal/componentalias v0.146.2-0.20260227062254-168030d61d7d // indirect
@@ -79,6 +80,7 @@ require (
 	golang.org/x/net v0.51.0 // indirect
 	golang.org/x/sys v0.41.0 // indirect
 	golang.org/x/text v0.34.0 // indirect
+	google.golang.org/grpc v1.79.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

connector/sumconnector/go.mod

@@ -58,6 +58,7 @@ require (
 	github.com/ua-parser/uap-go v0.0.0-20240611065828-3a4781585db6 // indirect
 	github.com/zeebo/xxh3 v1.1.0 // indirect
 	go.opentelemetry.io/auto/sdk v1.2.1 // indirect
+	go.opentelemetry.io/collector/client v1.52.1-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/connector/xconnector v0.146.2-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/consumer/xconsumer v0.146.2-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/featuregate v1.52.1-0.20260227062254-168030d61d7d // indirect
@@ -77,6 +78,7 @@ require (
 	golang.org/x/net v0.51.0 // indirect
 	golang.org/x/sys v0.41.0 // indirect
 	golang.org/x/text v0.34.0 // indirect
+	google.golang.org/grpc v1.79.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

internal/filter/go.mod

@@ -52,6 +52,7 @@ require (
 	github.com/ua-parser/uap-go v0.0.0-20240611065828-3a4781585db6 // indirect
 	github.com/zeebo/xxh3 v1.1.0 // indirect
 	go.opentelemetry.io/auto/sdk v1.2.1 // indirect
+	go.opentelemetry.io/collector/client v1.52.1-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/collector/pdata/pprofile v0.146.2-0.20260227062254-168030d61d7d // indirect
 	go.opentelemetry.io/otel/metric v1.40.0 // indirect
 	go.opentelemetry.io/otel/sdk v1.40.0 // indirect
@@ -63,6 +64,7 @@ require (
 	golang.org/x/net v0.51.0 // indirect
 	golang.org/x/sys v0.41.0 // indirect
 	golang.org/x/text v0.34.0 // indirect
+	google.golang.org/grpc v1.79.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

pkg/ottl/contexts/internal/ctxotelcol/client.go

@@ -0,0 +1,215 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package ctxotelcol // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/contexts/internal/ctxotelcol"
+
+import (
+	"context"
+	"errors"
+	"fmt"
+
+	"go.opentelemetry.io/collector/client"
+	"go.opentelemetry.io/collector/pdata/pcommon"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/contexts/internal/ctxerror"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/contexts/internal/ctxutil"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/internal/ottlcommon"
+)
+
+func accessClient[K any](path ottl.Path[K]) (ottl.GetSetter[K], error) {
+	nextPath := path.Next()
+	if nextPath == nil {
+		return nil, ctxerror.New(path.Name(), path.String(), Name, DocRef)
+	}
+	switch nextPath.Name() {
+	case "addr":
+		return accessClientAddr(nextPath)
+	case "auth":
+		return accessClientAuth(nextPath)
+	case "metadata":
+		return accessClientMetadata(nextPath)
+	default:
+		return nil, ctxerror.New(nextPath.Name(), nextPath.String(), Name, DocRef)
+	}
+}
+
+func accessClientMetadata[K any](path ottl.Path[K]) (ottl.GetSetter[K], error) {
+	nextPath := path.Next()
+	if nextPath != nil {
+		return nil, ctxerror.New(nextPath.Name(), nextPath.String(), Name, DocRef)
+	}
+	if path.Keys() == nil {
+		return accessClientMetadataKeys[K](), nil
+	}
+	return accessClientMetadataKey[K](path.Keys()), nil
+}
+
+func accessClientAddr[K any](path ottl.Path[K]) (ottl.GetSetter[K], error) {
+	nextPath := path.Next()
+	if nextPath != nil {
+		return nil, ctxerror.New(nextPath.Name(), nextPath.String(), Name, DocRef)
+	}
+	if path.Keys() != nil {
+		return nil, ctxerror.New(path.Name(), path.String(), Name, DocRef)
+	}
+	return ottl.StandardGetSetter[K]{
+		Getter: func(ctx context.Context, _ K) (any, error) {
+			cl := client.FromContext(ctx)
+			if cl.Addr == nil {
+				return nil, nil
+			}
+			return cl.Addr.String(), nil
+		},
+		Setter: func(_ context.Context, _ K, _ any) error {
+			return fmt.Errorf(readOnlyPathErrMsg, "otelcol.client.addr")
+		},
+	}, nil
+}
+
+func getAuthAttributeValue(authData client.AuthData, key string) (pcommon.Value, error) {
+	attrVal := authData.GetAttribute(key)
+	switch typedAttrVal := attrVal.(type) {
+	case string:
+		return pcommon.NewValueStr(typedAttrVal), nil
+	case []string:
+		value := pcommon.NewValueSlice()
+		slice := value.Slice()
+		slice.EnsureCapacity(len(typedAttrVal))
+		for _, str := range typedAttrVal {
+			slice.AppendEmpty().SetStr(str)
+		}
+		return value, nil
+	default:
+		value := pcommon.NewValueEmpty()
+		err := value.FromRaw(attrVal)
+		if err != nil {
+			return pcommon.Value{}, err
+		}
+		return value, nil
+	}
+}
+
+func convertAuthDataToMap(authData client.AuthData) pcommon.Map {
+	authMap := pcommon.NewMap()
+	if authData == nil {
+		return authMap
+	}
+	names := authData.GetAttributeNames()
+	authMap.EnsureCapacity(len(names))
+	for _, name := range names {
+		newKeyValue := authMap.PutEmpty(name)
+		if value, err := getAuthAttributeValue(authData, name); err == nil {
+			value.MoveTo(newKeyValue)
+		}
+	}
+	return authMap
+}
+
+func accessClientAuth[K any](path ottl.Path[K]) (ottl.GetSetter[K], error) {
+	nextPath := path.Next()
+	if nextPath == nil {
+		return nil, ctxerror.New(path.Name(), path.String(), Name, DocRef)
+	}
+	switch nextPath.Name() {
+	case "attributes":
+		if nextPath.Keys() == nil {
+			return accessClientAuthAttributesKeys[K](), nil
+		}
+		return accessClientAuthAttributesKey[K](nextPath.Keys()), nil
+	default:
+		return nil, ctxerror.New(nextPath.Name(), nextPath.String(), Name, DocRef)
+	}
+}
+
+func accessClientAuthAttributesKeys[K any]() ottl.StandardGetSetter[K] {
+	return ottl.StandardGetSetter[K]{
+		Getter: func(ctx context.Context, _ K) (any, error) {
+			cl := client.FromContext(ctx)
+			return convertAuthDataToMap(cl.Auth), nil
+		},
+		Setter: func(_ context.Context, _ K, _ any) error {
+			return fmt.Errorf(readOnlyPathErrMsg, "otelcol.client.auth.attributes")
+		},
+	}
+}
+
+func accessClientAuthAttributesKey[K any](keys []ottl.Key[K]) ottl.StandardGetSetter[K] {
+	return ottl.StandardGetSetter[K]{
+		Getter: func(ctx context.Context, tCtx K) (any, error) {
+			if len(keys) == 0 {
+				return nil, errors.New("cannot get map value without keys")
+			}
+			cl := client.FromContext(ctx)
+			key, err := ctxutil.GetMapKeyName(ctx, tCtx, keys[0])
+			if err != nil {
+				return nil, err
+			}
+			if cl.Auth == nil {
+				return nil, nil
+			}
+			attrVal, err := getAuthAttributeValue(cl.Auth, *key)
+			if err != nil {
+				return nil, err
+			}
+			if len(keys) > 1 {
+				switch attrVal.Type() {
+				case pcommon.ValueTypeSlice:
+					return ctxutil.GetSliceValue[K](ctx, tCtx, attrVal.Slice(), keys[1:])
+				case pcommon.ValueTypeMap:
+					return ctxutil.GetMapValue[K](ctx, tCtx, attrVal.Map(), keys[1:])
+				default:
+					return nil, fmt.Errorf("attribute %q value is not indexable: %s", *key, attrVal.Type().String())
+				}
+			}
+			return ottlcommon.GetValue(attrVal), nil
+		},
+		Setter: func(_ context.Context, _ K, _ any) error {
+			return fmt.Errorf(readOnlyPathErrMsg, "otelcol.client.auth.attributes")
+		},
+	}
+}
+
+func convertClientMetadataToMap(md client.Metadata) pcommon.Map {
+	mdMap := pcommon.NewMap()
+	for k := range md.Keys() {
+		convertStringArrToValueSlice(md.Get(k)).MoveTo(mdMap.PutEmpty(k))
+	}
+	return mdMap
+}
+
+func accessClientMetadataKeys[K any]() ottl.StandardGetSetter[K] {
+	return ottl.StandardGetSetter[K]{
+		Getter: func(ctx context.Context, _ K) (any, error) {
+			cl := client.FromContext(ctx)
+			return convertClientMetadataToMap(cl.Metadata), nil
+		},
+		Setter: func(_ context.Context, _ K, _ any) error {
+			return fmt.Errorf(readOnlyPathErrMsg, "otelcol.client.metadata")
+		},
+	}
+}
+
+func accessClientMetadataKey[K any](keys []ottl.Key[K]) ottl.StandardGetSetter[K] {
+	return ottl.StandardGetSetter[K]{
+		Getter: func(ctx context.Context, tCtx K) (any, error) {
+			if len(keys) == 0 {
+				return nil, errors.New("cannot get map value without keys")
+			}
+
+			key, err := ctxutil.GetMapKeyName(ctx, tCtx, keys[0])
+			if err != nil {
+				return nil, fmt.Errorf("cannot get map value: %w", err)
+			}
+			cl := client.FromContext(ctx)
+			mdVal := cl.Metadata.Get(*key)
+			if len(mdVal) == 0 {
+				return nil, nil
+			}
+			return getIndexableValueFromStringArr(ctx, tCtx, keys[1:], mdVal)
+		},
+		Setter: func(_ context.Context, _ K, _ any) error {
+			return fmt.Errorf(readOnlyPathErrMsg, "otelcol.client.metadata")
+		},
+	}
+}

pkg/ottl/contexts/internal/ctxotelcol/context.go

@@ -0,0 +1,10 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package ctxotelcol // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/contexts/internal/ctxotelcol"
+
+const (
+	readOnlyPathErrMsg = "%q is read-only and cannot be modified"
+	Name               = "otelcol"
+	DocRef             = "https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/pkg/ottl/contexts/ottlotelcol"
+)