graphtasticedit

  • Version: 3.0.0
  • Released on: 2016-09-09
  • Changelog
Note

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-graphtastic.

A plugin for a newly developed Java/Spring Metrics application I didn’t really want to code this project but I couldn’t find a respectable alternative that would also run on any Windows machine - which is the problem and why I am not going with Graphite and statsd. This application provides multiple integration options so as to make its use under your network requirements possible. This includes a REST option that is always enabled for your use in case you want to write a small script to send the occasional metric data.

Find GraphTastic here : https://github.com/NickPadilla/GraphTastic

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

graphtastic {
}

Available configuration options:

Setting Input typeRequiredDefault value

batch_number

number

No

60

codec

codec

No

"plain"

context

string

No

"graphtastic"

enable_metric

boolean

No

true

error_file

string

No

""

host

string

No

"127.0.0.1"

id

string

No

integration

string, one of ["udp", "tcp", "rmi", "rest"]

No

"udp"

metrics

hash

No

{}

port

number

No

retries

number

No

1

workers

<<,>>

No

1

Detailsedit

 

batch_numberedit

  • Value type is number
  • Default value is 60

the number of metrics to send to GraphTastic at one time. 60 seems to be the perfect amount for UDP, with default packet size.

codecedit

  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

contextedit

  • Value type is string
  • Default value is "graphtastic"

if using rest as your end point you need to also provide the application url it defaults to localhost/graphtastic. You can customize the application url by changing the name of the .war file. There are other ways to change the application context, but they vary depending on the Application Server in use. Please consult your application server documentation for more on application contexts.

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

error_fileedit

  • Value type is string
  • Default value is ""

setting allows you to specify where we save errored transactions this makes the most sense at this point - will need to decide on how we reintegrate these error metrics NOT IMPLEMENTED!

hostedit

  • Value type is string
  • Default value is "127.0.0.1"

host for the graphtastic server - defaults to 127.0.0.1

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

``` output { stdout { id ⇒ "ABC" } } ```

If you don’t explicitely set this variable Logstash will generate a unique name.

integrationedit

  • Value can be any of: udp, tcp, rmi, rest
  • Default value is "udp"

options are udp(fastest - default) - rmi(faster) - rest(fast) - tcp(don’t use TCP yet - some problems - errors out on linux)

metricsedit

  • Value type is hash
  • Default value is {}

metrics hash - you will provide a name for your metric and the metric data as key value pairs. so for example:

metrics => { "Response" => "%{response}" }

example for the logstash config

metrics => [ "Response", "%{response}" ]
Note

you can also use the dynamic fields for the key value as well as the actual value

portedit

  • Value type is number
  • There is no default value for this setting.

port for the graphtastic instance - defaults to 1199 for RMI, 1299 for TCP, 1399 for UDP, and 8080 for REST

retriesedit

  • Value type is number
  • Default value is 1

number of attempted retry after send error - currently only way to integrate errored transactions - should try and save to a file or later consumption either by graphtastic utility or by this program after connectivity is ensured to be established.

workersedit

  • Value type is string
  • Default value is 1