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

Add the api value to event.category #2147

Merged
merged 4 commits into from
Feb 1, 2023
Merged

Conversation

calladoum-elastic
Copy link
Contributor

This Pull Request adds a new value for the event.category : api. Events in this category correspond to API events propagated directly from the Operating System from either the native API function (for instance, OS callbacks from Windows or Linux), system calls, or also managed source of events (such as ETW for instance).

Resolves #2138

@calladoum-elastic calladoum-elastic marked this pull request as ready for review January 24, 2023 19:43
@calladoum-elastic calladoum-elastic requested a review from a team as a code owner January 24, 2023 19:43
@@ -156,6 +156,19 @@
normalize:
- array
allowed_values:
- name: api
description: >
Events in this category correspond to API events propagated directly
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The event.category field values are designed to be fairly broad, and the term api encompasses a wide range: native, SOAP, RPC, Websocket, REST, etc.

I don't think we should limit its intended usage only to native/system API calls.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood, I'll rephrase

Events in this category correspond to API events propagated directly
from the Operating System (Windows, Linux, etc.), from either the native
API function or system call, or a managed source of events (such as ETW, syslog).
expected_event_types:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Narrowing down this list of expected event.type values is tough. I could see adding others, but it's also far easier to add others later than remove.

Maybe info for APIs that are purely returning information and not taking action or making a state change?

And perhaps also creation/change/deletion for the creating and removing of a resource by way of an API call?

Copy link
Member

@ebeahan ebeahan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ebeahan ebeahan merged commit 08237fe into main Feb 1, 2023
ebeahan pushed a commit to ebeahan/ecs that referenced this pull request Feb 1, 2023
* Adding `api` to `event.category`

* better phrasing for description, added a few extra expected types

(cherry picked from commit 08237fe)
@ebeahan
Copy link
Member

ebeahan commented Feb 1, 2023

💚 All backports created successfully

Status Branch Result
8.7

Questions ?

Please refer to the Backport tool documentation

ebeahan added a commit that referenced this pull request Feb 1, 2023
* Adding `api` to `event.category`

* better phrasing for description, added a few extra expected types

(cherry picked from commit 08237fe)

Co-authored-by: Christophe Alladoum <85187342+calladoum-elastic@users.noreply.github.com>
@calladoum-elastic calladoum-elastic deleted the calladoum/add-api-event-category branch February 2, 2023 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New value for event.category: api
2 participants