flow

Documentation

Index

• func CollectMetrics(options ...option) error
• func New(flow *nspAPI.Flow, lb types.NFQueueLoadBalancer) (types.Flow, error)
• func WithConduitName(conduitName string) option
• func WithGetFlowStatsFunc(getFlowStatsFunc GetFlowStats) option
• func WithHostname(hostname string) option
• func WithMeter(meter metric.Meter) option
• func WithTrenchName(trenchName string) option
• type Flow
  • func (f *Flow) Delete() error
  • func (f *Flow) Update(flow *nspAPI.Flow) error
• type FlowStat
• type GetFlowStats

Functions

func CollectMetrics

func CollectMetrics(options ...option) error

CollectMetrics collects the metrics for the flows. This function will continue to run until the context is cancel.

func New

func New(flow *nspAPI.Flow, lb types.NFQueueLoadBalancer) (types.Flow, error)

New creates a new flow

func WithConduitName

func WithConduitName(conduitName string) option

WithConduitName specifies the conduit attribute.

func WithGetFlowStatsFunc

func WithGetFlowStatsFunc(getFlowStatsFunc GetFlowStats) option

WithGetFlowStatsFunc specifies which function will be used to get the flow metrics.

func WithHostname

func WithHostname(hostname string) option

WithHostname specifies the hostname attribute.

func WithMeter

func WithMeter(meter metric.Meter) option

WithMeter specifies the meter for the metric collection.

func WithTrenchName

func WithTrenchName(trenchName string) option

WithTrenchName specifies the trench attribute.

Types

type Flow

type Flow struct {
	*nspAPI.Flow
	// contains filtered or unexported fields
}

Flow holds flow data

func (*Flow) Delete

func (f *Flow) Delete() error

Delete deletes a flow

func (*Flow) Update

func (f *Flow) Update(flow *nspAPI.Flow) error

Update updates a flow

type FlowStat

type FlowStat interface {
	GetFlow() *nspAPI.Flow
	GetMatchesCount() int
}

type GetFlowStats

type GetFlowStats func() ([]FlowStat, error)