GeoIP stats API

GeoIP stats API

Gets download statistics for GeoIP2 databases used with the geoip processor.

GET _ingest/geoip/stats

Request

GET _ingest/geoip/stats

Prerequisites

• If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.
• If ingest.geoip.downloader.enabled is disabled, this API returns zero values and an empty nodes object.

Response body

stats

(object) Download statistics for all GeoIP2 databases.

Properties of stats

• successful_downloads

  (integer) Total number of successful database downloads.

  failed_downloads

  (integer) Total number of failed database downloads.

  total_download_time

  (integer) Total milliseconds spent downloading databases.

  databases_count

  (integer) Current number of databases available for use.

  skipped_updates

  (integer) Total number of database updates skipped.

nodes

(object) Downloaded GeoIP2 databases for each node.

Properties of nodes

• <node_id>

  (object) Downloaded databases for the node. The field key is the node ID.

  Properties of <node_id>

  • databases

    (array of objects) Downloaded databases for the node.

    Properties of databases objects

    name

    (string) Name of the database.

    files_in_temp

    (array of strings) Downloaded database files, including related license files. Elasticsearch stores these files in the node’s temporary directory: $ES_TMPDIR/geoip-databases/<node_id>.

• « Delete pipeline API
• Get pipeline API »