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

[Docs] Further explain user.id vs. user.name on main page #1503

Closed
a03nikki opened this issue Jul 6, 2021 · 1 comment
Closed

[Docs] Further explain user.id vs. user.name on main page #1503

a03nikki opened this issue Jul 6, 2021 · 1 comment
Assignees
Labels
DOCS Any issue related to ECS documentation documentation enhancement New feature or request ready Issues we'd like to address in the future.

Comments

@a03nikki
Copy link

a03nikki commented Jul 6, 2021

Summary

Users (aka human end users) of the ECS sometimes get confused between user.id and user.name.

Motivation:

Often in spoken American English the phrases "What is your user ID?" and "What is your user name?" are often used interchangeably in conversation. Then when reviewing the documentation for the User Fields it is not as clear as it could be. The new User Fields Usage and Examples helps but the initial page could use additional details.

Detailed Design:

Current (v1.10) version

Field Description Level
user.id Unique identifier of the user.
type: keyword
core
user.name Short name or login of the user.
type: keyword
Multi-fields:
* user.name.text (type: text)
example: albert
core

It brought confusion because albert is also the first name of Albert Einstein. Additionally there is no example of an user.id. The description of unique identifier could also mean a user.name as well because it uniquely identifies an individual within an organization too.

Clarification of the values and how they should be populated across data sources is important for large organizations who have multiple platforms (Windows, Linux, Public Cloud, Active Directory (AD), etc.) and are using the ECS for data standardization for security analytics (such as standardizing searches across platforms and user entity analytics).

An updated version of the documentation such as this may be helpful for them

Field Description Level
user.id Unique identifier of the user.
type: keyword
example: 1001 or S-1-5-21-202424912787-2692429404-2351956786-1000
core
user.name Short name or login of the user.
type: keyword
Multi-fields:
* user.name.text (type: text)
example: a.einstein
core
@a03nikki a03nikki added enhancement New feature or request documentation DOCS Any issue related to ECS documentation labels Jul 6, 2021
@ebeahan
Copy link
Member

ebeahan commented Jul 7, 2021

Thanks for the detailed issue, @a03nikki. This is great feedback, and we'll certainly use this context to improve the descriptions and examples.

I agree there can be confusion between user.name and user.id since both fields contain values that may act as identifiers. I do think having the example value for user.id will help.

@ebeahan ebeahan added the ready Issues we'd like to address in the future. label Jul 27, 2021
@kgeller kgeller closed this as completed Aug 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOCS Any issue related to ECS documentation documentation enhancement New feature or request ready Issues we'd like to address in the future.
Projects
None yet
Development

No branches or pull requests

3 participants