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 plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
Yes |
||
No |
||
No |
||
No |
||
No |
Also see Common Options for a list of options supported by allfilter plugins.
true
By default the filter will force single elements to be arrays. Setting this tofalse will prevent storing single elements in arrays.
false
By default the filter will expand attributes differently from content insideof tags. This option allows you to force text content and attributes to alwaysparse to a hash value.
{}
By default only namespaces declarations on the root element are considered.This allows to configure all namespace declarations to parse the XML document.
Example:
filter { xml { namespaces => { "xsl" => "http://www.w3.org/1999/XSL/Transform" "xhtml" => "http://www.w3.org/1999/xhtml" } }}
false
Remove all namespaces from all nodes in the document.Of course, if the document had nodes with the same names but different namespaces, they will now be ambiguous.
Config for xml to hash is:
source => source_field
For example, if you have the whole XML document in your message
field:
filter { xml { source => "message" }}
The above would parse the XML from the message
field.
true
By default the filter will store the whole parsed XML in the destinationfield as described above. Setting this to false will prevent that.
true
By default, output nothing if the element is empty.If set to false
, empty element will result in an empty hash object.
Define target for placing the data
For example if you want the data to be put in the doc
field:
filter { xml { target => "doc" }}
XML in the value of the source field will be expanded into adatastructure in the target
field.Note: if the target
field already exists, it will be overridden.Required if store_xml
is true (which is the default).
{}
xpath will additionally select string values (non-strings will beconverted to strings with Ruby’s to_s
function) from parsed XML(using each source field defined using the method above) and placethose values in the destination fields. Configuration:
xpath => [ "xpath-syntax", "destination-field" ]
Values returned by XPath parsing from xpath-syntax
will be put in thedestination field. Multiple values returned will be pushed onto thedestination field as an array. As such, multiple matches acrossmultiple source fields will produce duplicate entries in the field.
More on XPath: http://www.w3schools.com/xml/xml_xpath.asp
The XPath functions are particularly powerful:http://www.w3schools.com/xsl/xsl_functions.asp
The following configuration options are supported by all filter plugins:
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
{}
If this filter is successful, add any arbitrary fields to this event.Field names can be dynamic and include parts of the event using the %{field}
.
Example:
filter { xml { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } }}
# You can also add multiple fields at once:filter { xml { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" "new_field" => "new_static_value" } }}
If the event has field "somefield" == "hello"
this filter, on success,would add field foo_hello
if it is present, with thevalue above and the %{host}
piece replaced with that value from theevent. The second example would also add a hardcoded field.
[]
If this filter is successful, add arbitrary tags to the event.Tags can be dynamic and include parts of the event using the %{field}
syntax.
Example:
filter { xml { add_tag => [ "foo_%{somefield}" ] }}
# You can also add multiple tags at once:filter { xml { add_tag => [ "foo_%{somefield}", "taggedy_tag"] }}
If the event has field "somefield" == "hello"
this filter, on success,would add a tag foo_hello
(and the second example would of course add a taggedy_tag
tag).
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 xml filters.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
filter { xml { id => "ABC" }}
false
Call the filter flush method at regular interval.Optional.
[]
If this filter is successful, remove arbitrary fields from this event.Example:
filter { xml { remove_field => [ "foo_%{somefield}" ] }}
# You can also remove multiple fields at once:filter { xml { remove_field => [ "foo_%{somefield}", "my_extraneous_field" ] }}
If the event has field "somefield" == "hello"
this filter, on success,would remove the field with name foo_hello
if it is present. The secondexample would remove an additional, non-dynamic field.
[]
If this filter is successful, remove arbitrary tags from the event.Tags can be dynamic and include parts of the event using the %{field}
syntax.
Example:
filter { xml { remove_tag => [ "foo_%{somefield}" ] }}
# You can also remove multiple tags at once:filter { xml { remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"] }}
If the event has field "somefield" == "hello"
this filter, on success,would remove the tag foo_hello
if it is present. The second examplewould remove a sad, unwanted tag as well.