metriccatcher

Milestone: 2

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

This output ships metrics to MetricCatcher, allowing you to utilize Coda Hale’s Metrics.

More info on MetricCatcher: https://github.com/clearspring/MetricCatcher

At Clearspring, we use it to count the response codes from Apache logs: metriccatcher { host => “localhost” port => “1420” type => “apache-access” fields => [ “response” ] meter => [ “%{host}.apache.response.%{response}”, “1” ] }

Synopsis

This is what it might look like in your config file:
output {
  metriccatcher {
    biased => ... # hash (optional)
    codec => ... # codec (optional), default: "plain"
    counter => ... # hash (optional)
    gauge => ... # hash (optional)
    host => ... # string (optional), default: "localhost"
    meter => ... # hash (optional)
    port => ... # number (optional), default: 1420
    timer => ... # hash (optional)
    uniform => ... # hash (optional)
    workers => ... # number (optional), default: 1
  }
}

Details

biased

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

The metrics to send. This supports dynamic strings like %{host} for metric names and also for values. This is a hash field with key of the metric name, value of the metric value.

The value will be coerced to a floating point value. Values which cannot be coerced will zero (0)

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.

counter

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

The metrics to send. This supports dynamic strings like %{host} for metric names and also for values. This is a hash field with key of the metric name, value of the metric value. Example:

counter => [ “%{host}.apache.hits.%{response}, “1” ]

The value will be coerced to a floating point value. Values which cannot be coerced will zero (0)

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.

gauge

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

The metrics to send. This supports dynamic strings like %{host} for metric names and also for values. This is a hash field with key of the metric name, value of the metric value.

The value will be coerced to a floating point value. Values which cannot be coerced will zero (0)

host

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

The address of the MetricCatcher

meter

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

The metrics to send. This supports dynamic strings like %{host} for metric names and also for values. This is a hash field with key of the metric name, value of the metric value.

The value will be coerced to a floating point value. Values which cannot be coerced will zero (0)

port

  • Value type is number
  • Default value is 1420

The port to connect on your MetricCatcher

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.

timer

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

The metrics to send. This supports dynamic strings like %{host} for metric names and also for values. This is a hash field with key of the metric name, value of the metric value. Example:

timer => [ “%{host}.apache.response_time, “%{response_time}” ]

The value will be coerced to a floating point value. Values which cannot be coerced will zero (0)

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.

uniform

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

The metrics to send. This supports dynamic strings like %{host} for metric names and also for values. This is a hash field with key of the metric name, value of the metric value.

The value 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/metriccatcher.rb