Skip to content

Changes related to merging RFC 0007 at stage 3 #1066

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.

Sign up for GitHub

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

Merged
webmat merged 18 commits into from
Dec 7, 2020
Merged

Changes related to merging RFC 0007 at stage 3 #1066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
746c156
Apply new user field reuse in main ECS field definitions.
Oct 30, 2020
c124d82
WIP transferring a lot of the RFC explanations to a new user usage page
Oct 30, 2020
613a525
Changelog
Oct 30, 2020
6906487
Section on categorizing IAM activity
Nov 2, 2020
6d805b6
Add a TOC to the page
Nov 2, 2020
4efecc9
Subtleties around field reuse
Nov 2, 2020
0f247f2
Deprecation of host.user.*
Nov 2, 2020
7002fe4
Additional callouts for one of the examples
Nov 2, 2020
daafe57
Fix list nesting, improve wording in a few places
Nov 2, 2020
63b203f
escalate "to"
webmat Nov 6, 2020
65e534b
Root uid is zeero
Nov 6, 2020
f82ba40
Clarify instead of what
webmat Nov 6, 2020
459976e
Add a short section on user identifier gotchas.
Nov 11, 2020
7c3b299
Another attempt at explaining the self-reuse subtleties.
Nov 11, 2020
f1db3b0
Merge branch 'master' into rfc/0007/apply-stage-3
Nov 23, 2020
dbef721
Introduce the 'beta' markers for the new 'user' field reuses
Nov 23, 2020
e573f8e
Break a paragraph in two, to make sure that second part stands out
webmat Dec 4, 2020
94cac00
Link to 'Mapping Network Events' page, as suggested in review
Dec 4, 2020
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
4 changes: 4 additions & 0 deletions CHANGELOG.next.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,16 @@ Thanks, you're awesome :-) -->

* Added `event.category` "registry". #1040
* Added `event.category` "session". #1049
* Added usage documentation for `user` fields. #1066
* Added `user` fields at `user.effective.*`, `user.target.*` and `user.changes.*`. #1066
* Added `os.type`. #1111

#### Improvements

#### Deprecated

* Deprecated `host.user.*` fields for removal at the next major. #1066

### Tooling and Artifact Changes

#### Breaking changes
Expand Down
31 changes: 30 additions & 1 deletion docs/field-details.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6458,6 +6458,10 @@ The user fields describe information about the user that is relevant to the even

Fields can have one entry or multiple entries. If a user has more than one id, provide an array that includes all of them.

Find additional usage and examples in the user fields <<ecs-user-usage,usage>> section.



[discrete]
==== User Field Details

Expand Down Expand Up @@ -6582,7 +6586,7 @@ example: `["kibana_admin", "reporting_user"]`
[discrete]
==== Field Reuse

The `user` fields are expected to be nested at: `client.user`, `destination.user`, `host.user`, `server.user`, `source.user`.
The `user` fields are expected to be nested at: `client.user`, `destination.user`, `host.user`, `server.user`, `source.user`, `user.changes`, `user.effective`, `user.target`.

Note also that the `user` fields may be used directly at the root of the events.

Expand All @@ -6600,14 +6604,39 @@ Note also that the `user` fields may be used directly at the root of the events.
// ===============================================================


| <<ecs-user,user.changes.*>>| beta:[ Reusing the user fields in this location is currently considered beta.]

Fields to describe the user relevant to the event.

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


| <<ecs-user,user.effective.*>>| beta:[ Reusing the user fields in this location is currently considered beta.]

Fields to describe the user relevant to the event.

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


| <<ecs-group,user.group.*>>
| User's group relevant to the event.

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


| <<ecs-user,user.target.*>>| beta:[ Reusing the user fields in this location is currently considered beta.]

Fields to describe the user relevant to the event.

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


|=====



include::usage/user.asciidoc[]

[[ecs-user_agent]]
=== User agent Fields

Expand Down
Loading