README.md in fluent-plugin-geoip-1.1.0 vs README.md in fluent-plugin-geoip-1.2.0
- old
+ new
@@ -76,11 +76,11 @@
before use, install dependent library as:
```bash
# for RHEL/CentOS
-$ sudo yum group install "Development Tools"
+$ sudo yum groupinstall "Development Tools"
$ sudo yum install geoip-devel --enablerepo=epel
# for Ubuntu/Debian
$ sudo apt-get install build-essential
$ sudo apt-get install libgeoip-dev
@@ -115,11 +115,11 @@
<filter access.apache>
@type geoip
# Specify one or more geoip lookup field which has ip address (default: host)
# in the case of accessing nested value, delimit keys by dot like 'host.ip'.
- geoip_lookup_key host
+ geoip_lookup_keys host
# Specify optional geoip database (using bundled GeoLiteCity databse by default)
# geoip_database "/path/to/your/GeoIPCity.dat"
# Specify optional geoip2 database
# geoip2_database "/path/to/your/GeoLite2-City.mmdb" (using bundled GeoLite2-City.mmdb by default)
@@ -147,11 +147,11 @@
#### Tips: how to geolocate multiple key
```xml
<filter access.apache>
@type geoip
- geoip_lookup_key user1_host, user2_host
+ geoip_lookup_keys user1_host, user2_host
<record>
user1_city ${city.names.en["user1_host"]}
user2_city ${city.names.en["user2_host"]}
</record>
</filter>
@@ -162,11 +162,11 @@
It is a sample to get friendly geo point recdords for elasticsearch with Yajl (JSON) parser.<br />
```
<filter access.apache>
@type geoip
- geoip_lookup_key host
+ geoip_lookup_keys host
<record>
# lat lon as properties
# ex. {"lat" => 37.4192008972168, "lon" => -122.05740356445312 }
location_properties '{ "lat" : ${location.latitude["host"]}, "lon" : ${location.longitude["host"]} }'
@@ -187,11 +187,11 @@
On the case of using td-agent3 (v1-config), it have to quote `{ ... }` or `[ ... ]` block with quotation like below.
```
<filter access.apache>
@type geoip
- geoip_lookup_key host
+ geoip_lookup_keys host
<record>
location_properties '{ "lat" : ${location.latitude["host"]}, "lon" : ${location.longitude["host"]} }'
location_string ${location.latitude["host"]},${location.longitude["host"]}
location_array '[${location.longitude["host"]},${location.latitude["host"]}]'
</record>
@@ -205,11 +205,11 @@
<match access.apache>
@type geoip
# Specify one or more geoip lookup field which has ip address (default: host)
# in the case of accessing nested value, delimit keys by dot like 'host.ip'.
- geoip_lookup_key host
+ geoip_lookup_keys host
# Specify optional geoip database (using bundled GeoLiteCity databse by default)
geoip_database "/path/to/your/GeoIPCity.dat"
# Specify optional geoip2 database
# geoip2_database "/path/to/your/GeoLite2-City.mmdb"
@@ -253,13 +253,14 @@
```xml
<source>
@type forward
</source>
+
<filter test.geoip>
@type geoip
- geoip_lookup_key host
+ geoip_lookup_keys host
<record>
city ${city.names.en["host"]}
lat ${location.latitude["host"]}
lon ${location.longitude["host"]}
</record>
@@ -303,11 +304,11 @@
<store>
@type stdout
</store>
<store>
@type geoip
- geoip_lookup_key host
+ geoip_lookup_keys host
<record>
lat ${location.latitude["host"]}
lon ${location.longitude["host"]}
country ${country.iso_code["host"]}
</record>
@@ -436,16 +437,22 @@
* Default value: bundled database `GeoLite2-City.mmdb`.
Path to GeoIP2 database file.
-**geoip_lookup_key** (string) (optional)
+**geoip_lookup_keys** (array) (optional)
-* Default value: `host`.
+* Default_value: `["host"]`
Specify one or more geoip lookup field which has IP address.
+**geoip_lookup_key** (string) (optional) (deprecated)
+
+* Default value: `nil`.
+
+Use geoip_lookup_keys instead.
+
**skip_adding_null_record** (bool) (optional)
* Default value: `nil`
Skip adding geoip fields when this valaues to `true`.
@@ -487,14 +494,20 @@
* Default value: bundled database `GeoLite2-City.mmdb`.
Path to GeoIP2 database file.
-**geoip_lookup_key** (string) (optional)
+**geoip_lookup_keys** (array) (optional)
-* Default value: `host`.
+* Default value: `["host"]`
Specify one or more geoip lookup field which has IP address.
+
+**geoip_lookup_key** (string) (optional) (deprecated)
+
+* Default value: `nil`.
+
+Use geoip_lookup_keys instead.
**skip_adding_null_record** (bool) (optional)
* Default value: `nil`