fluent-plugin-geoip-filter
Fluentd filter plugin to add geoip.
Requirements
fluent-plugin-geoip-filter | fluentd | ruby |
---|---|---|
>= 1.0.0 | >= v0.14.0 | >= 2.1 |
< 1.0.0 | >= v0.12.0 | >= 1.9 |
Installation
# for fluentd
$ gem install fluent-plugin-geoip-filter
# for td-agent2
$ sudo td-agent-gem install fluent-plugin-geoip-filter
Usage
Example 1:
<filter access.nginx.**>
@type geoip
</filter>
Assuming following inputs are coming:
access.nginx: {
"client_ip":"93.184.216.34",
"scheme":"http", "method":"GET", "host":"example.com",
"path":"/", "query":"-", "req_bytes":200, "referer":"-",
"status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001, "user_agent":"Mozilla/5.0"
}
then output bocomes as belows:
access.nginx: {
"client_ip":"93.184.216.34",
"scheme":"http", "method":"GET", "host":"example.com",
"path":"/", "query":"-", "req_bytes":200, "referer":"-",
"status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001, "user_agent":"Mozilla/5.0",
"geo": {
"coordinates": [-70.8228, 42.150800000000004],
"country_code": "US",
"city": "Norwell",
"region_code": "MA",
}
}
Parameters
-
key_name field_key
Target key name. default client_ip.
-
out_key string
Output prefix key name. default geo.
-
database_path file_path
Database file(GeoIPCity.dat) path. Get from MaxMind
-
flatten bool join hashed data by '_'. default false.
VS.
fluent-plugin-geoip Fluentd output plugin to geolocate with geoip. It is able to customize fields with placeholder.
- Easy to install.
- Not require to install Development Tools and geoip-dev library.
- ( fluent-plugin-geoip use geoip-c gem but our plugin use geoip. It's conflict. )
- 5-10 times faster by the LRU cache.
- See benchmark.
TODO
- patches welcome!
Contributing
- Fork it ( https://github.com/bungoume/fluent-plugin-geoip-filter/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Copyright
Copyright (c) 2015 Yuri Umezaki
License
This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com.