mirror of
https://github.com/Icinga/icingabeat.git
synced 2025-09-02 15:48:09 +02:00
39 lines
1.3 KiB
Go
39 lines
1.3 KiB
Go
// Package outputs defines common types and interfaces to be implemented by
|
|
// output plugins.
|
|
|
|
package outputs
|
|
|
|
import (
|
|
"github.com/elastic/beats/libbeat/publisher"
|
|
)
|
|
|
|
// Client provides the minimal interface an output must implement to be usable
|
|
// with the publisher pipeline.
|
|
type Client interface {
|
|
Close() error
|
|
|
|
// Publish sends events to the clients sink. A client must synchronously or
|
|
// asynchronously ACK the given batch, once all events have been processed.
|
|
// Using Retry/Cancelled a client can return a batch of unprocessed events to
|
|
// the publisher pipeline. The publisher pipeline (if configured by the output
|
|
// factory) will take care of retrying/dropping events.
|
|
Publish(publisher.Batch) error
|
|
}
|
|
|
|
// NetworkClient defines the required client capabilities for network based
|
|
// outputs, that must be reconnectable.
|
|
type NetworkClient interface {
|
|
Client
|
|
Connectable
|
|
}
|
|
|
|
// Connectable is optionally implemented by clients that might be able to close
|
|
// and reconnect dynamically.
|
|
type Connectable interface {
|
|
// Connect establishes a connection to the clients sink.
|
|
// The connection attempt shall report an error if no connection could been
|
|
// established within the given time interval. A timeout value of 0 == wait
|
|
// forever.
|
|
Connect() error
|
|
}
|