IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« File output plugin Gelf output plugin »

› ›

Ganglia output plugin

edit

Ganglia output plugin

edit

Plugin version: v3.0.6
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-ganglia. 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

This output allows you to pull metrics from your logs and ship them to ganglia’s gmond. This is heavily based on the graphite output.

Ganglia Output Configuration Options

edit

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

Setting	Input type	Required
`group`	string	No
`host`	string	No
`lifetime`	number	No
`max_interval`	number	No
`metric`	string	Yes
`metric_type`	string, one of `["string", "int8", "uint8", "int16", "uint16", "int32", "uint32", "float", "double"]`	No
`port`	number	No
`slope`	string, one of `["zero", "positive", "negative", "both", "unspecified"]`	No
`units`	string	No
`value`	string	Yes

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

`group`

edit

Value type is string
Default value is ""

Metric group

`host`

edit

Value type is string
Default value is "localhost"

The address of the ganglia server.

`lifetime`

edit

Value type is number
Default value is 300

Lifetime in seconds of this metric

`max_interval`

edit

Value type is number
Default value is 60

Maximum time in seconds between gmetric calls for this metric.

`metric`

edit

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

The metric to use. This supports dynamic strings like %{host}

`metric_type`

edit

Value can be any of: string, int8, uint8, int16, uint16, int32, uint32, float, double
Default value is "uint8"

The type of value for this metric.

`port`

edit

Value type is number
Default value is 8649

The port to connect on your ganglia server.

`slope`

edit

Value can be any of: zero, positive, negative, both, unspecified
Default value is "both"

Metric slope, represents metric behavior

`units`

edit

Value type is string
Default value is ""

Gmetric units for metric, such as "kb/sec" or "ms" or whatever unit this metric uses.

`value`

edit

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

The value to use. This supports dynamic strings like %{bytes} It will be coerced to a floating point value. Values which cannot be coerced will zero (0)

Common Options

edit

The following 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 ganglia outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  ganglia {
    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.

« File output plugin Gelf output plugin »