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

Allow custom descriptions for self-nesting reuses #1174

Closed
ebeahan opened this issue Dec 7, 2020 · 1 comment · Fixed by #1366
Closed

Allow custom descriptions for self-nesting reuses #1174

ebeahan opened this issue Dec 7, 2020 · 1 comment · Fixed by #1366
Assignees
Labels
ready Issues we'd like to address in the future.

Comments

@ebeahan
Copy link
Member

ebeahan commented Dec 7, 2020

Self-nesting fieldsets, such as process.parent or user.effective, user.changes, user.target, reuse the top-level fieldset's short description field. The result is less accurate descriptions included alongside the fieldset names in the Field Reuse section in the ECS docs:

Screen Shot 2020-12-07 at 11 41 11 AM

An optional field could be added to the schema definition's reuse section to override the default use of the top-level fieldset's short description.

@webmat
Copy link
Contributor

webmat commented Dec 7, 2020

Thanks for capturing this!

I think also a third column might be useful to add here. The current "Nested fields" column assumes that the name of a field set doesn't change, when nesting. Essentially it captured which fields were being nested (pe), and where (process.pe). Since this can now be decoupled, I think something like this would clarify things a lot:

Nested fields Location Description
code_signature process.code_signature.* These fields contain information about binary code signatures.
hash process.hash.* Hashes, usually file hashes.
process process.parent.* Information about the parent process.
pe process.pe.* These fields contain Windows Portable Executable (PE) metadata.

And of course the "reuse description override" can optionally be used to clarify some of the less obvious field reuses, including those under a different name, as I demonstrate with process.parent above.

@ebeahan ebeahan added the ready Issues we'd like to address in the future. label Dec 15, 2020
@kgeller kgeller self-assigned this Apr 1, 2021
@ebeahan ebeahan mentioned this issue Apr 15, 2021
2 tasks
@kgeller kgeller linked a pull request May 3, 2021 that will close this issue
@kgeller kgeller closed this as completed May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready Issues we'd like to address in the future.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants