Browse Source

Add complete examples to ingest-geoip docs

Adds `// CONSOLE` and example responses to both make usage more clear
and to test the snippets.

Relates to #18160
Nik Everett 9 years ago
parent
commit
3793d0573e
1 changed files with 65 additions and 4 deletions
  1. 65 4
      docs/plugins/ingest-geoip.asciidoc

+ 65 - 4
docs/plugins/ingest-geoip.asciidoc

@@ -64,8 +64,9 @@ Here is an example that uses the default city database and adds the geographical
 
 [source,js]
 --------------------------------------------------
+PUT _ingest/pipeline/geoip
 {
-  "description" : "...",
+  "description" : "Add geoip info",
   "processors" : [
     {
       "geoip" : {
@@ -74,22 +75,82 @@ Here is an example that uses the default city database and adds the geographical
     }
   ]
 }
+PUT my_index/my_type/my_id?pipeline=geoip
+{
+  "ip": "8.8.8.8"
+}
+GET my_index/my_type/my_id
+--------------------------------------------------
+// CONSOLE
+
+Which returns:
+
+[source,js]
+--------------------------------------------------
+{
+  "found": true,
+  "_index": "my_index",
+  "_type": "my_type",
+  "_id": "my_id",
+  "_version": 1,
+  "_source": {
+    "ip": "8.8.8.8",
+    "geoip": {
+      "continent_name": "North America",
+      "country_iso_code": "US",
+      "region_name": "California",
+      "city_name": "Mountain View",
+      "location": { "lat": 37.386, "lon": -122.0838 }
+    }
+  }
+}
 --------------------------------------------------
+// TESTRESPONSE
 
-Here is an example that uses the default country database and adds the geographical information to the `geo` field based on the `ip` field`:
+Here is an example that uses the default country database and adds the
+geographical information to the `geo` field based on the `ip` field`. Note that
+this database is included in the plugin download. So this:
 
 [source,js]
 --------------------------------------------------
+PUT _ingest/pipeline/geoip
 {
-  "description" : "...",
+  "description" : "Add geoip info",
   "processors" : [
     {
       "geoip" : {
         "field" : "ip",
         "target_field" : "geo",
-        "database_file" : "GeoLite2-Country.mmdb"
+        "database_file" : "GeoLite2-Country.mmdb.gz"
       }
     }
   ]
 }
+PUT my_index/my_type/my_id?pipeline=geoip
+{
+  "ip": "8.8.8.8"
+}
+GET my_index/my_type/my_id
+--------------------------------------------------
+// CONSOLE
+
+returns this:
+
+[source,js]
+--------------------------------------------------
+{
+  "found": true,
+  "_index": "my_index",
+  "_type": "my_type",
+  "_id": "my_id",
+  "_version": 1,
+  "_source": {
+    "ip": "8.8.8.8",
+    "geo": {
+      "continent_name": "North America",
+      "country_iso_code": "US",
+    }
+  }
+}
 --------------------------------------------------
+// TESTRESPONSE