Gelf input plugin | Logstash Reference [7.0] | Elastic
Logstash Reference [7.0] » Input plugins » Gelf input plugin
« Ganglia input plugin Generator input plugin »
[](#plugins-inputs-gelf)Gelf input pluginedit
- Plugin version: v3.2.0
- Released on: 2018-12-12
- Changelog
For other versions, see the Versioned plugin docs.
[](#_getting_help_10)Getting Helpedit
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.
[](#_description_10)Descriptionedit
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 GELF logging libraries such as the GELF log4j appender. A library used by 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 force gzip even for small messages:
<Socket name="logstash" protocol="udp" host="logstash.example.com" port="5001">
<GelfLayout compressionType="GZIP" compressionThreshold="1" />
</Socket>
[](#plugins-inputs-gelf-options)Gelf Input Configuration Optionsedit
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 all input plugins.
[](#plugins-inputs-gelf-host)hostedit
- Value type is string
- Default value is
"0.0.0.0"
The IP address or hostname to listen on.
[](#plugins-inputs-gelf-use_udp)use_udpedit
- Value type is boolean
- Default value is
true
Whether to listen for gelf messages sent over udp
[](#plugins-inputs-gelf-use_tcp)use_tcpedit
- Value type is boolean
- Default value is
false
Whether to listen for gelf messages sent over tcp
[](#plugins-inputs-gelf-port)portedit
- Value type is number
- Default value is
12201
The port to listen on. Remember that ports less than 1024 (privileged ports) may require root to use. port_tcp and port_udp can be used to set a specific port for each protocol.
[](#plugins-inputs-gelf-port_tcp)port_tcpedit
- Value type is number
- There is no default value for this setting.
Tcp port to listen on. Use port instead of this setting unless you need a different port for udp than tcp
[](#plugins-inputs-gelf-port_udp)port_udpedit
- Value type is number
- There is no default value for this setting.
Udp port to listen on. Use port instead of this setting unless you need a different port for udp than tcp
[](#plugins-inputs-gelf-remap)remapedit
- Value type is boolean
- Default value is
true
Whether or not to remap the GELF message fields to Logstash event fields or leave them intact.
Remapping converts the following GELF fields to Logstash equivalents:
full\_messagebecomesevent.get("message").- if there is no
full\_message,short\_messagebecomesevent.get("message").
[](#plugins-inputs-gelf-strip_leading_underscore)strip_leading_underscoreedit
- Value type is boolean
- Default value is
true
Whether or not to remove the leading \_ in GELF fields or leave them in place. (Logstash < 1.2 did not remove them by default.). Note that GELF version 1.1 format now requires all non-standard fields to be added as an "additional" field, beginning with an underscore.
e.g. \_foo becomes foo
[](#plugins-inputs-gelf-common-options)Common Optionsedit
The following configuration options are supported by all input plugins:
Setting
Input type
Required
No
No
No
No
No
No
[](#_details_10)Detailsedit
[](#plugins-inputs-gelf-add_field)add_fieldedit
- Value type is hash
- Default value is
{}
Add a field to an event
[](#plugins-inputs-gelf-codec)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.
[](#plugins-inputs-gelf-enable_metric)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.
[](#plugins-inputs-gelf-id)idedit
- Value type is 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 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"}
}
[](#plugins-inputs-gelf-tags)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.
[](#plugins-inputs-gelf-type)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.
« Ganglia input plugin Generator input plugin »
Original url: Access
Created at: 2019-04-23 17:21:14
Category: default
Tags: none
未标明原创文章均为采集，版权归作者所有，转载无需和我联系，请注明原出处，南摩阿彌陀佛，知识，不只知道，要得到
最新评论