org.perfcake.reporting.destination

Class InfluxDbDestination

java.lang.Object

org.perfcake.reporting.destination.AbstractDestination

org.perfcake.reporting.destination.InfluxDbDestination

All Implemented Interfaces:

Closeable, AutoCloseable, Destination

public class InfluxDbDestination
extends AbstractDestination

Writes the resulting data to InfluxDb 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. Supports SSL connection. The database is by default created on connection.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
InfluxDbDestination()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the destination.
String	getDatabase() Gets the name of InfluxDb database.
String	getKeyStore() Gets the SSL key store location.
String	getKeyStorePassword() Gets the SSL key store password.
String	getMeasurement() Gets the name of the measurement in InfluxDb, serves as a database table.
String	getPassword() Gets the InfluxDb user password.
String	getServerUrl() Gets InfluxDb server including protocol and port number.
String	getTags() Gets a comma separated list of tags to be added to results.
String	getTrustStore() Gets the SSL trust store location.
String	getTrustStorePassword() Gets the SSL trust store password.
String	getUserName() Gets the name of InfluxDb user.
boolean	isCreateDatabase() Should the database be created upon connecting to InfluxDb?
void	open() Opens the destination for reporting.
void	report(Measurement measurement) Reports a new Measurement to the destination.
InfluxDbDestination	setCreateDatabase(boolean createDatabase) Sets whether the database should be created upon connecting to InfluxDb.
InfluxDbDestination	setDatabase(String database) Sets the name of InfluxDb database.
InfluxDbDestination	setKeyStore(String keyStore) Sets the SSL key store location.
InfluxDbDestination	setKeyStorePassword(String keyStorePassword) Sets the SSL key store password.
InfluxDbDestination	setMeasurement(String measurement) Sets the name of the measurement in InfluxDb, serves as a database table.
InfluxDbDestination	setPassword(String password) Sets the InfluxDb user password.
InfluxDbDestination	setServerUrl(String serverUrl) Sets InfluxDb server including protocol and port number.
InfluxDbDestination	setTags(String tags) Sets a comma separated list of tags to be added to results.
InfluxDbDestination	setTrustStore(String trustStore) Sets the SSL trust store location.
InfluxDbDestination	setTrustStorePassword(String trustStorePassword) Sets the SSL trust store password.
InfluxDbDestination	setUserName(String userName) Sets the name of InfluxDb user.

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

InfluxDbDestination

public InfluxDbDestination()

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 InfluxDb server including protocol and port number. Supports SSL.

Returns:

InfluxDb server including protocol and port number.

setServerUrl

public InfluxDbDestination setServerUrl(String serverUrl)

Sets InfluxDb server including protocol and port number. Supports SSL.

Parameters:

serverUrl - InfluxDb server including protocol and port number.

Returns:

Instance of this to support fluent API.

getDatabase

public String getDatabase()

Gets the name of InfluxDb database.

Returns:

The name of InfluxDb database.

setDatabase

public InfluxDbDestination setDatabase(String database)

Sets the name of InfluxDb database.

Parameters:

database - The name of InfluxDb database.

Returns:

Instance of this to support fluent API.

isCreateDatabase

public boolean isCreateDatabase()

Should the database be created upon connecting to InfluxDb? Defaults to true.

Returns:

True if and only if the database should be created when connected to InfluxDb.

setCreateDatabase

public InfluxDbDestination setCreateDatabase(boolean createDatabase)

Sets whether the database should be created upon connecting to InfluxDb. Dafaults to true.

Parameters:

createDatabase - True if and only if the database should be created when connected to InfluxDb.

Returns:

Instance of this to support fluent API.

getMeasurement

public String getMeasurement()

Gets the name of the measurement in InfluxDb, serves as a database table.

Returns:

The name of the measurement in InfluxDb, serves as a database table.

setMeasurement

public InfluxDbDestination setMeasurement(String measurement)

Sets the name of the measurement in InfluxDb, serves as a database table.

Parameters:

measurement - The name of the measurement in InfluxDb, serves as a database table.

Returns:

Instance of this to support fluent API.

getUserName

public String getUserName()

Gets the name of InfluxDb user.

Returns:

The name of InfluxDb user.

setUserName

public InfluxDbDestination setUserName(String userName)

Sets the name of InfluxDb user.

Parameters:

userName - The name of InfluxDb user.

Returns:

Instance of this to support fluent API.

getPassword

public String getPassword()

Gets the InfluxDb user password.

Returns:

The InfluxDb user password.

setPassword

public InfluxDbDestination setPassword(String password)

Sets the InfluxDb user password.

Parameters:

password - The InfluxDb user password.

Returns:

Instance of this to support fluent API.

getTags

public String getTags()

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

Returns:

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

setTags

public InfluxDbDestination setTags(String tags)

Sets a 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.

getKeyStore

public String getKeyStore()

Gets the SSL key store location.

Returns:

The SSL key store location.

setKeyStore

public InfluxDbDestination 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 InfluxDbDestination 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 InfluxDbDestination 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 InfluxDbDestination setTrustStorePassword(String trustStorePassword)

Sets the SSL trust store password.

Parameters:

trustStorePassword - The SSL trust store password.

Returns:

Instance of this to support fluent API.