diff --git a/docs/plugins/ingest-geoip.asciidoc b/docs/plugins/ingest-geoip.asciidoc new file mode 100644 index 00000000000..622bc5969e4 --- /dev/null +++ b/docs/plugins/ingest-geoip.asciidoc @@ -0,0 +1,11 @@ +[[ingest-geoip]] +=== Ingest `geoip` Processor Plugin + +The `geoip` processor is no longer distributed as a plugin, but is now a module +distributed by default with Elasticsearch. See +{ref}/ingest-geoip.html[Ingest `geoip` processor] for more details. + +[[using-ingest-geoip]] +==== Using the `geoip` Processor in a Pipeline + +See {ref}/using-ingest-geoip.html[using `ingest-geoip`]. diff --git a/docs/plugins/ingest.asciidoc b/docs/plugins/ingest.asciidoc index 3c8a4b1f8d7..84cfb1442e0 100644 --- a/docs/plugins/ingest.asciidoc +++ b/docs/plugins/ingest.asciidoc @@ -13,6 +13,15 @@ The core ingest plugins are: The ingest attachment plugin lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library http://lucene.apache.org/tika/[Tika]. +<>:: + +The `geoip` processor adds information about the geographical location of IP +addresses, based on data from the Maxmind databases. This processor adds this +information by default under the `geoip` field. The `geoip` processor is no +longer distributed as a plugin, but is now a module distributed by default with +Elasticsearch. See {ref}/ingest-geoip.html[Ingest `geoip` processor] for more +details. + <>:: A processor that extracts details from the User-Agent header value. @@ -26,4 +35,6 @@ The following plugin has been contributed by our community: include::ingest-attachment.asciidoc[] +include::ingest-geoip.asciidoc[] + include::ingest-user-agent.asciidoc[] \ No newline at end of file diff --git a/docs/reference/ingest/processors/geoip.asciidoc b/docs/reference/ingest/processors/geoip.asciidoc index 6385871c2a2..79020abb02d 100644 --- a/docs/reference/ingest/processors/geoip.asciidoc +++ b/docs/reference/ingest/processors/geoip.asciidoc @@ -1,22 +1,22 @@ [[ingest-geoip]] -=== Ingest Geoip Processor +=== Ingest `geoip` Processor -The GeoIP processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases. +The `geoip` processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases. This processor adds this information by default under the `geoip` field. The `geoip` processor can resolve both IPv4 and IPv6 addresses. -The ingest-geoip module ships by default with the GeoLite2 City, GeoLite2 Country and GeoLite2 ASN geoip2 databases from Maxmind made available +The `ingest-geoip` module ships by default with the GeoLite2 City, GeoLite2 Country and GeoLite2 ASN geoip2 databases from Maxmind made available under the CCA-ShareAlike 4.0 license. For more details see, http://dev.maxmind.com/geoip/geoip2/geolite2/ -The GeoIP processor can run with other geoip2 databases from Maxmind. The files must be copied into the geoip config directory, +The `geoip` processor can run with other GeoIP2 databases from Maxmind. The files must be copied into the `ingest-geoip` config directory, and the `database_file` option should be used to specify the filename of the custom database. Custom database files must be stored -uncompressed. The geoip config directory is located at `$ES_HOME/config/ingest-geoip` and holds the shipped databases too. +uncompressed. The `ingest-geoip` config directory is located at `$ES_HOME/config/ingest-geoip`. [[using-ingest-geoip]] -==== Using the Geoip Processor in a Pipeline +==== Using the `geoip` Processor in a Pipeline [[ingest-geoip-options]] -.Geoip options +.`geoip` options [options="header"] |====== | Name | Required | Default | Description @@ -301,10 +301,10 @@ GET /my_ip_locations/_search [[ingest-geoip-settings]] ===== Node Settings -The geoip processor supports the following setting: +The `geoip` processor supports the following setting: `ingest.geoip.cache_size`:: The maximum number of results that should be cached. Defaults to `1000`. -Note that these settings are node settings and apply to all geoip processors, i.e. there is one cache for all defined geoip processors. +Note that these settings are node settings and apply to all `geoip` processors, i.e. there is one cache for all defined `geoip` processors.