Skip to content

Commit

Permalink
Clarify the user.id definition, the field should contain a single I…
Browse files Browse the repository at this point in the history
…D. (#801)
  • Loading branch information
Mathieu Martin authored Mar 26, 2020
1 parent 97e0ae2 commit 4624f51
Show file tree
Hide file tree
Showing 8 changed files with 42 additions and 39 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ Thanks, you're awesome :-) -->

#### Improvements

* Remove misleading pluralization in the description of `user.id`, it should
contain one ID, not many. #801

#### Deprecated


Expand Down
2 changes: 1 addition & 1 deletion code/go/ecs/user.go

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

2 changes: 1 addition & 1 deletion docs/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6468,7 +6468,7 @@ type: keyword
// ===============================================================

| user.id
| Unique identifiers of the user.
| Unique identifier of the user.

type: keyword

Expand Down
12 changes: 6 additions & 6 deletions generated/beats/fields.ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@
level: core
type: keyword
ignore_above: 1024
description: Unique identifiers of the user.
description: Unique identifier of the user.
- name: user.name
level: core
type: keyword
Expand Down Expand Up @@ -726,7 +726,7 @@
level: core
type: keyword
ignore_above: 1024
description: Unique identifiers of the user.
description: Unique identifier of the user.
- name: user.name
level: core
type: keyword
Expand Down Expand Up @@ -1984,7 +1984,7 @@
level: core
type: keyword
ignore_above: 1024
description: Unique identifiers of the user.
description: Unique identifier of the user.
- name: user.name
level: core
type: keyword
Expand Down Expand Up @@ -3847,7 +3847,7 @@
level: core
type: keyword
ignore_above: 1024
description: Unique identifiers of the user.
description: Unique identifier of the user.
- name: user.name
level: core
type: keyword
Expand Down Expand Up @@ -4158,7 +4158,7 @@
level: core
type: keyword
ignore_above: 1024
description: Unique identifiers of the user.
description: Unique identifier of the user.
- name: user.name
level: core
type: keyword
Expand Down Expand Up @@ -4708,7 +4708,7 @@
level: core
type: keyword
ignore_above: 1024
description: Unique identifiers of the user.
description: Unique identifier of the user.
- name: name
level: core
type: keyword
Expand Down
12 changes: 6 additions & 6 deletions generated/csv/fields.csv
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
1.6.0-dev,true,client,client.user.group.id,keyword,extended,,,Unique identifier for the group on the system/platform.
1.6.0-dev,true,client,client.user.group.name,keyword,extended,,,Name of the group.
1.6.0-dev,true,client,client.user.hash,keyword,extended,,,Unique user hash to correlate information for a user in anonymized form.
1.6.0-dev,true,client,client.user.id,keyword,core,,,Unique identifiers of the user.
1.6.0-dev,true,client,client.user.id,keyword,core,,,Unique identifier of the user.
1.6.0-dev,true,client,client.user.name,keyword,core,,albert,Short name or login of the user.
1.6.0-dev,true,client,client.user.name.text,text,core,,albert,Short name or login of the user.
1.6.0-dev,true,cloud,cloud.account.id,keyword,extended,,666777888999,The cloud account or organization id.
Expand Down Expand Up @@ -92,7 +92,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
1.6.0-dev,true,destination,destination.user.group.id,keyword,extended,,,Unique identifier for the group on the system/platform.
1.6.0-dev,true,destination,destination.user.group.name,keyword,extended,,,Name of the group.
1.6.0-dev,true,destination,destination.user.hash,keyword,extended,,,Unique user hash to correlate information for a user in anonymized form.
1.6.0-dev,true,destination,destination.user.id,keyword,core,,,Unique identifiers of the user.
1.6.0-dev,true,destination,destination.user.id,keyword,core,,,Unique identifier of the user.
1.6.0-dev,true,destination,destination.user.name,keyword,core,,albert,Short name or login of the user.
1.6.0-dev,true,destination,destination.user.name.text,text,core,,albert,Short name or login of the user.
1.6.0-dev,true,dll,dll.code_signature.exists,boolean,core,,true,Boolean to capture if a signature is present.
Expand Down Expand Up @@ -245,7 +245,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
1.6.0-dev,true,host,host.user.group.id,keyword,extended,,,Unique identifier for the group on the system/platform.
1.6.0-dev,true,host,host.user.group.name,keyword,extended,,,Name of the group.
1.6.0-dev,true,host,host.user.hash,keyword,extended,,,Unique user hash to correlate information for a user in anonymized form.
1.6.0-dev,true,host,host.user.id,keyword,core,,,Unique identifiers of the user.
1.6.0-dev,true,host,host.user.id,keyword,core,,,Unique identifier of the user.
1.6.0-dev,true,host,host.user.name,keyword,core,,albert,Short name or login of the user.
1.6.0-dev,true,host,host.user.name.text,text,core,,albert,Short name or login of the user.
1.6.0-dev,true,http,http.request.body.bytes,long,extended,,887,Size in bytes of the request body.
Expand Down Expand Up @@ -481,7 +481,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
1.6.0-dev,true,server,server.user.group.id,keyword,extended,,,Unique identifier for the group on the system/platform.
1.6.0-dev,true,server,server.user.group.name,keyword,extended,,,Name of the group.
1.6.0-dev,true,server,server.user.hash,keyword,extended,,,Unique user hash to correlate information for a user in anonymized form.
1.6.0-dev,true,server,server.user.id,keyword,core,,,Unique identifiers of the user.
1.6.0-dev,true,server,server.user.id,keyword,core,,,Unique identifier of the user.
1.6.0-dev,true,server,server.user.name,keyword,core,,albert,Short name or login of the user.
1.6.0-dev,true,server,server.user.name.text,text,core,,albert,Short name or login of the user.
1.6.0-dev,true,service,service.ephemeral_id,keyword,extended,,8a4f500f,Ephemeral identifier of this service.
Expand Down Expand Up @@ -521,7 +521,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
1.6.0-dev,true,source,source.user.group.id,keyword,extended,,,Unique identifier for the group on the system/platform.
1.6.0-dev,true,source,source.user.group.name,keyword,extended,,,Name of the group.
1.6.0-dev,true,source,source.user.hash,keyword,extended,,,Unique user hash to correlate information for a user in anonymized form.
1.6.0-dev,true,source,source.user.id,keyword,core,,,Unique identifiers of the user.
1.6.0-dev,true,source,source.user.id,keyword,core,,,Unique identifier of the user.
1.6.0-dev,true,source,source.user.name,keyword,core,,albert,Short name or login of the user.
1.6.0-dev,true,source,source.user.name.text,text,core,,albert,Short name or login of the user.
1.6.0-dev,true,threat,threat.framework,keyword,extended,,MITRE ATT&CK,Threat classification framework.
Expand Down Expand Up @@ -586,7 +586,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
1.6.0-dev,true,user,user.group.id,keyword,extended,,,Unique identifier for the group on the system/platform.
1.6.0-dev,true,user,user.group.name,keyword,extended,,,Name of the group.
1.6.0-dev,true,user,user.hash,keyword,extended,,,Unique user hash to correlate information for a user in anonymized form.
1.6.0-dev,true,user,user.id,keyword,core,,,Unique identifiers of the user.
1.6.0-dev,true,user,user.id,keyword,core,,,Unique identifier of the user.
1.6.0-dev,true,user,user.name,keyword,core,,albert,Short name or login of the user.
1.6.0-dev,true,user,user.name.text,text,core,,albert,Short name or login of the user.
1.6.0-dev,true,user_agent,user_agent.device.name,keyword,extended,,iPhone,Name of the device.
Expand Down
24 changes: 12 additions & 12 deletions generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -512,15 +512,15 @@ client.user.hash:
type: keyword
client.user.id:
dashed_name: client-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: client.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
client.user.name:
dashed_name: client-user-name
Expand Down Expand Up @@ -1155,15 +1155,15 @@ destination.user.hash:
type: keyword
destination.user.id:
dashed_name: destination-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: destination.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
destination.user.name:
dashed_name: destination-user-name
Expand Down Expand Up @@ -3620,15 +3620,15 @@ host.user.hash:
type: keyword
host.user.id:
dashed_name: host-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: host.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
host.user.name:
dashed_name: host-user-name
Expand Down Expand Up @@ -6649,15 +6649,15 @@ server.user.hash:
type: keyword
server.user.id:
dashed_name: server-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: server.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
server.user.name:
dashed_name: server-user-name
Expand Down Expand Up @@ -7184,15 +7184,15 @@ source.user.hash:
type: keyword
source.user.id:
dashed_name: source-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: source.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
source.user.name:
dashed_name: source-user-name
Expand Down Expand Up @@ -8071,15 +8071,15 @@ user.hash:
type: keyword
user.id:
dashed_name: user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
user.name:
dashed_name: user-name
Expand Down
24 changes: 12 additions & 12 deletions generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -624,15 +624,15 @@ client:
type: keyword
user.id:
dashed_name: client-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: client.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
user.name:
dashed_name: client-user-name
Expand Down Expand Up @@ -1320,15 +1320,15 @@ destination:
type: keyword
user.id:
dashed_name: destination-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: destination.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
user.name:
dashed_name: destination-user-name
Expand Down Expand Up @@ -3963,15 +3963,15 @@ host:
type: keyword
user.id:
dashed_name: host-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: host.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
user.name:
dashed_name: host-user-name
Expand Down Expand Up @@ -7195,15 +7195,15 @@ server:
type: keyword
user.id:
dashed_name: server-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: server.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
user.name:
dashed_name: server-user-name
Expand Down Expand Up @@ -7758,15 +7758,15 @@ source:
type: keyword
user.id:
dashed_name: source-user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: source.user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
original_fieldset: user
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
user.name:
dashed_name: source-user-name
Expand Down Expand Up @@ -8703,14 +8703,14 @@ user:
type: keyword
id:
dashed_name: user-id
description: Unique identifiers of the user.
description: Unique identifier of the user.
flat_name: user.id
ignore_above: 1024
level: core
name: id
normalize: []
order: 0
short: Unique identifiers of the user.
short: Unique identifier of the user.
type: keyword
name:
dashed_name: user-name
Expand Down
2 changes: 1 addition & 1 deletion schemas/user.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
level: core
type: keyword
description: >
Unique identifiers of the user.
Unique identifier of the user.
- name: name
level: core
Expand Down

0 comments on commit 4624f51

Please sign in to comment.