|
1326 | 1326 | "model_id" |
1327 | 1327 | ] |
1328 | 1328 | }, |
| 1329 | + "IpLocationProcessor": { |
| 1330 | + "properties": { |
| 1331 | + "description": { |
| 1332 | + "type": "string", |
| 1333 | + "description": "Description of the processor. Useful for describing the purpose of the processor or its configuration." |
| 1334 | + }, |
| 1335 | + "if": { |
| 1336 | + "type": "string", |
| 1337 | + "description": "Conditionally execute the processor." |
| 1338 | + }, |
| 1339 | + "ignore_failure": { |
| 1340 | + "type": "boolean", |
| 1341 | + "description": "Ignore failures for the processor." |
| 1342 | + }, |
| 1343 | + "on_failure": { |
| 1344 | + "items": { |
| 1345 | + "$ref": "#/$defs/ProcessorContainer" |
| 1346 | + }, |
| 1347 | + "type": "array", |
| 1348 | + "description": "Handle failures for the processor." |
| 1349 | + }, |
| 1350 | + "tag": { |
| 1351 | + "type": "string", |
| 1352 | + "description": "Identifier for the processor. Useful for debugging and metrics." |
| 1353 | + }, |
| 1354 | + "database_file": { |
| 1355 | + "type": "string", |
| 1356 | + "description": "The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.", |
| 1357 | + "default": "GeoLite2-City.mmdb" |
| 1358 | + }, |
| 1359 | + "field": { |
| 1360 | + "type": "string", |
| 1361 | + "description": "The field to get the ip address from for the geographical lookup. Required." |
| 1362 | + }, |
| 1363 | + "first_only": { |
| 1364 | + "type": "boolean", |
| 1365 | + "description": "If `true`, only the first found IP location data will be returned, even if the field contains an array.", |
| 1366 | + "default": true |
| 1367 | + }, |
| 1368 | + "ignore_missing": { |
| 1369 | + "type": "boolean", |
| 1370 | + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", |
| 1371 | + "default": false |
| 1372 | + }, |
| 1373 | + "properties": { |
| 1374 | + "items": { |
| 1375 | + "type": "string" |
| 1376 | + }, |
| 1377 | + "type": "array", |
| 1378 | + "description": "Controls what properties are added to the `target_field` based on the IP location lookup." |
| 1379 | + }, |
| 1380 | + "target_field": { |
| 1381 | + "type": "string", |
| 1382 | + "description": "The field that will hold the geographical information looked up from the MaxMind database.", |
| 1383 | + "default": "geoip" |
| 1384 | + }, |
| 1385 | + "download_database_on_pipeline_creation": { |
| 1386 | + "type": "boolean", |
| 1387 | + "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index." |
| 1388 | + } |
| 1389 | + }, |
| 1390 | + "additionalProperties": false, |
| 1391 | + "type": "object", |
| 1392 | + "required": [ |
| 1393 | + "field" |
| 1394 | + ] |
| 1395 | + }, |
1329 | 1396 | "JoinProcessor": { |
1330 | 1397 | "properties": { |
1331 | 1398 | "description": { |
|
1770 | 1837 | "$ref": "#/$defs/ForeachProcessor", |
1771 | 1838 | "description": "Runs an ingest processor on each element of an array or object." |
1772 | 1839 | }, |
| 1840 | + "ip_location": { |
| 1841 | + "$ref": "#/$defs/IpLocationProcessor", |
| 1842 | + "description": "Currently an undocumented alias for GeoIP Processor." |
| 1843 | + }, |
1773 | 1844 | "geo_grid": { |
1774 | 1845 | "$ref": "#/$defs/GeoGridProcessor", |
1775 | 1846 | "description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape. This is useful if there is a need to interact with the tile shapes as spatially indexable fields." |
|
0 commit comments