Skip to content

Commit

Permalink
Updated Readme for ECS standard support docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BenB196 committed Mar 7, 2020
1 parent 49307ae commit 1ccfa96
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,4 +168,17 @@ ip_api_proxy_successful_queries_total 0
ip_api_proxy_successful_single_queries_total 0
```

## Elastic Common Schema (ECS) Support

Support for outputting IP-API results in the [ECS Standard](https://www.elastic.co/guide/en/ecs/current/ecs-geo.html) has been added. In order to get results in this format, when making queries against the API use ecs=false in the HTTP request:

ex:
```
http://localhost:8080/batch?ecs=true
```

This will return an output that matches the [ECS Standard](https://www.elastic.co/guide/en/ecs/current/ecs-geo.html)

Note: There are additional fields returned by IP-API, that are not listed under [ECS Standard](https://www.elastic.co/guide/en/ecs/current/ecs-geo.html), if you want to index these fields, please make sure you're index template is designed to handle them.

If you have ideas for other metrics which you feel would be useful, please let me know.

0 comments on commit 1ccfa96

Please sign in to comment.