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

Feature(schema): Enforce log structure #443

Open
EandrewJones opened this issue May 7, 2024 · 0 comments
Open

Feature(schema): Enforce log structure #443

EandrewJones opened this issue May 7, 2024 · 0 comments

Comments

@EandrewJones
Copy link
Contributor

Problem

Inconsistencies in the schema across versions and between logTypes (interval vs raw) can cause challenges for downstream development/interaction with the logs in both TAP and Distill.

Proposal

Maintain a versioned, default schema that we enforce for all standard log types. Pure custom logs would be the exception. This will guarantee the existence of a core set of key-value pairs in the logs for downstream consumers.

Options:

  • JSON schema enforced purely on the UserALE side
  • Protobuf/Avro schema that stands apart from the UserALE lib and/or can be shared across all Flagon projects (think Confluent's schema registry)

Risks

  • JSON schema is easier but doesn't provide the universal guarantees and type-checking of something like Protobuf/Avro.
  • Protobuf/Avro is likely more complicated to implement in a maintainable way across all Flagon repos. Need to research best options.
@EandrewJones EandrewJones changed the title Features: Enforce log schema Features(schema): Enforce log structure May 7, 2024
@EandrewJones EandrewJones changed the title Features(schema): Enforce log structure Feature(schema): Enforce log structure May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant