ganglia

Milestone: 2

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.

Synopsis

This is what it might look like in your config file:
output {
  ganglia {
    codec => ... # codec (optional), default: "plain"
    group => ... # string (optional), default: ""
    host => ... # string (optional), default: "localhost"
    lifetime => ... # number (optional), default: 300
    max_interval => ... # number (optional), default: 60
    metric => ... # string (required)
    metric_type => ... # string, one of ["string", "int8", "uint8", "int16", "uint16", "int32", "uint32", "float", "double"] (optional), default: "uint8"
    port => ... # number (optional), default: 8649
    slope => ... # string, one of ["zero", "positive", "negative", "both", "unspecified"] (optional), default: "both"
    units => ... # string (optional), default: ""
    value => ... # string (required)
    workers => ... # number (optional), default: 1
  }
}

Details

codec

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

exclude_tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

group

  • Value type is string
  • Default value is ""

Metric group

host

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

The address of the ganglia server.

lifetime

  • Value type is number
  • Default value is 300

Lifetime in seconds of this metric

max_interval

  • Value type is number
  • Default value is 60

Maximum time in seconds between gmetric calls for this metric.

metric (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

  • 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

  • Value type is number
  • Default value is 8649

The port to connect on your ganglia server.

slope

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

Metric slope, represents metric behavior

tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

units

  • Value type is string
  • Default value is ""

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

value (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)

workers

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.


This is documentation from lib/logstash/outputs/ganglia.rb