mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
9706d676a1
This change will enable geoip downloader by default again. It also brings back relevant documentation.
93 lines
No EOL
1.9 KiB
Text
93 lines
No EOL
1.9 KiB
Text
[[geoip-stats-api]]
|
|
=== GeoIP stats API
|
|
++++
|
|
<titleabbrev>GeoIP stats</titleabbrev>
|
|
++++
|
|
|
|
Gets download statistics for GeoIP2 databases used with the
|
|
<<geoip-processor,`geoip` processor>>.
|
|
|
|
[source,console]
|
|
----
|
|
GET _ingest/geoip/stats
|
|
----
|
|
|
|
[[geoip-stats-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET _ingest/geoip/stats`
|
|
|
|
[[geoip-stats-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `monitor` or
|
|
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
* If <<ingest-geoip-downloader-enabled,`ingest.geoip.downloader.enabled`>> is
|
|
disabled, this API returns zero values and an empty `nodes` object.
|
|
|
|
[role="child_attributes"]
|
|
[[geoip-stats-api-response-body]]
|
|
==== {api-response-body-title}
|
|
|
|
`stats`::
|
|
(object)
|
|
Download statistics for all GeoIP2 databases.
|
|
+
|
|
.Properties of `stats`
|
|
[%collapsible%open]
|
|
====
|
|
`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.
|
|
|
|
`database_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`
|
|
[%collapsible%open]
|
|
====
|
|
`<node_id>`::
|
|
(object)
|
|
Downloaded databases for the node. The field key is the node ID.
|
|
+
|
|
.Properties of `<node_id>`
|
|
[%collapsible%open]
|
|
=====
|
|
`databases`::
|
|
(array of objects)
|
|
Downloaded databases for the node.
|
|
+
|
|
.Properties of `databases` objects
|
|
[%collapsible%open]
|
|
======
|
|
`name`::
|
|
(string)
|
|
Name of the database.
|
|
======
|
|
|
|
`files_in_temp`::
|
|
(array of strings)
|
|
Downloaded database files, including related license files. {es} stores these
|
|
files in the node's <<es-tmpdir,temporary directory>>:
|
|
`$ES_TMPDIR/geoip-databases/<node_id>`.
|
|
=====
|
|
==== |