Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Changes related to merging RFC 0007 at stage 3 #1066

Merged
merged 18 commits into from
Dec 7, 2020
Merged
Show file tree
Hide file tree
Changes from 9 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
4 changes: 4 additions & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,15 @@ 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

#### Improvements

#### Deprecated

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

### Tooling and Artifact Changes

#### Breaking changes
Expand Down
28 changes: 27 additions & 1 deletion docs/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6441,6 +6441,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 @@ -6565,7 +6569,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 @@ -6583,14 +6587,36 @@ Note also that the `user` fields may be used directly at the root of the events.
// ===============================================================


| <<ecs-user,user.changes.*>>
| Fields to describe the user relevant to the event.

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


| <<ecs-user,user.effective.*>>
| Fields to describe the user relevant to the event.

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


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

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


| <<ecs-user,user.target.*>>
| Fields to describe the user relevant to the event.

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


|=====



include::usage/user.asciidoc[]

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

Expand Down
Loading