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

Jump to bottom

Add a new readme section for reserved top level field sets #257

Merged
merged 2 commits into from
Dec 10, 2018
Merged

Add a new readme section for reserved top level field sets #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8851565
Add a new readme section for reserved top level field sets
Dec 7, 2018
21f0f04
Changelog
Dec 7, 2018
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ All notable changes to this project will be documented in this file based on the
* Improved the definitions for `event.category` and `event.action`. #242
* Clarify the semantics of `network.direction`. #212
* Add `source.bytes`, `source.packets`, `destination.bytes` and `destination.packets`. #179
* Add a readme section to declare some top level field sets are reserved for
future use. #257

### Deprecated

Expand Down
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,6 +526,16 @@ Contributions of additional uses cases on top of ECS are welcome.



# <a name="reserved-names"></a>Reserved Section Names

ECS does not define the following field sets yet, but the following are expected
in the future. Please avoid using them:

- `match.*`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is new to me :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the result of vulnerability or threat detection. That's how the "match" is recorded (e.g. what field name matched, what time the detection occurred, etc.)

- `protocol.*`
- `threat.*`
- `vulnerability.*`

# <a name="implementing-ecs"></a>Implementing ECS

## Guidelines
Expand Down
10 changes: 10 additions & 0 deletions docs/implementing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# <a name="reserved-names"></a>Reserved Section Names

ECS does not define the following field sets yet, but the following are expected
in the future. Please avoid using them:

- `match.*`
- `protocol.*`
- `threat.*`
- `vulnerability.*`

# <a name="implementing-ecs"></a>Implementing ECS

## Guidelines
Expand Down