IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Google_pubsub input plugin Heartbeat input plugin »
Elastic Docs ›Logstash Reference [6.0] ›Input plugins

Graphite input plugin

edit

Graphite input plugin

edit
  • Plugin version: v3.0.4
  • Released on: 2017-08-21
  • Changelog

Getting Help

edit

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.

Description

edit

Receive graphite metrics. This plugin understands the text-based graphite carbon protocol. Both N and specific-timestamp forms are supported, example:

    mysql.slow_query.count 204 N
    haproxy.live_backends 7 1364608909

N means now for a timestamp. This plugin also supports having the time specified in the metric payload:

For every metric received from a client, a single event will be emitted with the metric name as the field (like mysql.slow_query.count) and the metric value as the field’s value.

Graphite Input Configuration Options

edit

This plugin supports the following configuration options plus the Common Options described later.

Setting Input type Required

host

string

No

mode

string, one of ["server", "client"]

No

port

number

Yes

proxy_protocol

boolean

No

ssl_cert

a valid filesystem path

No

ssl_enable

boolean

No

ssl_extra_chain_certs

array

No

ssl_key

a valid filesystem path

No

ssl_key_passphrase

password

No

ssl_verify

boolean

No

Also see Common Options for a list of options supported by all input plugins.

 

data_timeout (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is number
  • Default value is -1

host

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

Read events over a TCP socket.

Like stdin and file inputs, each event is assumed to be one line of text.

Can either accept connections from clients or connect to a server, depending on mode. When mode is server, the address to listen on. When mode is client, the address to connect to.

mode

edit
  • Value can be any of: server, client
  • Default value is "server"

Mode to operate in. server listens for client connections, client connects to a server.

port

edit
  • This is a required setting.
  • Value type is number
  • There is no default value for this setting.

When mode is server, the port to listen on. When mode is client, the port to connect to.

proxy_protocol

edit
  • Value type is boolean
  • Default value is false

Proxy protocol support, only v1 is supported at this time http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt

ssl_cacert (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is path
  • There is no default value for this setting.

The SSL CA certificate, chainfile or CA path. The system CA path is automatically included.

ssl_cert

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

SSL certificate path

ssl_enable

edit
  • Value type is boolean
  • Default value is false

Enable SSL (must be set for other ssl_ options to take effect).

ssl_extra_chain_certs

edit
  • Value type is array
  • Default value is []

An Array of extra X509 certificates to be added to the certificate chain. Useful when the CA chain is not necessary in the system store.

ssl_key

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

SSL key path

ssl_key_passphrase

edit
  • Value type is password
  • Default value is nil

SSL key passphrase

ssl_verify

edit
  • Value type is boolean
  • Default value is true

Verify the identity of the other end of the SSL connection against the CA. For input, sets the field sslsubject to that of the client certificate.

Common Options

edit

The following configuration options are supported by all input plugins:

Setting Input type Required

add_field

hash

No

codec

codec

No

enable_metric

boolean

No

id

string

No

tags

array

No

type

string

No

Details

edit

 

add_field

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

Add a field to an event

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

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.

id

edit
  • 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 graphite inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

input {
  graphite {
    id => "my_plugin_id"
  }
}

tags

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

Add any number of arbitrary tags to your event.

This can help with processing later.

type

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

« Google_pubsub input plugin Heartbeat input plugin »