Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
c2b547f
Fill in categorization values that are expected over time
Dec 12, 2019
5c29f4d
Add in-page navigation TOC to the accepted values pages
Dec 12, 2019
a2b27a4
Get rid of spacing shenanigans. Commas work better.
Dec 13, 2019
82a9e48
Integrate public doc's wording as a placeholder for the top of the ca…
Dec 13, 2019
9176c2f
Integrate current field description as the top of the categorization …
Dec 13, 2019
8668894
Trim down the list of categories to the ones we're introducing in 1.4
Dec 13, 2019
a093adf
Changelog
Dec 13, 2019
f3e2b80
Introduce definitions pretty much as they are in the public comments …
Dec 13, 2019
91aec05
Replace 'accepted' with 'allowed'
Dec 13, 2019
c614d2a
Add static warning text
Dec 13, 2019
9adcb7c
make debugging output less verbose
Dec 16, 2019
d30d9aa
Integrate Mike's out of band feedback
Dec 16, 2019
3db941d
Adjust mention of event type names to use the correct wording
Dec 16, 2019
6b5792a
Add explicit mentions that event.category and event.type are array fi…
Dec 16, 2019
8db19a9
Undo debugging code that didn't actually help
Dec 16, 2019
af6fcc5
First try at a warning message at the top of the categorization section
Dec 16, 2019
84a53f7
TIL about the WARNING asciidoc label :-)
Dec 16, 2019
e0d858a
Use wording 'This value' & remove redundant sentences in event.kind v…
Dec 16, 2019
4443b5e
Render value descriptions as asciidoc paragraphs
Dec 16, 2019
b4ffafd
Update the description of event.kind signal
Dec 16, 2019
c5ba19d
Replace TOC with 'Allowed Values'
Dec 16, 2019
33171ef
Adjust a lot of the value definitions with some of the feedback.
Dec 16, 2019
2ebba70
Adjust the 4 short definitions
webmat Dec 17, 2019
23bc882
Adjust 4 categorization page warnings, add note to leave fields empty
Dec 17, 2019
48daa1b
Rephrase the 'what it is' vs 'where it's from' text
Dec 17, 2019
30d954e
Merge branch 'categorization-values' of github.com:webmat/ecs into ca…
Dec 17, 2019
f3bae7b
Flesh out the event.kind description
Dec 17, 2019
a2701cd
Merge branch 'master' into categorization-values
Dec 17, 2019
20ab515
Mention categorization in the changelog
Dec 17, 2019
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.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Thanks, you're awesome :-) -->
* Added `rule` fields. #665
* Added default `text` analyzer as a multi-field to around 25 more fields. #680
* Added `registry.*` fieldset for the Windows registry. #673
* Publish initial list of allowed values for the categorization fields (previously reserved)
`event.kind`, `event.category`, `event.type` and `event.outcome`. #684, #691, #692
* Added `related.user` #694

#### Improvements
Expand Down
43 changes: 31 additions & 12 deletions code/go/ecs/event.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 25 additions & 17 deletions docs/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1135,19 +1135,21 @@ example: `user-password-change`
// ===============================================================

| event.category
| Event category.
| This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy.

This contains high-level information about the contents of the event. It is more generic than `event.action`, in the sense that typically a category contains multiple actions.
`event.category` represents the "big buckets" of ECS categories. For example, filtering on `event.category:process` yields all events relating to process activity. This field is closely related to `event.type`, which is used as a subcategory.

This field is an array. This will allow proper categorization of some events that fall in multiple categories.

type: keyword


*Important*: The field value must be one of the following:

authentication{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}process
authentication, database, driver, file, host, intrusion_detection, malware, package, process, web

To learn more about when to use which value, visit the page
<<ecs-accepted-values-event-category,accepted values for event.category>>
<<ecs-allowed-values-event-category,allowed values for event.category>>


| core
Expand Down Expand Up @@ -1261,22 +1263,24 @@ example: `2016-05-23 08:05:35.101000`
// ===============================================================

| event.kind
| The kind of the event.
| This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy.

`event.kind` gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events.

This gives information about what type of information the event contains, without being specific to the contents of the event.
The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.

type: keyword


*Important*: The field value must be one of the following:

alert{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}event
alert, event, metric, state, pipeline_error, signal

To learn more about when to use which value, visit the page
<<ecs-accepted-values-event-kind,accepted values for event.kind>>
<<ecs-allowed-values-event-kind,allowed values for event.kind>>


| extended
| core

// ===============================================================

Expand Down Expand Up @@ -1307,22 +1311,22 @@ example: `Sep 19 08:26:10 host CEF:0&#124;Security&#124; threatmanager&#124;1.0&
// ===============================================================

| event.outcome
| The outcome of the event.
| This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy.

If the event describes an action, this fields contains the outcome of that action.
`event.outcome` simply denotes whether the event represent a success or a failure. Note that not all events will have an associated outcome. For example, this field is generally not populated for metric events or events with `event.type:info`.

type: keyword


*Important*: The field value must be one of the following:

success{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}failure
failure, success, unknown

To learn more about when to use which value, visit the page
<<ecs-accepted-values-event-outcome,accepted values for event.outcome>>
<<ecs-allowed-values-event-outcome,allowed values for event.outcome>>


| extended
| core

// ===============================================================

Expand Down Expand Up @@ -1416,17 +1420,21 @@ type: keyword
// ===============================================================

| event.type
| Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
| This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy.

`event.type` represents a categorization "sub-bucket" that, when used along with the `event.category` field values, enables filtering events down to a level appropriate for single visualization.

This field is an array. This will allow proper categorization of some events that fall in multiple event types.

type: keyword


*Important*: The field value must be one of the following:

start{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}end
access, change, creation, deletion, end, error, info, installation, start

To learn more about when to use which value, visit the page
<<ecs-accepted-values-event-type,accepted values for event.type>>
<<ecs-allowed-values-event-type,allowed values for event.type>>


| core
Expand Down
Loading