com.googlecode.jmxtrans.model.output.elastic

Class ElasticAggregateWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.elastic.ElasticAggregateWriter

All Implemented Interfaces:

com.googlecode.jmxtrans.model.OutputWriter, com.googlecode.jmxtrans.model.OutputWriterFactory, AutoCloseable

public class ElasticAggregateWriter
extends com.googlecode.jmxtrans.model.output.BaseOutputWriter

JMXTrans output writer for Elasticsearch which outputs one structured document for each query. Documents pushed to Elastic have two automatically generated attributes, @metadata and @timestamp. An example of metrics obtained for a JMS queue would be:

 {
        "@timestamp": 1463071268789,
        "@metadata": {
                "typeName": "module=Core,type=Queue,address=\"jms.queue.nb8Queue\",name=\"jms.queue.nb8Queue\"",
                "server": "server.example.com",
                "typeNameValues": "Queue_\"jms.queue.nb8Queue\"_\"jms.queue.nb8Queue\"",
                "port": "9990"
        },
        "MessagesAdded": 0,
        "Temporary": false,
        "ConsumerCount": 20,
        "DeliveringCount": 0,
        "Durable": false,
        "MessageCount": 0,
        "ScheduledCount": 0
 }

Field Summary

Fields inherited from class com.googlecode.jmxtrans.model.output.BaseOutputWriter

BINARY_PATH, BOOLEAN_AS_NUMBER, DEBUG, HOST, OUTPUT_FILE, PORT, TEMPLATE_FILE, TYPE_NAMES

Constructor Summary

Constructors

Constructor and Description
ElasticAggregateWriter(com.google.common.collect.ImmutableList<String> typeNames, boolean booleanAsNumber, Boolean debugEnabled, String elasticHostName, String elasticClusterName, String elasticIndexName, String elasticTypeName, Map<String,Object> settings)

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	internalWrite(com.googlecode.jmxtrans.model.Server server, com.googlecode.jmxtrans.model.Query query, com.google.common.collect.ImmutableList<com.googlecode.jmxtrans.model.Result> results)
void	start()
void	validateSetup(com.googlecode.jmxtrans.model.Server server, com.googlecode.jmxtrans.model.Query query)

Methods inherited from class com.googlecode.jmxtrans.model.output.BaseOutputWriter

create, doWrite, firstNonNull, getConcatedTypeNameValues, getSettings, getTypeNames, isDebugEnabled, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ElasticAggregateWriter

public ElasticAggregateWriter(com.google.common.collect.ImmutableList<String> typeNames,
                              boolean booleanAsNumber,
                              Boolean debugEnabled,
                              String elasticHostName,
                              String elasticClusterName,
                              String elasticIndexName,
                              String elasticTypeName,
                              Map<String,Object> settings)

Method Detail

start

public void start()
           throws com.googlecode.jmxtrans.exceptions.LifecycleException

Specified by:

start in interface com.googlecode.jmxtrans.model.OutputWriter

Overrides:

start in class com.googlecode.jmxtrans.model.output.BaseOutputWriter

Throws:

com.googlecode.jmxtrans.exceptions.LifecycleException

close

public void close()
           throws com.googlecode.jmxtrans.exceptions.LifecycleException

Specified by:

close in interface com.googlecode.jmxtrans.model.OutputWriter

Specified by:

close in interface AutoCloseable

Overrides:

close in class com.googlecode.jmxtrans.model.output.BaseOutputWriter

Throws:

com.googlecode.jmxtrans.exceptions.LifecycleException

validateSetup

public void validateSetup(com.googlecode.jmxtrans.model.Server server,
                          com.googlecode.jmxtrans.model.Query query)
                   throws com.googlecode.jmxtrans.model.ValidationException

Throws:

com.googlecode.jmxtrans.model.ValidationException

internalWrite

protected void internalWrite(com.googlecode.jmxtrans.model.Server server,
                             com.googlecode.jmxtrans.model.Query query,
                             com.google.common.collect.ImmutableList<com.googlecode.jmxtrans.model.Result> results)
                      throws Exception

Specified by:

internalWrite in class com.googlecode.jmxtrans.model.output.BaseOutputWriter

Throws:

Exception