[pkg/ottl] Accessors for profile attributes

Author: rockdaboot

.chloggen/profile-attributes-accessor.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: Add accessors for profile attributes
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [39681]
+
+# (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: [user]

pkg/ottl/contexts/internal/ctxprofile/profile.go

@@ -6,6 +6,9 @@ package ctxprofile // import "github.com/open-telemetry/opentelemetry-collector-
 import (
 	"context"
 	"encoding/hex"
+	"errors"
+	"fmt"
+	"math"
 	"time"
 
 	"go.opentelemetry.io/collector/pdata/pcommon"
@@ -79,6 +82,11 @@ func PathGetSetter[K ProfileContext](path ottl.Path[K]) (ottl.GetSetter[K], erro
 		return accessOriginalPayloadFormat[K](), nil
 	case "original_payload":
 		return accessOriginalPayload[K](), nil
+	case "attributes":
+		if path.Keys() == nil {
+			return accessAttributes[K](), nil
+		}
+		return accessAttributesKey(path.Keys()), nil
 	default:
 		return nil, ctxerror.New(path.Name(), path.String(), Name, DocRef)
 	}
@@ -412,3 +420,124 @@ func accessOriginalPayload[K ProfileContext]() ottl.StandardGetSetter[K] {
 		},
 	}
 }
+
+func accessAttributes[K ProfileContext]() ottl.StandardGetSetter[K] {
+	return ottl.StandardGetSetter[K]{
+		Getter: func(_ context.Context, tCtx K) (any, error) {
+			return pprofile.FromAttributeIndices(tCtx.GetProfile().AttributeTable(), tCtx.GetProfile()), nil
+		},
+		Setter: func(_ context.Context, tCtx K, val any) error {
+			m, ok := val.(pcommon.Map)
+			if !ok {
+				return fmt.Errorf("expected pcommon.Map, got %T", val)
+			}
+			tCtx.GetProfile().AttributeIndices().FromRaw([]int32{})
+			for k, v := range m.All() {
+				if err := PutAttribute(tCtx.GetProfile().AttributeTable(), tCtx.GetProfile(), k, v); err != nil {
+					return err
+				}
+			}
+			return nil
+		},
+	}
+}
+
+func accessAttributesKey[K Context](key []ottl.Key[K]) ottl.StandardGetSetter[K] {
+	return ottl.StandardGetSetter[K]{
+		Getter: func(ctx context.Context, tCtx K) (any, error) {
+			return ctxutil.GetMapValue[K](ctx, tCtx, pprofile.FromAttributeIndices(tCtx.GetProfile().AttributeTable(), tCtx.GetProfile()), key)
+		},
+		Setter: func(ctx context.Context, tCtx K, val any) error {
+			newKey, err := key[0].String(ctx, tCtx)
+			if err != nil {
+				return err
+			}
+			v := pcommon.NewValueEmpty()
+			if err = v.FromRaw(val); err != nil {
+				return err
+			}
+			return PutAttribute(tCtx.GetProfile().AttributeTable(), tCtx.GetProfile(), *newKey, v)
+		},
+	}
+}
+
+// TODO: Remove the following code once https://github.com/open-telemetry/opentelemetry-collector/pull/12798 is merged.
+
+type attributable interface {
+	AttributeIndices() pcommon.Int32Slice
+}
+
+var errTooManyTableEntries = errors.New("too many entries in AttributeTable")
+
+// PutAttribute updates an AttributeTable and a record's AttributeIndices to
+// add a new attribute.
+// The record can be any struct that implements an `AttributeIndices` method.
+func PutAttribute(table pprofile.AttributeTableSlice, record attributable, key string, value pcommon.Value) error {
+	for i := range record.AttributeIndices().Len() {
+		idx := int(record.AttributeIndices().At(i))
+		if idx < 0 || idx >= table.Len() {
+			return fmt.Errorf("index value %d out of range in AttributeIndices[%d]", idx, i)
+		}
+		attr := table.At(idx)
+		if attr.Key() == key {
+			if attr.Value().Equal(value) {
+				// Attribute already exists, nothing to do.
+				return nil
+			}
+
+			// If the attribute table already contains the key/value pair, just update the index.
+			for j := range table.Len() {
+				a := table.At(j)
+				if a.Key() == key && a.Value().Equal(value) {
+					if j > math.MaxInt32 {
+						return errTooManyTableEntries
+					}
+					record.AttributeIndices().SetAt(i, int32(j))
+					return nil
+				}
+			}
+
+			if table.Len() >= math.MaxInt32 {
+				return errTooManyTableEntries
+			}
+
+			// Add the key/value pair as a new attribute to the table...
+			entry := table.AppendEmpty()
+			entry.SetKey(key)
+			value.CopyTo(entry.Value())
+
+			// ...and update the existing index.
+			record.AttributeIndices().SetAt(i, int32(table.Len()-1))
+			return nil
+		}
+	}
+
+	if record.AttributeIndices().Len() >= math.MaxInt32 {
+		return errors.New("too many entries in AttributeIndices")
+	}
+
+	for j := range table.Len() {
+		a := table.At(j)
+		if a.Key() == key && a.Value().Equal(value) {
+			if j > math.MaxInt32 {
+				return errTooManyTableEntries
+			}
+			// Add the index of the existing attribute to the indices.
+			record.AttributeIndices().Append(int32(j))
+			return nil
+		}
+	}
+
+	if table.Len() >= math.MaxInt32 {
+		return errTooManyTableEntries
+	}
+
+	// Add the key/value pair as a new attribute to the table...
+	entry := table.AppendEmpty()
+	entry.SetKey(key)
+	value.CopyTo(entry.Value())
+
+	// ...and add a new index to the indices.
+	record.AttributeIndices().Append(int32(table.Len() - 1))
+	return nil
+}

pkg/ottl/contexts/internal/ctxprofile/profile_test.go

@@ -13,14 +13,17 @@ import (
 	"go.opentelemetry.io/collector/pdata/pcommon"
 	"go.opentelemetry.io/collector/pdata/pprofile"
 
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/contexts/internal/pathtest"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/ottltest"
 )
 
 func TestPathGetSetter(t *testing.T) {
 	// create tests
 	tests := []struct {
 		path     string
 		val      any
+		keys     []ottl.Key[*profileContext]
 		setFails bool
 	}{
 		{
@@ -124,19 +127,39 @@ func TestPathGetSetter(t *testing.T) {
 			path: "original_payload",
 			val:  []byte{1, 2, 3},
 		},
+		{
+			path: "attributes",
+			val: func() pcommon.Map {
+				m := pcommon.NewMap()
+				m.PutStr("akey", "val")
+				return m
+			}(),
+		},
+		{
+			path: "attributes",
+			keys: []ottl.Key[*profileContext]{
+				&pathtest.Key[*profileContext]{
+					S: ottltest.Strp("akey"),
+				},
+			},
+			val: "val",
+		},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.path, func(t *testing.T) {
 			pathParts := strings.Split(tt.path, " ")
 			path := &pathtest.Path[*profileContext]{N: pathParts[0]}
+			if tt.keys != nil {
+				path.KeySlice = tt.keys
+			}
 			if len(pathParts) > 1 {
 				path.NextPath = &pathtest.Path[*profileContext]{N: pathParts[1]}
 			}
 
 			profile := pprofile.NewProfile()
 
-			accessor, err := PathGetSetter[*profileContext](path)
+			accessor, err := PathGetSetter(path)
 			require.NoError(t, err)
 
 			err = accessor.Set(context.Background(), newProfileContext(profile), tt.val)

pkg/ottl/contexts/ottlprofile/README.md

@@ -22,6 +22,8 @@ The following paths are supported.
 | instrumentation_scope.version            | version of the instrumentation scope of the profile being processed                                                                                | string                                                                  |
 | instrumentation_scope.attributes         | instrumentation scope attributes of the data point being processed                                                                                 | pcommon.Map                                                             |
 | instrumentation_scope.attributes\[""\]   | the value of the instrumentation scope attribute of the data point being processed. Supports multiple indexes to access nested fields.             | string, bool, int64, float64, pcommon.Map, pcommon.Slice, []byte or nil |
+| profile.attributes                       | attributes of the profile being processed                                                                                                          | pcommon.Map                                                             |
+| profile.attributes\[""\]                 | the value of the attribute of the profile being processed. Supports multiple indexes to access nested fields.                                      | string, bool, int64, float64, pcommon.Map, pcommon.Slice, []byte or nil |
 | profile.sample_type                      | the sample types of the profile being processed                                                                                                    | pprofile.ValueTypeSlice                                                 |
 | profile.sample                           | the samples of the profile being processed                                                                                                         | pprofile.SampleSlice                                                    |
 | profile.mapping_table                    | the mapping table of the profile being processed                                                                                                   | pprofile.MappingSlice                                                   |