org.perfcake.reporting.destination

Interface Destination

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractDestination, ConsoleDestination, CsvDestination, ElasticsearchDestination, ChartDestination, InfluxDbDestination, Log4jDestination

public interface Destination
extends Closeable

A channel to which performance measurement results can be reported. Destinations are registered with Reporters and are completely controlled by them. The only responsibility of a destination is to open a reporting channel, report measurements, and close the reporting channel. It is the role of Measurement to provide all the information to be reported (including value types, names, units and custom labels).

Author:

Martin Večeřa

Method Summary

Modifier and Type	Method and Description
void	close() Closes the destination.
void	open(Reporter parentReporter) Opens the destination for reporting.
void	report(Measurement measurement) Reports a new Measurement to the destination.

Method Detail

open

void open(Reporter parentReporter)

Opens the destination for reporting.

Parameters:

parentReporter - Reporter opening the destination.

close

void close()

Closes the destination. No other value should be reported after that.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

report

void report(Measurement measurement)
     throws ReportingException

Reports a new Measurement to the destination.

Parameters:

measurement - A measurement to be reported.

Throws:

ReportingException - When an error occurred during reporting the measurement like no space left on device. The root cause should be encapsulated.