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.
This input will read GELF messages as events over the network,making it a good choice if you already use Graylog2 today.
The main use case for this input is to leverage existing GELFlogging libraries such as the GELF log4j appender. A library usedby this plugin has a bug which prevents it parsing uncompressed data.If you use the log4j appender you need to configure it like this to forcegzip even for small messages:
<Socket name="logstash" protocol="udp" host="logstash.example.com" port="5001"> <GelfLayout compressionType="GZIP" compressionThreshold="1" /></Socket>
This plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
Also see Common Options for a list of options supported by allinput plugins.
true
Whether to listen for gelf messages sent over udp
false
Whether to listen for gelf messages sent over tcp
12201
The port to listen on. Remember that ports less than 1024 (privilegedports) may require root to use.port_tcp and port_udp can be used to set a specific port for each protocol.
Tcp port to listen on. Use port instead of this setting unless you need a different port for udp than tcp
Udp port to listen on. Use port instead of this setting unless you need a different port for udp than tcp
true
Whether or not to remap the GELF message fields to Logstash event fields orleave them intact.
Remapping converts the following GELF fields to Logstash equivalents:
full\_message
becomes event.get("message")
.full\_message
, short\_message
becomes event.get("message")
.true
Whether or not to remove the leading \_
in GELF fields or leave themin place. (Logstash < 1.2 did not remove them by default.). Note thatGELF version 1.1 format now requires all non-standard fields to be addedas an "additional" field, beginning with an underscore.
e.g. \_foo
becomes foo
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 gelf inputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
input { gelf { 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.