jenkins.plugins.logstash.persistence

Interface LogstashIndexerDao

All Known Implementing Classes:

ElasticSearchDao, RabbitMqDao, RedisDao, SyslogDao

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	getDescription()
LogstashIndexerDao.IndexerType	getIndexerType()
void	push(String data) Sends the log data to the Logstash indexer.

Method Detail

getDescription

String getDescription()

getIndexerType

LogstashIndexerDao.IndexerType getIndexerType()

push

void push(String data)
          throws IOException

Sends the log data to the Logstash indexer.

Parameters:

data - The serialized data, not null

Throws:

IOException - The data is not written to the server

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