Documentation
¶
Index ¶
- func FlowIDBundle(b *bundle.Environment) *bundle.Environment
- type EventType
- type NodeEvent
- func EventConsumeOf(part *message.Part) NodeEvent
- func EventDeleteOf() NodeEventdeprecated
- func EventDeleteOfPart(part *message.Part) NodeEvent
- func EventErrorOf(err error) NodeEventdeprecated
- func EventErrorOfPart(part *message.Part, err error) NodeEvent
- func EventProduceOf(part *message.Part) NodeEvent
- type Summary
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FlowIDBundle ¶ added in v1.15.0
func FlowIDBundle(b *bundle.Environment) *bundle.Environment
FlowIDBundle modifies a provided bundle environment so that all inputs are wrapped to ensure flow IDs are initialized on all messages. This is independent of tracing and should be applied to all builds.
Types ¶
type EventType ¶
type EventType string
EventType describes the type of event a component might experience during a config run.
type NodeEvent ¶
type NodeEvent struct {
Type EventType
Content string
Meta map[string]any
FlowID string
Timestamp time.Time
}
NodeEvent represents a single event that occurred within the stream.
func EventConsumeOf ¶
EventConsumeOf creates a consumed event from a message part.
func EventDeleteOf
deprecated
func EventDeleteOf() NodeEvent
EventDeleteOf creates a deleted event from a message part.
Deprecated: Use EventDeleteOfPart instead. This function cannot track flow IDs.
func EventDeleteOfPart ¶ added in v1.15.0
EventDeleteOfPart creates a deleted event with flow ID from a message part.
func EventErrorOf
deprecated
func EventErrorOfPart ¶ added in v1.15.0
EventErrorOfPart creates an error event with flow ID from a message part.
func EventProduceOf ¶
EventProduceOf creates a produce event from a message part.
type Summary ¶
type Summary struct {
Input uint64
Output uint64
ProcessorErrors uint64
// contains filtered or unexported fields
}
Summary is a high level description of all traced events.
func NewSummary ¶
func NewSummary() *Summary
NewSummary creates a new tracing summary that can be passed to component constructors for adding traces.
func TracedBundle ¶
func TracedBundle(b *bundle.Environment) (*bundle.Environment, *Summary)
TracedBundle modifies a provided bundle environment so that traceable components are wrapped by components that add trace events to the returned summary.
func (*Summary) InputEvents ¶
InputEvents returns a map of input labels to events traced during the execution of a stream pipeline. Set flush to true in order to clear the events after obtaining them.
func (*Summary) OutputEvents ¶
OutputEvents returns a map of output labels to events traced during the execution of a stream pipeline.
func (*Summary) ProcessorEvents ¶
ProcessorEvents returns a map of processor labels to events traced during the execution of a stream pipeline.
func (*Summary) SetEnabled ¶
SetEnabled sets whether tracing events are enabled across the stream.
func (*Summary) SetEventLimit ¶
SetEventLimit sets a limit as to how many event traces are stored, this limit is per component that's traced.
Source Files