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

Refactor: Restructure event and rename context #4390

Merged

Conversation

yanivagman
Copy link
Collaborator

1. Explain what the PR does

This commit introduces two key changes to the Tracee event structure:

  • Renames the context field to workload to provide a more specific and clear description of the execution environment.
  • Moves the triggeredBy field from the data section to the root of the event structure. This ensures the data section is strictly defined by the event-specific schema, improving consistency and clarity.

These changes constitute a breaking change to the API. However, as traceectl is not yet merged, it is acceptable to introduce this breaking change now to avoid future complications.

2. Explain how to test it

3. Other comments

This commit introduces two key changes to the Tracee event structure:

- Renames the `context` field to `workload` to provide a more specific and
  clear description of the execution environment.
- Moves the `triggeredBy` field from the `data` section to the root of the
  event structure. This ensures the `data` section is strictly defined by the
  event-specific schema, improving consistency and clarity.

These changes constitute a breaking change to the API. However, as `traceectl`
is not yet merged, it is acceptable to introduce this breaking change now to
avoid future complications.
@yanivagman yanivagman added this to the v0.23.0 milestone Nov 21, 2024
@yanivagman yanivagman self-assigned this Nov 21, 2024
Copy link
Member

@geyslan geyslan left a comment

Choose a reason for hiding this comment

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

LGTM. @ShohamBit would you mind testing traceectl with this change?

@yanivagman yanivagman merged commit 0757020 into aquasecurity:main Nov 29, 2024
32 checks passed
@yanivagman yanivagman deleted the update_proto_event_structure branch November 29, 2024 06:21
@geyslan geyslan added candidate/v0.22.5 Candidate to be cherry-picked or backported into v0.22.5 release cherry-picked/v0.22.5 and removed candidate/v0.22.5 Candidate to be cherry-picked or backported into v0.22.5 release labels Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants