Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ All notable changes to this project will be documented in this file based on the
`server.address`. #247
* Add `os.full` to capture full OS name, including version. #259
* Add generated source code for Go. #249
* Add syslog protocol fields to event namespace. #301

### Improvements
* Improved the definition of the file fields #196
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,10 @@ The event fields are used for context information about the log or metric event
| <a name="event.end"></a>event.end | event.end contains the date when the event ended or when the activity was last observed. | extended | date | |
| <a name="event.risk_score"></a>event.risk_score | Risk score or priority of the event (e.g. security solutions). Use your system's original value here. | core | float | |
| <a name="event.risk_score_norm"></a>event.risk_score_norm | Normalized risk score or priority of the event, on a scale of 0 to 100.<br/>This is mainly useful if you use more than one system that assigns risk scores, and you want to see a normalized value across all systems. | extended | float | |
| <a name="event.facility"></a>event.facility | Value parsed from messages adhering to RFC 5424 or RFC 3164. It represents the process the event has originated from. | core | long | `1` |
| <a name="event.facility_label"></a>event.facility_label | Human readable format of `event.facility`. | extended | keyword | `kernel` |
| <a name="event.priority"></a>event.priority | Value parsed from messages adhering to RFC 5424 or RFC 3164. | core | long | `1` |
| <a name="event.priority_label"></a>event.priority_label | Human readable format of `event.priority`. | extended | keyword | `Informational` |


## <a name="file"></a> File fields
Expand Down
13 changes: 13 additions & 0 deletions code/go/ecs/event.go

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

29 changes: 29 additions & 0 deletions fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,35 @@
This is mainly useful if you use more than one system that assigns
risk scores, and you want to see a normalized value across all systems.

- name: facility
level: core
type: long
example: 1
description: >
Value parsed from messages adhering to RFC 5424 or RFC 3164.
It represents the process the event has originated from.

- name: facility_label
level: extended
type: keyword
example: kernel
description: >
Human readable format of `event.facility`.

- name: priority
level: core
type: long
example: 1
description: >
Value parsed from messages adhering to RFC 5424 or RFC 3164.

- name: priority_label
level: extended
type: keyword
example: Informational
description: >
Human readable format of `event.priority`.

- name: file
group: 2
title: File
Expand Down
4 changes: 4 additions & 0 deletions schema.csv
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,16 @@ event.created,date,core,
event.dataset,keyword,core,stats
event.duration,long,core,
event.end,date,extended,
event.facility,long,core,1
event.facility_label,keyword,extended,kernel
event.hash,keyword,extended,123456789012345678901234567890ABCD
event.id,keyword,core,8a4f500d
event.kind,keyword,extended,state
event.module,keyword,core,mysql
event.original,(not indexed),core,Sep 19 08:26:10 host CEF:0&#124;Security&#124; threatmanager&#124;1.0&#124;100&#124; worm successfully stopped&#124;10&#124;src=10.0.0.1 dst=2.1.2.2spt=1232
event.outcome,keyword,extended,success
event.priority,long,core,1
event.priority_label,keyword,extended,Informational
event.risk_score,float,core,
event.risk_score_norm,float,extended,
event.severity,long,core,7
Expand Down
40 changes: 40 additions & 0 deletions schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -534,6 +534,26 @@
"required": false,
"type": "date"
},
"event.facility": {
"description": "Value parsed from messages adhering to RFC 5424 or RFC 3164. It represents the process the event has originated from.",
"example": "1",
"footnote": "",
"group": 2,
"level": "core",
"name": "event.facility",
"required": false,
"type": "long"
},
"event.facility_label": {
"description": "Human readable format of `event.facility`.",
"example": "kernel",
"footnote": "",
"group": 2,
"level": "extended",
"name": "event.facility_label",
"required": false,
"type": "keyword"
},
"event.hash": {
"description": "Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity.",
"example": "123456789012345678901234567890ABCD",
Expand Down Expand Up @@ -594,6 +614,26 @@
"required": false,
"type": "keyword"
},
"event.priority": {
"description": "Value parsed from messages adhering to RFC 5424 or RFC 3164.",
"example": "1",
"footnote": "",
"group": 2,
"level": "core",
"name": "event.priority",
"required": false,
"type": "long"
},
"event.priority_label": {
"description": "Human readable format of `event.priority`.",
"example": "Informational",
"footnote": "",
"group": 2,
"level": "extended",
"name": "event.priority_label",
"required": false,
"type": "keyword"
},
"event.risk_score": {
"description": "Risk score or priority of the event (e.g. security solutions). Use your system's original value here.",
"example": "",
Expand Down
29 changes: 29 additions & 0 deletions schemas/event.yml
Original file line number Diff line number Diff line change
Expand Up @@ -195,3 +195,32 @@
This is mainly useful if you use more than one system that assigns
risk scores, and you want to see a normalized value across all systems.
- name: facility
level: core
type: long
example: 1
description: >
Value parsed from messages adhering to RFC 5424 or RFC 3164.
Copy link
Contributor

Choose a reason for hiding this comment

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

Enhance this definition to something like: "The facility or process from which the event originated. Typically associated with syslog facility for events adhering to RFC 5424 or RFC 3164."

It represents the process the event has originated from.
- name: facility_label
level: extended
type: keyword
example: kernel
description: >
Human readable format of `event.facility`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Rather than "Human readable", can we add "text-based" or something similar? Humans can read numbers too :-)

- name: priority
level: core
type: long
example: 1
description: >
Value parsed from messages adhering to RFC 5424 or RFC 3164.
Copy link
Contributor

Choose a reason for hiding this comment

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

Enhance this definition to something like: "The priority of the event. Typically associated with syslog priority for events adhering to RFC 5424 or RFC 3164."

- name: priority_label
level: extended
type: keyword
example: Informational
description: >
Human readable format of `event.priority`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Rather than "Human readable", can we add "text-based" or something similar? Humans can read numbers too :-)

Copy link
Contributor

Choose a reason for hiding this comment

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

The Informational example here is an example of a severity label (which maps to log.level in ECS).

I don't think there is such a thing as a priority label in Syslog. The priority number is the one made up of 8*facility + severity.

I think we need to remove this field.

14 changes: 14 additions & 0 deletions template.json
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,13 @@
"end": {
"type": "date"
},
"facility": {
"type": "long"
},
"facility_label": {
"ignore_above": 1024,
"type": "keyword"
},
"hash": {
"ignore_above": 1024,
"type": "keyword"
Expand All @@ -251,6 +258,13 @@
"ignore_above": 1024,
"type": "keyword"
},
"priority": {
"type": "long"
},
"priority_label": {
"ignore_above": 1024,
"type": "keyword"
},
"risk_score": {
"type": "float"
},
Expand Down