jenkins.plugins.logstash.persistence

Interface LogstashIndexerDao

All Known Implementing Classes:

ElasticSearchDao, RabbitMqDao, RedisDao

public interface LogstashIndexerDao

Interface describing data access objects for Logstash indexers.

Since:

1.0.0

Author:

Rusty Gerard

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LogstashIndexerDao.IndexerType

Method Summary

Methods

Modifier and Type	Method and Description
net.sf.json.JSONObject	buildPayload(BuildData buildData, String jenkinsUrl, List<String> logLines) Builds a JSON payload compatible with the Logstash schema.
String	getHost()
LogstashIndexerDao.IndexerType	getIndexerType()
int	getPort()
long	push(String data, PrintStream logger) Sends the log data to the Logstash indexer.

Method Detail

getPort

int getPort()

getHost

String getHost()

getIndexerType

LogstashIndexerDao.IndexerType getIndexerType()

push

long push(String data,
        PrintStream logger)

Sends the log data to the Logstash indexer.

Parameters:

data - The serialized data, not null

logger - A logger to append messages to, not null

Returns:

The number of elements pushed, -1 indicates an error occurred

buildPayload

net.sf.json.JSONObject buildPayload(BuildData buildData,
                                  String jenkinsUrl,
                                  List<String> logLines)

Builds a JSON payload compatible with the Logstash schema.

Parameters:

buildData - Metadata about the current build, not null

jenkinsUrl - The host name of the Jenkins instance, not null

logLines - The log data to transmit, not null

Returns:

The formatted JSON object, never null