graphite

edit
  • 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 codec will encode and decode Graphite formated lines.

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

graphite {
  }

Available configuration options:

Setting Input type Required Default value

enable_metric

boolean

No

true

exclude_metrics

array

No

["%{[^}]+}"]

fields_are_metrics

boolean

No

false

id

string

No

include_metrics

array

No

[".*"]

metrics

hash

No

{}

metrics_format

string

No

"*"

Details

edit

 

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.

exclude_metrics

edit
  • Value type is array
  • Default value is ["%{[^}]+}"]

Exclude regex matched metric names, by default exclude unresolved %{field} strings

fields_are_metrics

edit
  • Value type is boolean
  • Default value is false

Indicate that the event @fields should be treated as metrics and will be sent as is to graphite

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

include_metrics

edit
  • Value type is array
  • Default value is [".*"]

Include only regex matched metric names

metrics

edit
  • Value type is hash
  • Default value is {}

The metric(s) to use. 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:

    [ "%{host}/uptime", "%{uptime_1m}" ]

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

metrics_format

edit
  • Value type is string
  • Default value is "*"

Defines format of the metric string. The placeholder * will be replaced with the name of the actual metric.

    metrics_format => "foo.bar.*.sum"

If no metrics_format is defined the name of the metric will be used as fallback.