api

Documentation

Index

• type ForwardFunc
• type Forwarder
  • func GetForwarder(config plugin.Config) Forwarder

Types

type ForwardFunc

type ForwardFunc func(batch event.BatchEvents) error

ForwardFunc represent the Forward() in Forwarder

type Forwarder

type Forwarder interface {
	plugin.Plugin
	// Prepare do some preparation works, such as create a stub in gRPC and create a producer in Kafka.
	Prepare(connection interface{}) error
	// Forward the batch events to the external services, such as Kafka MQ and SkyWalking OAP cluster.
	Forward(batch event.BatchEvents) error
	// SyncForward the single event to the external service with sync forward
	// The returned result grpc.ClientStream is the stream initiated by satellite to oap server,
	// which is used to provide bidirectional stream support
	SyncForward(event *v1.SniffData) (*v1.SniffData, grpc.ClientStream, error)
	// ForwardType returns the supported event type.
	ForwardType() v1.SniffType
	// SupportedSyncInvoke return is support SyncForward
	SupportedSyncInvoke() bool
}

Forwarder is a plugin interface, that defines new forwarders.

func GetForwarder

func GetForwarder(config plugin.Config) Forwarder

GetForwarder an initialized filter plugin.