instrumentation

Documentation

Index

• func InjectAnnotationKey(instType Type) string
• func NewMutator(logger logr.Logger, client client.Client, recorder record.EventRecorder) *instPodMutator
• type AnnotationMutation
  • func NewInsertAnnotationMutation(annotations map[string]string) AnnotationMutation
  • func NewRemoveAnnotationMutation(annotations []string) AnnotationMutation
• type AnnotationMutator
  • func NewAnnotationMutator(mutations []AnnotationMutation) AnnotationMutator
  • func (m *AnnotationMutator) Mutate(obj metav1.Object) bool
• type Type
• type TypeSet
  • func NewTypeSet(types ...Type) TypeSet

Functions

func InjectAnnotationKey

func InjectAnnotationKey(instType Type) string

InjectAnnotationKey maps the instrumentation type to the inject annotation.

func NewMutator

func NewMutator(logger logr.Logger, client client.Client, recorder record.EventRecorder) *instPodMutator

Types

type AnnotationMutation

type AnnotationMutation interface {
	// Mutate attempts to modify the annotations map. Returns whether the function changed the annotations.
	Mutate(annotations map[string]string) bool
}

AnnotationMutation is used to modify an annotation map.

func NewInsertAnnotationMutation

func NewInsertAnnotationMutation(annotations map[string]string) AnnotationMutation

NewInsertAnnotationMutation creates a new mutation that inserts annotations. All provided annotation keys must be present for it to attempt to insert.

func NewRemoveAnnotationMutation

func NewRemoveAnnotationMutation(annotations []string) AnnotationMutation

NewRemoveAnnotationMutation creates a new mutation that removes annotations. All provided annotation keys must be present for it to attempt to remove them.

type AnnotationMutator

type AnnotationMutator struct {
	// contains filtered or unexported fields
}

func NewAnnotationMutator

func NewAnnotationMutator(mutations []AnnotationMutation) AnnotationMutator

NewAnnotationMutator creates a mutator with the provided mutations that can mutate an Object's annotations.

func (*AnnotationMutator) Mutate

func (m *AnnotationMutator) Mutate(obj metav1.Object) bool

Mutate modifies the object's annotations based on the mutator's mutations. Returns whether any of the mutations changed the annotations.

type Type

type Type string

Type is an enum for instrumentation types.

const (
	TypeJava   Type = "java"
	TypeNodeJS Type = "nodejs"
	TypePython Type = "python"
	TypeDotNet Type = "dotnet"
	TypeGo     Type = "go"
)

type TypeSet

type TypeSet map[Type]any

TypeSet is a map with Type keys.

func NewTypeSet

func NewTypeSet(types ...Type) TypeSet

NewTypeSet creates a new set of Type.