channel

Documentation

Index

• Constants
• Variables
• func ReportEventCountMetricsForDispatchError(err error, reporter StatsReporter, args *ReportArgs)
• type BadRequestError
  • func (e BadRequestError) Error() string
• type ChannelReference
  • func ParseChannelFromHost(host string) (ChannelReference, error)
  • func ParseChannelFromPath(path string) (ChannelReference, error)
  • func (r *ChannelReference) String() string
• type EventReceiver
  • func NewEventReceiver(receiverFunc EventReceiverFunc, logger *zap.Logger, reporter StatsReporter, ...) (*EventReceiver, error)
  • func (r *EventReceiver) ServeHTTP(response nethttp.ResponseWriter, request *nethttp.Request)
  • func (r *EventReceiver) Start(ctx context.Context) error
• type EventReceiverFunc
• type EventReceiverOptions
  • func OIDCTokenVerification(tokenVerifier *auth.OIDCTokenVerifier, audience string) EventReceiverOptions
  • func ReceiverWithContextFunc(fn func(context.Context) context.Context) EventReceiverOptions
  • func ResolveChannelFromHostHeader(hostToChannelFunc ResolveChannelFromHostFunc) EventReceiverOptions
  • func ResolveChannelFromPath(PathToChannelFunc ResolveChannelFromPathFunc) EventReceiverOptions
• type ReportArgs
• type ResolveChannelFromHostFunc
• type ResolveChannelFromPathFunc
• type StatsReporter
  • func NewStatsReporter(container, uniqueName string) StatsReporter
• type UnknownChannelError
  • func (e *UnknownChannelError) Error() string
• type UnknownHostError
  • func (e UnknownHostError) Error() string

Constants

const (
	// LabelUniqueName is the label for the unique name per stats_reporter instance.
	LabelUniqueName = "unique_name"

	// LabelContainerName is the label for the immutable name of the container.
	LabelContainerName = metrics.LabelContainerName
)

Variables

var (
	ContainerTagKey = tag.MustNewKey(LabelContainerName)
	UniqueTagKey    = tag.MustNewKey(LabelUniqueName)
)

Functions

func ReportEventCountMetricsForDispatchError

func ReportEventCountMetricsForDispatchError(err error, reporter StatsReporter, args *ReportArgs)

Types

type BadRequestError

type BadRequestError string

func (BadRequestError) Error

func (e BadRequestError) Error() string

type ChannelReference

type ChannelReference struct {
	Namespace string
	Name      string
}

ChannelReference references a Channel within the cluster by name and namespace.

func ParseChannelFromHost

func ParseChannelFromHost(host string) (ChannelReference, error)

ParseChannelFromHost determines a Channel reference from a host

func ParseChannelFromPath

func ParseChannelFromPath(path string) (ChannelReference, error)

ParseChannelFromPath determines a Channel reference from a URL path

func (*ChannelReference) String

func (r *ChannelReference) String() string

type EventReceiver

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

EventReceiver starts a server to receive new events for the channel dispatcher. The new event is emitted via the receiver function.

func NewEventReceiver

func NewEventReceiver(receiverFunc EventReceiverFunc, logger *zap.Logger, reporter StatsReporter, opts ...EventReceiverOptions) (*EventReceiver, error)

NewEventReceiver creates an event receiver passing new events to the receiverFunc.

func (*EventReceiver) ServeHTTP

func (r *EventReceiver) ServeHTTP(response nethttp.ResponseWriter, request *nethttp.Request)

func (*EventReceiver) Start

func (r *EventReceiver) Start(ctx context.Context) error

Start begins to receive events for the receiver.

Only HTTP POST requests to the root path (/) are accepted. If other paths or methods are needed, use the HandleRequest method directly with another HTTP server.

type EventReceiverFunc

type EventReceiverFunc func(context.Context, ChannelReference, event.Event, nethttp.Header) error

EventReceiverFunc is the function to be called for handling the event.

type EventReceiverOptions

type EventReceiverOptions func(*EventReceiver) error

ReceiverOptions provides functional options to EventReceiver function.

func OIDCTokenVerification

func OIDCTokenVerification(tokenVerifier *auth.OIDCTokenVerifier, audience string) EventReceiverOptions

func ReceiverWithContextFunc

func ReceiverWithContextFunc(fn func(context.Context) context.Context) EventReceiverOptions

func ResolveChannelFromHostHeader

func ResolveChannelFromHostHeader(hostToChannelFunc ResolveChannelFromHostFunc) EventReceiverOptions

ResolveChannelFromHostHeader is a ReceiverOption for NewEventReceiver which enables the caller to overwrite the default behaviour defined by ParseChannelFromHost function.

func ResolveChannelFromPath

func ResolveChannelFromPath(PathToChannelFunc ResolveChannelFromPathFunc) EventReceiverOptions

ResolveChannelFromPath is a ReceiverOption for NewEventReceiver which enables the caller to overwrite the default behaviour defined by ParseChannelFromPath function.

type ReportArgs

type ReportArgs struct {
	Ns          string
	EventType   string
	EventScheme string
}

type ResolveChannelFromHostFunc

type ResolveChannelFromHostFunc func(string) (ChannelReference, error)

ResolveChannelFromHostFunc function enables EventReceiver to get the Channel Reference from incoming request HostHeader before calling receiverFunc. Returns UnknownHostError if the channel is not found, otherwise returns a generic error.

type ResolveChannelFromPathFunc

type ResolveChannelFromPathFunc func(string) (ChannelReference, error)

ResolveChannelFromPathFunc function enables EventReceiver to get the Channel Reference from incoming request's path before calling receiverFunc.

type StatsReporter

type StatsReporter interface {
	ReportEventCount(args *ReportArgs, responseCode int) error
	ReportEventDispatchTime(args *ReportArgs, responseCode int, d time.Duration) error
}

func NewStatsReporter

func NewStatsReporter(container, uniqueName string) StatsReporter

NewStatsReporter creates a reporter that collects and reports channel metrics.

type UnknownChannelError

type UnknownChannelError struct {
	Channel ChannelReference
}

UnknownChannelError represents the error when an event is received by a channel dispatcher for a channel that does not exist.

func (*UnknownChannelError) Error

func (e *UnknownChannelError) Error() string

type UnknownHostError

type UnknownHostError string

UnknownHostError represents the error when a ResolveChannelFromHostHeader func cannot resolve an host

func (UnknownHostError) Error

func (e UnknownHostError) Error() string