fluent-plugin-uri-parser

This is a Fluentd plugin to parse uri and query string in log messages.

Requirements

fluent-plugin-uri-parser	fluentd	ruby
>= 0.3.0	>= v0.14.0	>= 2.1
< 0.2.0	>= v0.12.0	>= 1.9

Installation

$ gem install fluent-plugin-uri-parser -v "~> 0.2"  # for fluentd v0.12 or later
$ gem install fluent-plugin-uri-parser              # for fluentd v0.14 or later

Component

URIParserFilter

This is a Fluentd plugin to parse and filtering uri in log messages and re-emit them.

QueryStringParserFilter

This is a Fluentd plugin to parse and filtering query string in log messages and re-emit them.

Configuration

<filter>
  @type uri_parser
  key_name uri
  inject_key_prefix parsed
  # hash_value_field parsed
  # suppress_parse_error_log false
  # ignore_key_not_exist false
  # ignore_nil false

  out_key_scheme scheme
  out_key_host host
  out_key_port port
  out_key_path path
  out_key_query query
  out_key_fragment fragment
</filter>
# input string of data: {"uri": "http://example.com/path?foo=bar#t=1"}
# output data: {"parsed.scheme":"http","parsed.host":"example.com","parsed.port":80,"parsed.path":"/path","parsed.query":"foo=bar","parsed.ragment":"t=1"}

<filter>
  @type query_string_parser
  key_name parsed.query
  hash_value_field query
  # inject_key_prefix query
  # suppress_parse_error_log false
  # ignore_key_not_exist false
</filter>
# input string of data: {"parsed.query": "foo=bar"}
# output data: {"query":{"foo":"bar"}}

key_name (Required)

Key of the value to be parsed in the record.

hash_value_field (Default: '')

If a value is set, the value after parsing is stored in hash with key specified value.

inject_key_prefix (Default: '')

If you set a value, set the value specified for the key after parsing as prefix.

suppress_parse_error_log (Default: false)

If set to true, no error log is output even if parsing fails.

ignore_key_not_exist (Default: false)

If set to true, if the field specified by key_name does not exist, the record will not be emit to the next stream. That means that the data will be lost there.

ignore_nil (Default: false)

If set to true, exclude key if the value after parse is nil.

multi_value_params (Default: false)

If set to true, then resulting values would be arrays containing potentially multiple values of a given parameter.

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/daichirata/fluent-plugin-uri-parser.