software.amazon.cloudwatchlogs.emf.sinks

Class AgentSink

java.lang.Object

software.amazon.cloudwatchlogs.emf.sinks.AgentSink

All Implemented Interfaces:

ISink

public class AgentSink
extends java.lang.Object
implements ISink

An sink connecting to an agent over a socket.

Constructor Summary

Constructors

Constructor and Description
AgentSink(java.lang.String logGroupName, java.lang.String logStreamName, Endpoint endpoint, SocketClientFactory clientFactory, int asyncQueueDepth, java.util.function.Supplier<RetryStrategy> retryStrategy)

Method Summary

Modifier and Type	Method and Description
void	accept(MetricsContext context) Accept MetricsContext to sink to CloudWatch.
java.util.concurrent.CompletableFuture<java.lang.Void>	shutdown() Shutdown the sink.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgentSink

public AgentSink(java.lang.String logGroupName,
                 java.lang.String logStreamName,
                 Endpoint endpoint,
                 SocketClientFactory clientFactory,
                 int asyncQueueDepth,
                 java.util.function.Supplier<RetryStrategy> retryStrategy)

Method Detail

accept

public void accept(MetricsContext context)

Description copied from interface: ISink

Accept MetricsContext to sink to CloudWatch.

Specified by:

accept in interface ISink

Parameters:

context - MetricsContext

shutdown

public java.util.concurrent.CompletableFuture<java.lang.Void> shutdown()

Description copied from interface: ISink

Shutdown the sink. The returned CompletableFuture will be completed when all queued events have been flushed. After this is called, no more metrics can be sent through this sink and attempting to continue to re-use the sink will result in undefined behavior.

Specified by:

shutdown in interface ISink

Returns:

a future that completes when the shutdown has completed successfully and all pending messages have been sent to the destination.