New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« gzip_lines json_lines »
Elastic Docs ›Logstash Reference [2.3] ›Codec plugins

graphite

edit

graphite

edit

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

exclude_metrics

array

No

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

fields_are_metrics

boolean

No

false

include_metrics

array

No

[".*"]

metrics

hash

No

{}

metrics_format

string

No

"*"

Details

edit

 

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

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.

« gzip_lines json_lines »

On this page

Was this helpful?
Feedback