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

graphiteedit

  • 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

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.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

graphite {
    port => ...
}

Available configuration options:

Setting Input type Required Default value

add_field

hash

No

{}

codec

codec

No

"plain"

enable_metric

boolean

No

true

host

string

No

"0.0.0.0"

id

string

No

mode

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

No

"server"

port

number

Yes

proxy_protocol

boolean

No

false

ssl_cert

a valid filesystem path

No

ssl_enable

boolean

No

false

ssl_extra_chain_certs

array

No

[]

ssl_key

a valid filesystem path

No

ssl_key_passphrase

password

No

nil

ssl_verify

boolean

No

true

tags

array

No

type

string

No

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

codecedit

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

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

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.

hostedit

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

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

idedit

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

modeedit

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

portedit

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

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

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

SSL certificate path

ssl_enableedit

  • Value type is boolean
  • Default value is false

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

ssl_extra_chain_certsedit

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

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

SSL key path

ssl_key_passphraseedit

  • Value type is password
  • Default value is nil

SSL key passphrase

ssl_verifyedit

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

tagsedit

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

typeedit

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

« github heartbeat »