mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
Due to problems discovered in #72572 we have to disable geoip downloader for now. We use ingest.geoip.downloader.enabled.default as feature flag. This change also reverts changes to docs.
90 lines
1.7 KiB
Text
90 lines
1.7 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.
|
|
|
|
[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>`.
|
|
=====
|
|
====
|