Skip to content

Commit

Permalink
Add a 'how to populate ECS fields' section to readme...
Browse files Browse the repository at this point in the history
Trying to work Mike's points in, as mentioned [here](elastic#334 (comment)).
  • Loading branch information
Mathieu Martin committed Feb 26, 2019
1 parent ca9d77f commit 60bcbfe
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ in the future. Please avoid using them:

**Writing fields**

* All fields must be lower case
* All field names must be lower case
* Combine words using underscore
* No special characters except `_`

Expand All @@ -621,6 +621,23 @@ in the future. Please avoid using them:
* *Use prefixes.* Fields must be prefixed except for the base fields. For example all `host` fields are prefixed with `host.`. See `dot` notation in FAQ for more details.
* Do not use abbreviations. (A few exceptions like `ip` exist.)

**How to populate ECS fields**

* Start by populating Core fields. These fields are the most common across all use cases.
* Populate as many Extended fields as practical. They generally apply to more narrow
use cases, so feel free to skip fields that are not applicable to your use case.
* When populating ECS fields, don't hesitate to duplicate data to all applicable
fields. This will ensure your data will be interoperable with the most
applications and content (such as visualizations), whether they are made by Elastic
or from the community.
* Try to populate ECS fields even if they are not in your event source. For example,
a Firewall event coming over syslog will not mention syslog. But `agent.type`
should still be set to "syslog".
* You're free to duplicate existing fields over to ECS fields, or to migrate your
fields to use the ECS names. The decision is up to you or the implementation.
What's important for ECS content and applications is the presence of the ECS
fields. Other fields are custom fields, and you can use them however you prefer.

## Normalization

In order to be help allow for correlation across different sources, ECS must sometimes
Expand Down
19 changes: 18 additions & 1 deletion docs/implementing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ in the future. Please avoid using them:

**Writing fields**

* All fields must be lower case
* All field names must be lower case
* Combine words using underscore
* No special characters except `_`

Expand All @@ -34,6 +34,23 @@ in the future. Please avoid using them:
* *Use prefixes.* Fields must be prefixed except for the base fields. For example all `host` fields are prefixed with `host.`. See `dot` notation in FAQ for more details.
* Do not use abbreviations. (A few exceptions like `ip` exist.)

**How to populate ECS fields**

* Start by populating Core fields. These fields are the most common across all use cases.
* Populate as many Extended fields as practical. They generally apply to more narrow
use cases, so feel free to skip fields that are not applicable to your use case.
* When populating ECS fields, don't hesitate to duplicate data to all applicable
fields. This will ensure your data will be interoperable with the most
applications and content (such as visualizations), whether they are made by Elastic
or from the community.
* Try to populate ECS fields even if they are not in your event source. For example,
a Firewall event coming over syslog will not mention syslog. But `agent.type`
should still be set to "syslog".
* You're free to duplicate existing fields over to ECS fields, or to migrate your
fields to use the ECS names. The decision is up to you or the implementation.
What's important for ECS content and applications is the presence of the ECS
fields. Other fields are custom fields, and you can use them however you prefer.

## Normalization

In order to be help allow for correlation across different sources, ECS must sometimes
Expand Down

0 comments on commit 60bcbfe

Please sign in to comment.