traces/pkg/traceql/enum_attributes.go

package traceql

import "fmt"

type AttributeScope int8

const (
	AttributeScopeNone AttributeScope = iota
	AttributeScopeResource
	AttributeScopeSpan
	AttributeScopeEvent
	AttributeScopeLink
	AttributeScopeInstrumentation
	AttributeScopeUnknown

	none     = "none"
	duration = "duration"
)

func AllAttributeScopes() []AttributeScope {
	return []AttributeScope{AttributeScopeResource, AttributeScopeSpan}
}

func (s AttributeScope) String() string {
	switch s {
	case AttributeScopeNone:
		return none
	case AttributeScopeSpan:
		return "span"
	case AttributeScopeResource:
		return "resource"
	case AttributeScopeEvent:
		return "event"
	case AttributeScopeLink:
		return "link"
	case AttributeScopeInstrumentation:
		return "instrumentation"
	}

	return fmt.Sprintf("att(%d).", s)
}

func AttributeScopeFromString(s string) AttributeScope {
	switch s {
	case "span":
		return AttributeScopeSpan
	case "resource":
		return AttributeScopeResource
	case "event":
		return AttributeScopeEvent
	case "link":
		return AttributeScopeLink
	case "instrumentation":
		return AttributeScopeInstrumentation
	case "":
		fallthrough
	case none:
		return AttributeScopeNone
	}

	return AttributeScopeUnknown
}

type Intrinsic int8

// keep the intrinsics in sync with GetVirtualIntrinsicValues() in pkg/search/util.go
const (
	IntrinsicNone Intrinsic = iota
	IntrinsicDuration
	IntrinsicName
	IntrinsicStatus
	IntrinsicStatusMessage
	IntrinsicKind
	IntrinsicChildCount
	IntrinsicTraceRootService
	IntrinsicTraceRootSpan
	IntrinsicTraceDuration
	IntrinsicNestedSetLeft
	IntrinsicNestedSetRight
	IntrinsicNestedSetParent
	IntrinsicEventName
	IntrinsicEventTimeSinceStart
	IntrinsicLinkSpanID
	IntrinsicLinkTraceID
	IntrinsicInstrumentationName
	IntrinsicInstrumentationVersion

	// not yet implemented in traceql but will be
	IntrinsicParent

	// These intrinsics do not map to specific data points, but are used to
	// indicate that Spans must be able to answer the structural methods
	// DescdendantOf, SiblingOf and ChildOf.  The details of those methods
	// and how these intrinsics are handled is left to the implementation.
	IntrinsicStructuralDescendant
	IntrinsicStructuralSibling
	IntrinsicStructuralChild

	IntrinsicTraceID
	IntrinsicSpanID
	IntrinsicParentID
	ScopedIntrinsicSpanStatus
	ScopedIntrinsicSpanStatusMessage
	ScopedIntrinsicSpanDuration
	ScopedIntrinsicSpanName
	ScopedIntrinsicSpanKind
	ScopedIntrinsicTraceRootName
	ScopedIntrinsicTraceRootService
	ScopedIntrinsicTraceDuration

	// not yet implemented in traceql and may never be. these exist so that we can retrieve
	// these fields from the fetch layer

	IntrinsicTraceStartTime
	IntrinsicSpanStartTime

	IntrinsicServiceStats
)

var (
	IntrinsicDurationAttribute               = NewIntrinsic(IntrinsicDuration)
	IntrinsicNameAttribute                   = NewIntrinsic(IntrinsicName)
	IntrinsicStatusAttribute                 = NewIntrinsic(IntrinsicStatus)
	IntrinsicStatusMessageAttribute          = NewIntrinsic(IntrinsicStatusMessage)
	IntrinsicKindAttribute                   = NewIntrinsic(IntrinsicKind)
	IntrinsicSpanIDAttribute                 = NewIntrinsic(IntrinsicSpanID)
	IntrinsicParentIDAttribute               = NewIntrinsic(IntrinsicParentID)
	IntrinsicChildCountAttribute             = NewIntrinsic(IntrinsicChildCount)
	IntrinsicTraceIDAttribute                = NewIntrinsic(IntrinsicTraceID)
	IntrinsicTraceRootServiceAttribute       = NewIntrinsic(IntrinsicTraceRootService)
	IntrinsicTraceRootSpanAttribute          = NewIntrinsic(IntrinsicTraceRootSpan)
	IntrinsicTraceDurationAttribute          = NewIntrinsic(IntrinsicTraceDuration)
	IntrinsicSpanStartTimeAttribute          = NewIntrinsic(IntrinsicSpanStartTime)
	IntrinsicNestedSetLeftAttribute          = NewIntrinsic(IntrinsicNestedSetLeft)
	IntrinsicNestedSetRightAttribute         = NewIntrinsic(IntrinsicNestedSetRight)
	IntrinsicNestedSetParentAttribute        = NewIntrinsic(IntrinsicNestedSetParent)
	IntrinsicLinkTraceIDAttribute            = NewIntrinsic(IntrinsicLinkTraceID)
	IntrinsicLinkSpanIDAttribute             = NewIntrinsic(IntrinsicLinkSpanID)
	IntrinsicEventNameAttribute              = NewIntrinsic(IntrinsicEventName)
	IntrinsicEventTimeSinceStartAttribute    = NewIntrinsic(IntrinsicEventTimeSinceStart)
	IntrinsicInstrumentationNameAttribute    = NewIntrinsic(IntrinsicInstrumentationName)
	IntrinsicInstrumentationVersionAttribute = NewIntrinsic(IntrinsicInstrumentationVersion)
)

func (i Intrinsic) String() string {
	switch i {
	case IntrinsicNone:
		return none
	case IntrinsicDuration:
		return duration
	case IntrinsicName:
		return "name"
	case IntrinsicStatus:
		return "status"
	case IntrinsicStatusMessage:
		return "statusMessage"
	case IntrinsicKind:
		return "kind"
	case IntrinsicChildCount:
		return "span:childCount"
	case IntrinsicEventName:
		return "event:name"
	case IntrinsicEventTimeSinceStart:
		return "event:timeSinceStart"
	case IntrinsicLinkSpanID:
		return "link:spanID"
	case IntrinsicLinkTraceID:
		return "link:traceID"
	case IntrinsicParent:
		return "parent"
	case IntrinsicTraceRootService:
		return "rootServiceName"
	case IntrinsicTraceRootSpan:
		return "rootName"
	case IntrinsicTraceDuration:
		return "traceDuration"
	case IntrinsicTraceID:
		return "trace:id"
	case IntrinsicTraceStartTime:
		return "traceStartTime"
	case ScopedIntrinsicSpanStatus:
		return "span:status"
	case ScopedIntrinsicSpanStatusMessage:
		return "span:statusMessage"
	case ScopedIntrinsicSpanDuration:
		return "span:duration"
	case ScopedIntrinsicSpanName:
		return "span:name"
	case ScopedIntrinsicSpanKind:
		return "span:kind"
	case ScopedIntrinsicTraceRootName:
		return "trace:rootName"
	case ScopedIntrinsicTraceRootService:
		return "trace:rootService"
	case ScopedIntrinsicTraceDuration:
		return "trace:duration"
	case IntrinsicSpanID:
		return "span:id"
	case IntrinsicParentID:
		return "span:parentID"
	case IntrinsicInstrumentationName:
		return "instrumentation:name"
	case IntrinsicInstrumentationVersion:
		return "instrumentation:version"
	// below is unimplemented
	case IntrinsicSpanStartTime:
		return "spanStartTime"
	case IntrinsicNestedSetLeft:
		return "nestedSetLeft"
	case IntrinsicNestedSetRight:
		return "nestedSetRight"
	case IntrinsicNestedSetParent:
		return "nestedSetParent"
	}

	return fmt.Sprintf("intrinsic(%d)", i)
}

// intrinsicFromString returns the matching intrinsic for the given string or -1 if there is none
func intrinsicFromString(s string) Intrinsic {
	switch s {
	case duration:
		return IntrinsicDuration
	case "name":
		return IntrinsicName
	case "status":
		return IntrinsicStatus
	case "statusMessage":
		return IntrinsicStatusMessage
	case "kind":
		return IntrinsicKind
	case "event:name":
		return IntrinsicEventName
	case "event:timeSinceStart":
		return IntrinsicEventTimeSinceStart
	case "link:spanID":
		return IntrinsicLinkSpanID
	case "link:traceID":
		return IntrinsicLinkTraceID
	case "parent":
		return IntrinsicParent
	case "rootServiceName":
		return IntrinsicTraceRootService
	case "rootName":
		return IntrinsicTraceRootSpan
	case "traceDuration":
		return IntrinsicTraceDuration
	case "trace:id":
		return IntrinsicTraceID
	case "traceStartTime":
		return IntrinsicTraceStartTime
	case "span:id":
		return IntrinsicSpanID
	case "span:parentID":
		return IntrinsicParentID
	case "span:status":
		return IntrinsicStatus
	case "span:statusMessage":
		return IntrinsicStatusMessage
	case "span:duration":
		return IntrinsicDuration
	case "span:name":
		return IntrinsicName
	case "span:kind":
		return IntrinsicKind
	case "span:childCount":
		return IntrinsicChildCount
	case "trace:rootName":
		return IntrinsicTraceRootSpan
	case "trace:rootService":
		return IntrinsicTraceRootService
	case "trace:duration":
		return IntrinsicTraceDuration
	case "instrumentation:name":
		return IntrinsicInstrumentationName
	case "instrumentation:version":
		return IntrinsicInstrumentationVersion
	// unimplemented
	case "spanStartTime":
		return IntrinsicSpanStartTime
	case "nestedSetLeft":
		return IntrinsicNestedSetLeft
	case "nestedSetRight":
		return IntrinsicNestedSetRight
	case "nestedSetParent":
		return IntrinsicNestedSetParent
	}

	return IntrinsicNone
}