org.perfcake.reporting.destination

Class ElasticsearchDestination

java.lang.Object

org.perfcake.reporting.destination.AbstractDestination

org.perfcake.reporting.destination.ElasticsearchDestination

All Implemented Interfaces:

Closeable, AutoCloseable, Destination

public class ElasticsearchDestination
extends AbstractDestination

Writes the resulting data to Elasticsearch using a simple HTTP REST client. The reported data have information about the test progress (time in milliseconds since start, percentage and iteration), real time of each result, and the complete results map. Quantities are stored without their unit. To properly search through the data, we need to set the mapping (to be able to interpret time as time). However, this needs to be done just once for each index and type.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
ElasticsearchDestination()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the destination.
String	getIndex() Gets the Elasticsearch index name.
String	getKeyStore() Gets the SSL key store location.
String	getKeyStorePassword() Gets the SSL key store password.
String	getPassword() Gets the Elasticsearch password.
String	getServerUrl() Gets the comma separated list of Elasticsearch servers including protocol and port number.
String	getTags() Gets the comma separated list of tags to be added to results.
int	getTimeout() Gets the Elasticsearch client timeout.
String	getTrustStore() Gets the SSL trust store location.
String	getTrustStorePassword() Gets the SSL trust store password.
String	getType() Gets the Elasticsearch type name.
String	getUserName() Gets the Elasticsearch user name.
boolean	isConfigureMapping() Gets whether the mapping of data should be configured prior to writing.
void	open() Opens the destination for reporting.
void	report(Measurement measurement) Reports a new Measurement to the destination.
ElasticsearchDestination	setConfigureMapping(boolean configureMapping) Sets whether the mapping of data should be configured prior to writing.
ElasticsearchDestination	setIndex(String index) Sets the Elasticsearch index name.
ElasticsearchDestination	setKeyStore(String keyStore) Sets the SSL key store location.
ElasticsearchDestination	setKeyStorePassword(String keyStorePassword) Sets the SSL key store password.
ElasticsearchDestination	setPassword(String password) Sets the Elasticsearch password.
ElasticsearchDestination	setServerUrl(String serverUrl) Sets the comma separated list of Elasticsearch servers including protocol and port number.
ElasticsearchDestination	setTags(String tags) Sets the comma separated list of tags to be added to results.
ElasticsearchDestination	setTimeout(int timeout) Sets the Elasticsearch client timeout.
ElasticsearchDestination	setTrustStore(String trustStore) Sets the SSL trust store location.
ElasticsearchDestination	setTrustStorePassword(String trustStorePassword) Sets the SSL trust store password.
ElasticsearchDestination	setType(String type) Sets the Elasticsearch type name.
ElasticsearchDestination	setUserName(String userName) Sets the Elasticsearch user name.

Methods inherited from class org.perfcake.reporting.destination.AbstractDestination

getParentReporter, open

Methods inherited from class java.lang.Object

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

Constructor Detail

ElasticsearchDestination

public ElasticsearchDestination()

Method Detail

open

public void open()

Description copied from class: AbstractDestination

Opens the destination for reporting.

Specified by:

open in class AbstractDestination

close

public void close()

Description copied from interface: Destination

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

report

public void report(Measurement measurement)
            throws ReportingException

Description copied from interface: Destination

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.

getServerUrl

public String getServerUrl()

Gets the comma separated list of Elasticsearch servers including protocol and port number.

Returns:

The comma separated list of Elasticsearch servers including protocol and port number.

setServerUrl

public ElasticsearchDestination setServerUrl(String serverUrl)

Sets the comma separated list of Elasticsearch servers including protocol and port number.

Parameters:

serverUrl - The comma separated list of Elasticsearch servers including protocol and port number.

Returns:

Instance of this to support fluent API.

getIndex

public String getIndex()

Gets the Elasticsearch index name.

Returns:

The Elasticsearch index name.

setIndex

public ElasticsearchDestination setIndex(String index)

Sets the Elasticsearch index name.

Parameters:

index - The Elasticsearch index name.

Returns:

Instance of this to support fluent API.

getType

public String getType()

Gets the Elasticsearch type name.

Returns:

the Elasticsearch type name.

setType

public ElasticsearchDestination setType(String type)

Sets the Elasticsearch type name.

Parameters:

type - the Elasticsearch type name.

Returns:

Instance of this to support fluent API.

getTags

public String getTags()

Gets the comma separated list of tags to be added to results.

Returns:

The comma separated list of tags to be added to results.

setTags

public ElasticsearchDestination setTags(String tags)

Sets the comma separated list of tags to be added to results.

Parameters:

tags - The comma separated list of tags to be added to results.

Returns:

Instance of this to support fluent API.

getUserName

public String getUserName()

Gets the Elasticsearch user name.

Returns:

The Elasticsearch user name.

setUserName

public ElasticsearchDestination setUserName(String userName)

Sets the Elasticsearch user name.

Parameters:

userName - The Elasticsearch user name.

Returns:

Instance of this to support fluent API.

getPassword

public String getPassword()

Gets the Elasticsearch password.

Returns:

The Elasticsearch password.

setPassword

public ElasticsearchDestination setPassword(String password)

Sets the Elasticsearch password.

Parameters:

password - The Elasticsearch password.

Returns:

Instance of this to support fluent API.

isConfigureMapping

public boolean isConfigureMapping()

Gets whether the mapping of data should be configured prior to writing. To properly search through the data, we need to set the mapping. However, this needs to be done just once for each index and type.

Returns:

True if and only if the mapping will be configured prior to writing.

setConfigureMapping

public ElasticsearchDestination setConfigureMapping(boolean configureMapping)

Sets whether the mapping of data should be configured prior to writing. To properly search through the data, we need to set the mapping. However, this needs to be done just once for each index and type.

Parameters:

configureMapping - True if the mapping should be configured prior to writing.

Returns:

Instance of this to support fluent API.

getTimeout

public int getTimeout()

Gets the Elasticsearch client timeout.

Returns:

The Elasticsearch client timeout.

setTimeout

public ElasticsearchDestination setTimeout(int timeout)

Sets the Elasticsearch client timeout.

Parameters:

timeout - The Elasticsearch client timeout.

Returns:

Instance of this to support fluent API.

getKeyStore

public String getKeyStore()

Gets the SSL key store location.

Returns:

The SSL key store location.

setKeyStore

public ElasticsearchDestination setKeyStore(String keyStore)

Sets the SSL key store location.

Parameters:

keyStore - The SSL key store location.

Returns:

Instance of this to support fluent API.

getKeyStorePassword

public String getKeyStorePassword()

Gets the SSL key store password.

Returns:

The SSL key store password.

setKeyStorePassword

public ElasticsearchDestination setKeyStorePassword(String keyStorePassword)

Sets the SSL key store password.

Parameters:

keyStorePassword - The SSL key store password.

Returns:

Instance of this to support fluent API.

getTrustStore

public String getTrustStore()

Gets the SSL trust store location.

Returns:

The SSL trust store location.

setTrustStore

public ElasticsearchDestination setTrustStore(String trustStore)

Sets the SSL trust store location.

Parameters:

trustStore - The SSL trust store location.

Returns:

Instance of this to support fluent API.

getTrustStorePassword

public String getTrustStorePassword()

Gets the SSL trust store password.

Returns:

The SSL trust store password.

setTrustStorePassword

public ElasticsearchDestination setTrustStorePassword(String trustStorePassword)

Sets the SSL trust store password.

Parameters:

trustStorePassword - The SSL trust store password.

Returns:

Instance of this to support fluent API.