Docs
You are looking at preliminary documentation for a future release. Not what you want? See the current release documentation.
Logstash Reference [5.x] » Codec plugins » graphite
«  fluent     gzip_lines  »

graphiteedit

This codec will encode and decode Graphite formated lines.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

graphite {
  }

Available configuration options:

Setting Input typeRequiredDefault value

exclude_metrics

array

No

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

fields_are_metrics

boolean

No

false

include_metrics

array

No

[".*"]

metrics

hash

No

{}

metrics_format

string

No

"*"

Detailsedit

 

exclude_metricsedit

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

fields_are_metricsedit

  • 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

include_metricsedit

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

Include only regex matched metric names

metricsedit

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

  • 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"
Note

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

«  fluent     gzip_lines  »