metriccatcher
editmetriccatcher
editThis is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/plugin install logstash-output-metriccatcher
.
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
editThis plugin supports the following configuration options:
Required configuration options:
metriccatcher { }
Available configuration options:
Details
edit
biased
edit- 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
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.
counter
edit- 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)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events without any of these tags. Optional.
gauge
edit- 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)
meter
edit- 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)
tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events with all of these tags. Optional.
timer
edit- 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)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- 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
edit- 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)