org.jmxtrans.embedded.output

Class CsvWriter

java.lang.Object

org.jmxtrans.embedded.output.AbstractOutputWriter

org.jmxtrans.embedded.output.CsvWriter

All Implemented Interfaces:

OutputWriter

public class CsvWriter
extends AbstractOutputWriter
implements OutputWriter

This output writer can ONLY be used on a per query basis, not in a global output writer configuration because this aggregates all of the different attributes returned by the query into a single line in a csv file, using the QueryResult.getName() as the value of the header.

The query can contain multiple MBeans by pattern matched ObjectName

Example query configuration:

  "queries": [
  {
     "outputWriters": [
       {
          "@class": "org.jmxtrans.embedded.output.CsvWriter",
          "settings": {
             "outputFile": "log/jmxlog.csv"
           }
       }
      ],
      "objectName": "java.lang:type=Memory",
      "resultAlias": "jvm.memory",
      "attributes": [
         {
            "name": "HeapMemoryUsage",
            "keys": ["committed", "used"]
         },
         {
            "name": "NonHeapMemoryUsage",
            "keys": ["committed", "used"]
         }
      ]
  }
]
 

See embedded-jmxtrans configuration for more details.

Author:

Ryan Larson

Field Summary

Fields inherited from class org.jmxtrans.embedded.output.AbstractOutputWriter

SETTING_HOST, SETTING_NAME_PREFIX, SETTING_PORT, SETTING_PROXY_HOST, SETTING_PROXY_PORT, SETTING_TOKEN, SETTING_URL, SETTING_USERNAME

Constructor Summary

Constructors

Constructor and Description
CsvWriter()

Method Summary

Methods

Modifier and Type	Method and Description
void	start() No-op implementation
void	stop() No-op implementation
void	write(Iterable<QueryResult> results) Write all the given QueryResult to the target system.

Methods inherited from class org.jmxtrans.embedded.output.AbstractOutputWriter

equals, getBooleanSetting, getIntSetting, getIntSetting, getLongSetting, getSettings, getStrategy, getStringSetting, getStringSetting, hashCode, isEnabled, setEnabled, setSettings, setStrategy, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jmxtrans.embedded.output.OutputWriter

getSettings, isEnabled, setEnabled, setSettings

Constructor Detail

CsvWriter

public CsvWriter()

Method Detail

start

public void start()

Description copied from class: AbstractOutputWriter

No-op implementation

Specified by:

start in interface OutputWriter

Overrides:

start in class AbstractOutputWriter

stop

public void stop()
          throws IOException

Description copied from class: AbstractOutputWriter

No-op implementation

Specified by:

stop in interface OutputWriter

Overrides:

stop in class AbstractOutputWriter

Throws:

IOException

write

public void write(Iterable<QueryResult> results)

Description copied from interface: OutputWriter

Write all the given QueryResult to the target system.

Specified by:

write in interface OutputWriter

Specified by:

write in class AbstractOutputWriter