software.amazon.awssdk.metrics

Class LoggingMetricPublisher

java.lang.Object

software.amazon.awssdk.metrics.LoggingMetricPublisher

All Implemented Interfaces:

AutoCloseable, MetricPublisher, SdkAutoCloseable

public final class LoggingMetricPublisher
extends Object
implements MetricPublisher

An implementation of MetricPublisher that writes all published metrics to the logs at the INFO level under the software.amazon.awssdk.metrics.LoggingMetricPublisher namespace. NOTE: This is a Preview API and is subject to change so it should not be used in production.

Method Summary

Modifier and Type	Method and Description
void	close()
static LoggingMetricPublisher	create()
void	publish(MetricCollection metricCollection) Notify the publisher of new metric data.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static LoggingMetricPublisher create()

publish

public void publish(MetricCollection metricCollection)

Description copied from interface: MetricPublisher

Notify the publisher of new metric data. After this call returns, the caller can safely discard the given metricCollection instance if it no longer needs it. Implementations are strongly encouraged to complete any further aggregation and publishing of metrics in an asynchronous manner to avoid blocking the calling thread.

With the exception of a null metricCollection, all invocations of this method must return normally. This is to ensure that callers of the publisher can safely assume that even in situations where an error happens during publishing that it will not interrupt the calling thread.

Specified by:

publish in interface MetricPublisher

Parameters:

metricCollection - The collection of metrics.

close

public void close()

Description copied from interface: MetricPublisher

Important: Implementations must block the calling thread until all pending metrics are published and any resources acquired have been freed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MetricPublisher

Specified by:

close in interface SdkAutoCloseable