IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Logstash Reference [5.1] ›Output plugins
« file gelf »

gangliaedit

  • Version: 3.0.2
  • Released on: 2016-07-14
  • Changelog
  • Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

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

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.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

ganglia {
    metric => ...
    value => ...
}

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

enable_metric

boolean

No

true

group

string

No

""

host

string

No

"localhost"

id

string

No

lifetime

number

No

300

max_interval

number

No

60

metric

string

Yes

metric_type

string, one of ["string", "int8", "uint8", "int16", "uint16", "int32", "uint32", "float", "double"]

No

"uint8"

port

number

No

8649

slope

string, one of ["zero", "positive", "negative", "both", "unspecified"]

No

"both"

units

string

No

""

value

string

Yes

workers

<<,>>

No

1

Detailsedit

 

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.

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.

groupedit

  • Value type is string
  • Default value is ""

Metric group

hostedit

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

The address of the ganglia server.

idedit

  • 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.

lifetimeedit

  • Value type is number
  • Default value is 300

Lifetime in seconds of this metric

max_intervaledit

  • Value type is number
  • Default value is 60

Maximum time in seconds between gmetric calls for this metric.

metricedit

  • 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_typeedit

  • 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.

portedit

  • Value type is number
  • Default value is 8649

The port to connect on your ganglia server.

slopeedit

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

Metric slope, represents metric behavior

unitsedit

  • Value type is string
  • Default value is ""

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

valueedit

  • 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)

workersedit

  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne

« file gelf »