graphiteedit

  • Version: 3.0.2
  • Released on: July 14, 2016
  • Changelog

Getting Helpedit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Descriptionedit

This codec will encode and decode Graphite formated lines.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

graphite {
  }

Available configuration options:

Detailsedit

 

enable_metricedit

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

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
 stdout {
   id => "my_plugin_id"
 }
}

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.