﻿---
title: Graphite input plugin v3.0.6
description: Plugin version: v3.0.6, Released on: 2018-04-06, Changelog. For other versions, see the overview list. To learn more about Logstash, see the Logstash...
url: https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/v3-0-6-plugins-inputs-graphite
---

# Graphite input plugin v3.0.6
- Plugin version: v3.0.6
- Released on: 2018-04-06
- [Changelog](https://github.com/logstash-plugins/logstash-input-graphite/blob/v3.0.6/CHANGELOG.md)

For other versions, see the [overview list](https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/input-graphite-index).
To learn more about Logstash, see the [Logstash Reference](https://www.elastic.co/guide/en/logstash/current/index.html).

## Getting help

For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-input-graphite). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

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

This plugin supports the following configuration options plus the [Common options](#v3.0.6-plugins-inputs-graphite-common-options) described later.

| Setting                                                                                                 | Input type                                                                                                | Required |
|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|----------|
| [`host`](#v3.0.6-plugins-inputs-graphite-host)`host`                                                    | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                | No       |
| [`mode`](#v3.0.6-plugins-inputs-graphite-mode)`mode`                                                    | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string, one of `["server", "client"]` | No       |
| [`port`](#v3.0.6-plugins-inputs-graphite-port)`port`                                                    | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number                                | Yes      |
| [`proxy_protocol`](#v3.0.6-plugins-inputs-graphite-proxy_protocol)`proxy_protocol`                      | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean                             | No       |
| [`ssl_cert`](#v3.0.6-plugins-inputs-graphite-ssl_cert)`ssl_cert`                                        | a valid filesystem path                                                                                   | No       |
| [`ssl_enable`](#v3.0.6-plugins-inputs-graphite-ssl_enable)`ssl_enable`                                  | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean                             | No       |
| [`ssl_extra_chain_certs`](#v3.0.6-plugins-inputs-graphite-ssl_extra_chain_certs)`ssl_extra_chain_certs` | [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#array)array                                   | No       |
| [`ssl_key`](#v3.0.6-plugins-inputs-graphite-ssl_key)`ssl_key`                                           | a valid filesystem path                                                                                   | No       |
| [`ssl_key_passphrase`](#v3.0.6-plugins-inputs-graphite-ssl_key_passphrase)`ssl_key_passphrase`          | [password](/elastic/logstash-docs-md/tree/main/lsr/value-types#password)password                          | No       |
| [`ssl_verify`](#v3.0.6-plugins-inputs-graphite-ssl_verify)`ssl_verify`                                  | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean                             | No       |

Also see [Common options](#v3.0.6-plugins-inputs-graphite-common-options) for a list of options supported by all input plugins.

### `data_timeout` (DEPRECATED)

- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `-1`


### `host`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- 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`

- This is a required setting.
- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `false`

Proxy protocol support, only v1 is supported at this time 

### `ssl_cacert` (DEPRECATED)

- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is [path](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [path](/elastic/logstash-docs-md/tree/main/lsr/value-types#path)
- There is no default value for this setting.

SSL certificate path

### `ssl_enable`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `false`

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

### `ssl_extra_chain_certs`

- Value type is [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [path](/elastic/logstash-docs-md/tree/main/lsr/value-types#path)
- There is no default value for this setting.

SSL key path

### `ssl_key_passphrase`

- Value type is [password](/elastic/logstash-docs-md/tree/main/lsr/value-types#password)
- Default value is `nil`

SSL key passphrase

### `ssl_verify`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#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

These configuration options are supported by all input plugins:

| Setting                                                                         | Input type                                                                    | Required |
|---------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`add_field`](#v3.0.6-plugins-inputs-graphite-add_field)`add_field`             | [hash](/elastic/logstash-docs-md/tree/main/lsr/value-types#hash)hash          | No       |
| [`codec`](#v3.0.6-plugins-inputs-graphite-codec)`codec`                         | [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)codec       | No       |
| [`enable_metric`](#v3.0.6-plugins-inputs-graphite-enable_metric)`enable_metric` | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`id`](#v3.0.6-plugins-inputs-graphite-id)`id`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`tags`](#v3.0.6-plugins-inputs-graphite-tags)`tags`                            | [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#array)array       | No       |
| [`type`](#v3.0.6-plugins-inputs-graphite-type)`type`                            | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |


### `add_field`

- Value type is [hash](/elastic/logstash-docs-md/tree/main/lsr/value-types#hash)
- Default value is `{}`

Add a field to an event

### `codec`

- Value type is [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#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](/elastic/logstash-docs-md/tree/main/lsr/value-types#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.