For other versions, see theVersioned plugin docs.
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.
Receive graphite metrics. This plugin understands the text-based graphitecarbon protocol. Both N
and specific-timestamp
forms are supported, example:
mysql.slow_query.count 204 Nhaproxy.live_backends 7 1364608909
N
means now
for a timestamp. This plugin also supports having the timespecified in the metric payload:
For every metric received from a client, a single event will be emitted withthe metric name as the field (like mysql.slow_query.count
) and the metricvalue as the field’s value.
This plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
string, one of |
No |
|
Yes |
||
No |
||
a valid filesystem path |
No |
|
No |
||
No |
||
a valid filesystem path |
No |
|
No |
||
No |
Also see Common Options for a list of options supported by allinput plugins.
-1
"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.
server
, client
"server"
Mode to operate in. server
listens for client connections,client
connects to a server.
When mode is server
, the port to listen on.When mode is client
, the port to connect to.
false
Proxy protocol support, only v1 is supported at this timehttp://www.haproxy.org/download/1.5/doc/proxy-protocol.txt
The SSL CA certificate, chainfile or CA path. The system CA path is automatically included.
false
Enable SSL (must be set for other ssl_
options to take effect).
[]
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.
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.
The following configuration options are supported by all input plugins:
"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.
true
Disable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
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 usefulwhen 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" }}
Add any number of arbitrary tags to your event.
This can help with processing later.
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 canalso use the type to search for it in Kibana.
If you try to set a type on an event that already has one (forexample when you send an event from a shipper to an indexer) thena new input will not override the existing type. A type set atthe shipper stays with that event for its life evenwhen sent to another Logstash server.