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

feat(events): add basic event handler to collect application events #2602

Merged
merged 2 commits into from
Oct 16, 2023

Conversation

lsampras
Copy link
Member

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

  • Adding an events scaffolding to collect/export events from application
  • This involves adding a trait to accept events which will then be logged to stdout loki
  • This method would enforce the events schema while also enabling us to better search them on loki via labels

Additional Changes

  • This PR modifies the API contract
  • This PR modifies the database schema
  • This PR modifies application configuration/environment variables

Motivation and Context

  • Currently most of our analysis about the system happens via logs but apart from the different level of logs that we have setup, It would also benefit us from having a parallel set of logs that are more domain oriented
  • These set of logs would target top level events
  • We can store this in a separate stream in loki which would allow much efficient queries allowing one to search for events on a much longer range

How did you test it?

  • I tested it with stdout logs

Checklist

  • I formatted the code cargo +nightly fmt --all
  • I addressed lints thrown by cargo clippy
  • I reviewed the submitted code
  • I added unit tests for my changes where possible
  • I added a CHANGELOG entry if applicable

@lsampras lsampras self-assigned this Oct 16, 2023
@lsampras lsampras requested a review from a team as a code owner October 16, 2023 12:10
@lsampras lsampras added the A-framework Area: Framework label Oct 16, 2023
@lsampras lsampras added C-feature Category: Feature request or enhancement S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Oct 16, 2023
@lsampras lsampras added this pull request to the merge queue Oct 16, 2023
Merged via the queue into main with commit 5d88dbc Oct 16, 2023
9 of 10 checks passed
@lsampras lsampras deleted the add_events_scaffold branch October 16, 2023 12:57
@SanchithHegde SanchithHegde removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-framework Area: Framework C-feature Category: Feature request or enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants