This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Graphite output plugin Http output plugin »

› ›

Graphtastic output plugin

edit

Graphtastic output plugin

edit

Plugin version: v3.0.4
Released on: 2018-04-06
Changelog

For other versions, see the Versioned plugin docs.

Installation

edit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-graphtastic. See Working with plugins for more details.

Getting help

edit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

edit

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

Graphtastic Output Configuration Options

edit

This plugin supports the following configuration options plus the Common options described later.

Setting	Input type	Required
`batch_number`	number	No
`context`	string	No
`error_file`	string	No
`host`	string	No
`integration`	string, one of `["udp", "tcp", "rmi", "rest"]`	No
`metrics`	hash	No
`port`	number	No
`retries`	number	No

Also see Common options for a list of options supported by all output plugins.

`batch_number`

edit

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.

`context`

edit

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.

`error_file`

edit

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!

`host`

edit

Value type is string
Default value is "127.0.0.1"

host for the graphtastic server - defaults to 127.0.0.1

`integration`

edit

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)

`metrics`

edit

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}" ]

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

`port`

edit

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

`retries`

edit

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.

Common options

edit

These configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No

`codec`

edit

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.

`enable_metric`

edit

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.

`id`

edit

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 graphtastic outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  graphtastic {
    id => "my_plugin_id"
  }
}

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

« Graphite output plugin Http output plugin »