graphite

 

Synopsis

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"

host

string

No

"0.0.0.0"

mode

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

No

"server"

port

number

Yes

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

Details

 

add_field

  • Value type is hash
  • Default value is {}

Add a field to an event

codec

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

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

host

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

mode

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

port

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

ssl_cacert (DEPRECATED)

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

ssl_cert

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

ssl_enable

  • Value type is boolean
  • Default value is false

ssl_extra_chain_certs

  • Value type is array
  • Default value is []

ssl_key

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

ssl_key_passphrase

  • Value type is password
  • Default value is nil

ssl_verify

  • Value type is boolean
  • Default value is true

tags

  • 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

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