Struct vector::sinks::util::http::BatchedHttpSink

pub struct BatchedHttpSink<T, B, RL = HttpRetryLogic>
where
    B: Batch,
    B::Output: ByteSizeOf + Clone + Send + 'static,
    T: HttpSink<Input = B::Input, Output = B::Output>,
    RL: RetryLogic<Response = Response<Bytes>> + Send + 'static,
{ /* private fields */ }

Provides a simple wrapper around internal tower and batching sinks for http.

This type wraps some HttpSink and some Batch type and will apply request, batch and tls settings. Internally, it holds an Arc reference to the HttpSink. It then exposes a Sink interface that can be returned from SinkConfig.

Implementation details we require to buffer a single item due to how Sink works. This is because we must “encode” the type to be able to send it to the inner batch type and sink. Because of this we must provide a single buffer slot. To ensure the buffer is fully flushed make sure poll_flush returns ready.

Note: This has been deprecated, please do not use when creating new Sinks.

Implementations

impl<T, B> BatchedHttpSink<T, B>

where B: Batch, B::Output: ByteSizeOf + Clone + Send + 'static, T: HttpSink<Input = B::Input, Output = B::Output>,

pub fn new( sink: T, batch: B, request_settings: TowerRequestSettings, batch_timeout: Duration, client: HttpClient, ) -> Self

impl<T, B, RL> BatchedHttpSink<T, B, RL>

where B: Batch, B::Output: ByteSizeOf + Clone + Send + 'static, RL: RetryLogic<Response = Response<Bytes>, Error = HttpError> + Send + 'static, T: HttpSink<Input = B::Input, Output = B::Output>,

pub fn with_logic( sink: T, batch: B, retry_logic: RL, request_settings: TowerRequestSettings, batch_timeout: Duration, client: HttpClient, ) -> Self

Trait Implementations

impl<T, B, RL> Sink<Event> for BatchedHttpSink<T, B, RL>

where B: Batch, B::Output: ByteSizeOf + Clone + Send + 'static, T: HttpSink<Input = B::Input, Output = B::Output>, RL: RetryLogic<Response = Response<Bytes>> + Send + 'static,

type Error = Box<dyn Error + Sync + Send>

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, event: Event) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<'pin, T, B, RL> Unpin for BatchedHttpSink<T, B, RL>

where B: Batch, B::Output: ByteSizeOf + Clone + Send + 'static, T: HttpSink<Input = B::Input, Output = B::Output>, RL: RetryLogic<Response = Response<Bytes>> + Send + 'static, PinnedFieldsOf<__BatchedHttpSink<'pin, T, B, RL>>: Unpin,