pipeline

Documentation

Index

• Variables
• type ID
  • func NewID(signal Signal) ID
  • func NewIDWithName(signal Signal, name string) ID
  • func (i ID) MarshalText() (text []byte, err error)
  • func (i ID) Name() string
  • func (i ID) Signal() Signal
  • func (i ID) String() string
  • func (i *ID) UnmarshalText(text []byte) error
• type Signal

Variables

var (
	SignalTraces  = globalsignal.SignalTraces
	SignalMetrics = globalsignal.SignalMetrics
	SignalLogs    = globalsignal.SignalLogs
)

var ErrSignalNotSupported = errors.New("telemetry type is not supported")

Types

type ID

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

ID represents the identity for a pipeline. It combines two values: * signal - the Signal of the pipeline. * name - the name of that pipeline.

func NewID

func NewID(signal Signal) ID

NewID returns a new ID with the given Signal and empty name.

func NewIDWithName

func NewIDWithName(signal Signal, name string) ID

NewIDWithName returns a new ID with the given Signal and name.

func (ID) MarshalText

func (i ID) MarshalText() (text []byte, err error)

MarshalText implements the encoding.TextMarshaler interface. This marshals the Signal and name as one string in the config.

func (ID) Name

func (i ID) Name() string

Name returns the name of the ID.

func (ID) Signal

func (i ID) Signal() Signal

Signal returns the Signal of the ID.

func (ID) String

func (i ID) String() string

String returns the ID string representation as "signal[/name]" format.

func (*ID) UnmarshalText

func (i *ID) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

type Signal

type Signal = globalsignal.Signal

Signal represents the signals supported by the collector. We currently support collecting metrics, traces and logs, this can expand in the future.