plugins/forwarder/api/forwarder.go

// Licensed to Apache Software Foundation (ASF) under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Apache Software Foundation (ASF) licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package api

import (
	"reflect"

	"google.golang.org/grpc"
	v1 "skywalking.apache.org/repo/goapi/satellite/data/v1"

	"github.com/apache/skywalking-satellite/internal/pkg/plugin"
	"github.com/apache/skywalking-satellite/internal/satellite/event"
)

// Forwarder is a plugin interface, that defines new forwarders.
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
}

// ForwardFunc represent the Forward() in Forwarder
type ForwardFunc func(batch event.BatchEvents) error

// GetForwarder an initialized filter plugin.
func GetForwarder(config plugin.Config) Forwarder {
	return plugin.Get(reflect.TypeOf((*Forwarder)(nil)).Elem(), config).(Forwarder)
}