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.

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

Add os.type field #1111

Merged
merged 11 commits into from
Nov 18, 2020
Merged
Show file tree
Hide file tree
Changes from 4 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.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Thanks, you're awesome :-) -->

* Added `event.category` "registry". #1040
* Added `event.category` "session". #1049
* Added `os.commercial_family`. #1111
webmat marked this conversation as resolved.
Show resolved Hide resolved

#### Improvements

Expand Down
8 changes: 8 additions & 0 deletions code/go/ecs/os.go

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

17 changes: 17 additions & 0 deletions docs/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3853,6 +3853,23 @@ The OS fields contain information about the operating system.

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

| os.commercial_family
| Categorize the operating system in one of the broad commercial families.

One of these following values should be used (lowercase): linux, macos, unix, windows.
randomuserid marked this conversation as resolved.
Show resolved Hide resolved

If the OS is not part of any of these families, the field should not be populated. Please let us know by opening an issue with ECS, to have it added to the list.

type: keyword



example: `macos`

| extended

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

| os.family
| OS family (such as redhat, debian, freebsd, windows).

Expand Down
56 changes: 56 additions & 0 deletions experimental/generated/beats/fields.ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2131,6 +2131,20 @@
It can contain what `hostname` returns on Unix systems, the fully qualified
domain name, or a name specified by the user. The sender decides which value
to use.'
- name: os.commercial_family
level: extended
type: keyword
ignore_above: 1024
description: 'Categorize the operating system in one of the broad commercial
families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
default_field: false
- name: os.family
level: extended
type: keyword
Expand Down Expand Up @@ -2879,6 +2893,20 @@

If no custom name is needed, the field can be left empty.'
example: 1_proxySG
- name: os.commercial_family
level: extended
type: keyword
ignore_above: 1024
description: 'Categorize the operating system in one of the broad commercial
families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
default_field: false
- name: os.family
level: extended
type: keyword
Expand Down Expand Up @@ -2984,6 +3012,20 @@
description: The OS fields contain information about the operating system.
type: group
fields:
- name: commercial_family
level: extended
type: keyword
ignore_above: 1024
description: 'Categorize the operating system in one of the broad commercial
families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
default_field: false
- name: family
level: extended
type: keyword
Expand Down Expand Up @@ -5666,6 +5708,20 @@
description: Unparsed user_agent string.
example: Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15
(KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1
- name: os.commercial_family
level: extended
type: keyword
ignore_above: 1024
description: 'Categorize the operating system in one of the broad commercial
families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
default_field: false
- name: os.family
level: extended
type: keyword
Expand Down
3 changes: 3 additions & 0 deletions experimental/generated/csv/fields.csv
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
2.0.0-dev,true,host,host.ip,ip,core,array,,Host ip addresses.
2.0.0-dev,true,host,host.mac,keyword,core,array,,Host mac addresses.
2.0.0-dev,true,host,host.name,keyword,core,,,Name of the host.
2.0.0-dev,true,host,host.os.commercial_family,keyword,extended,,macos,"Which commercial OS family (one of: linux, macos, unix or windows)."
2.0.0-dev,true,host,host.os.family,keyword,extended,,debian,"OS family (such as redhat, debian, freebsd, windows)."
2.0.0-dev,true,host,host.os.full,wildcard,extended,,Mac OS Mojave,"Operating system name, including the version or code name."
2.0.0-dev,true,host,host.os.full.text,text,extended,,Mac OS Mojave,"Operating system name, including the version or code name."
Expand Down Expand Up @@ -334,6 +335,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
2.0.0-dev,true,observer,observer.ip,ip,core,array,,IP addresses of the observer.
2.0.0-dev,true,observer,observer.mac,keyword,core,array,,MAC addresses of the observer
2.0.0-dev,true,observer,observer.name,keyword,extended,,1_proxySG,Custom name of the observer.
2.0.0-dev,true,observer,observer.os.commercial_family,keyword,extended,,macos,"Which commercial OS family (one of: linux, macos, unix or windows)."
2.0.0-dev,true,observer,observer.os.family,keyword,extended,,debian,"OS family (such as redhat, debian, freebsd, windows)."
2.0.0-dev,true,observer,observer.os.full,wildcard,extended,,Mac OS Mojave,"Operating system name, including the version or code name."
2.0.0-dev,true,observer,observer.os.full.text,text,extended,,Mac OS Mojave,"Operating system name, including the version or code name."
Expand Down Expand Up @@ -695,6 +697,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
2.0.0-dev,true,user_agent,user_agent.name,keyword,extended,,Safari,Name of the user agent.
2.0.0-dev,true,user_agent,user_agent.original,wildcard,extended,,"Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1",Unparsed user_agent string.
2.0.0-dev,true,user_agent,user_agent.original.text,text,extended,,"Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1",Unparsed user_agent string.
2.0.0-dev,true,user_agent,user_agent.os.commercial_family,keyword,extended,,macos,"Which commercial OS family (one of: linux, macos, unix or windows)."
2.0.0-dev,true,user_agent,user_agent.os.family,keyword,extended,,debian,"OS family (such as redhat, debian, freebsd, windows)."
2.0.0-dev,true,user_agent,user_agent.os.full,wildcard,extended,,Mac OS Mojave,"Operating system name, including the version or code name."
2.0.0-dev,true,user_agent,user_agent.os.full.text,text,extended,,Mac OS Mojave,"Operating system name, including the version or code name."
Expand Down
54 changes: 54 additions & 0 deletions experimental/generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3337,6 +3337,24 @@ host.name:
normalize: []
short: Name of the host.
type: keyword
host.os.commercial_family:
dashed_name: host-os-commercial-family
description: 'Categorize the operating system in one of the broad commercial families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
flat_name: host.os.commercial_family
ignore_above: 1024
level: extended
name: commercial_family
normalize: []
original_fieldset: os
short: 'Which commercial OS family (one of: linux, macos, unix or windows).'
type: keyword
host.os.family:
dashed_name: host-os-family
description: OS family (such as redhat, debian, freebsd, windows).
Expand Down Expand Up @@ -4473,6 +4491,24 @@ observer.name:
normalize: []
short: Custom name of the observer.
type: keyword
observer.os.commercial_family:
dashed_name: observer-os-commercial-family
description: 'Categorize the operating system in one of the broad commercial families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
flat_name: observer.os.commercial_family
ignore_above: 1024
level: extended
name: commercial_family
normalize: []
original_fieldset: os
short: 'Which commercial OS family (one of: linux, macos, unix or windows).'
type: keyword
observer.os.family:
dashed_name: observer-os-family
description: OS family (such as redhat, debian, freebsd, windows).
Expand Down Expand Up @@ -8710,6 +8746,24 @@ user_agent.original:
normalize: []
short: Unparsed user_agent string.
type: wildcard
user_agent.os.commercial_family:
dashed_name: user-agent-os-commercial-family
description: 'Categorize the operating system in one of the broad commercial families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
flat_name: user_agent.os.commercial_family
ignore_above: 1024
level: extended
name: commercial_family
normalize: []
original_fieldset: os
short: 'Which commercial OS family (one of: linux, macos, unix or windows).'
type: keyword
user_agent.os.family:
dashed_name: user-agent-os-family
description: OS family (such as redhat, debian, freebsd, windows).
Expand Down
75 changes: 75 additions & 0 deletions experimental/generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4000,6 +4000,25 @@ host:
normalize: []
short: Name of the host.
type: keyword
host.os.commercial_family:
dashed_name: host-os-commercial-family
description: 'Categorize the operating system in one of the broad commercial
families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
flat_name: host.os.commercial_family
ignore_above: 1024
level: extended
name: commercial_family
normalize: []
original_fieldset: os
short: 'Which commercial OS family (one of: linux, macos, unix or windows).'
type: keyword
host.os.family:
dashed_name: host-os-family
description: OS family (such as redhat, debian, freebsd, windows).
Expand Down Expand Up @@ -5253,6 +5272,25 @@ observer:
normalize: []
short: Custom name of the observer.
type: keyword
observer.os.commercial_family:
dashed_name: observer-os-commercial-family
description: 'Categorize the operating system in one of the broad commercial
families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
flat_name: observer.os.commercial_family
ignore_above: 1024
level: extended
name: commercial_family
normalize: []
original_fieldset: os
short: 'Which commercial OS family (one of: linux, macos, unix or windows).'
type: keyword
observer.os.family:
dashed_name: observer-os-family
description: OS family (such as redhat, debian, freebsd, windows).
Expand Down Expand Up @@ -5461,6 +5499,24 @@ organization:
os:
description: The OS fields contain information about the operating system.
fields:
os.commercial_family:
dashed_name: os-commercial-family
description: 'Categorize the operating system in one of the broad commercial
families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
flat_name: os.commercial_family
ignore_above: 1024
level: extended
name: commercial_family
normalize: []
short: 'Which commercial OS family (one of: linux, macos, unix or windows).'
type: keyword
os.family:
dashed_name: os-family
description: OS family (such as redhat, debian, freebsd, windows).
Expand Down Expand Up @@ -10024,6 +10080,25 @@ user_agent:
normalize: []
short: Unparsed user_agent string.
type: wildcard
user_agent.os.commercial_family:
dashed_name: user-agent-os-commercial-family
description: 'Categorize the operating system in one of the broad commercial
families.

One of these following values should be used (lowercase): linux, macos, unix,
windows.

If the OS is not part of any of these families, the field should not be populated.
Please let us know by opening an issue with ECS, to have it added to the list.'
example: macos
flat_name: user_agent.os.commercial_family
ignore_above: 1024
level: extended
name: commercial_family
normalize: []
original_fieldset: os
short: 'Which commercial OS family (one of: linux, macos, unix or windows).'
type: keyword
user_agent.os.family:
dashed_name: user-agent-os-family
description: OS family (such as redhat, debian, freebsd, windows).
Expand Down
12 changes: 12 additions & 0 deletions experimental/generated/elasticsearch/7/template.json
Original file line number Diff line number Diff line change
Expand Up @@ -1103,6 +1103,10 @@
},
"os": {
"properties": {
"commercial_family": {
"ignore_above": 1024,
"type": "keyword"
},
"family": {
"ignore_above": 1024,
"type": "keyword"
Expand Down Expand Up @@ -1558,6 +1562,10 @@
},
"os": {
"properties": {
"commercial_family": {
"ignore_above": 1024,
"type": "keyword"
},
"family": {
"ignore_above": 1024,
"type": "keyword"
Expand Down Expand Up @@ -3206,6 +3214,10 @@
},
"os": {
"properties": {
"commercial_family": {
"ignore_above": 1024,
"type": "keyword"
},
"family": {
"ignore_above": 1024,
"type": "keyword"
Expand Down
Loading