Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport #333 to 1.0: Clarify geo field set description. (#333) #365

Merged
merged 1 commit into from
Mar 5, 2019
Merged

Backport #333 to 1.0: Clarify geo field set description. (#333) #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ All notable changes to this project will be documented in this file based on the
* Clarified the definition of the host fields #325
* Clarified the difference between `@timestamp` and `event.created`. #329
* Specify the `object_type` for field `labels`. #331
* Loosen up definition of `geo` field set. Not necessarily geo-ip based, since `geo.name`. #333

### Deprecated

Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,9 @@ File objects can be associated with host events, network events, and/or file eve

## <a name="geo"></a> Geo fields

Geo fields can carry data about a specific location related to an event or geo information derived from an IP field.
Geo fields can carry data about a specific location related to an event.

This geolocation information can be derived from techniques such as Geo IP, or be user-supplied.


The `geo` fields are expected to be nested at: `client.geo`, `destination.geo`, `host.geo`, `observer.geo`, `server.geo`, `source.geo`.
Expand Down
6 changes: 4 additions & 2 deletions fields.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -747,8 +747,10 @@
group: 2
short: Fields describing a location.
description: >
Geo fields can carry data about a specific location related to an event
or geo information derived from an IP field.
Geo fields can carry data about a specific location related to an event.
This geolocation information can be derived from techniques such as Geo IP,
or be user-supplied.
reusable:
top_level: false
expected:
Expand Down
2 changes: 1 addition & 1 deletion schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -810,7 +810,7 @@
"type": "group"
},
"geo": {
"description": "Geo fields can carry data about a specific location related to an event or geo information derived from an IP field.\n",
"description": "Geo fields can carry data about a specific location related to an event.\nThis geolocation information can be derived from techniques such as Geo IP, or be user-supplied.\n",
"fields": {
"geo.city_name": {
"description": "City name.",
Expand Down
6 changes: 4 additions & 2 deletions schemas/geo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
group: 2
short: Fields describing a location.
description: >
Geo fields can carry data about a specific location related to an event
or geo information derived from an IP field.
Geo fields can carry data about a specific location related to an event.
This geolocation information can be derived from techniques such as Geo IP,
or be user-supplied.
reusable:
top_level: false
expected:
Expand Down