canonical / lego-base-k8s-operator

Base library for building Lego Kubernetes operators

https://charmhub.io/lego-base-k8s

Apache License 2.0

0 stars 3 forks source link

feat: add log forwarding support #62

Closed gruyaume closed 7 months ago

gruyaume commented 7 months ago

Description

We add Log Forwarding support so that any LEGO charm can be integrated with Loki and forward its log there. This means that all Lego charms will have to have the loki_push_api charm relation interface when using this new version of the lib.

Note

This is a breaking change. We haven't really dealt with minor/major version of this lib yet as we are the only team using it. This is something to consider here as this is a breaking change. It comes with a trade-off related to maintainability though (do we want to maintain multiple versions of this lib?). My personal opinion is to go on with v0 to make our life simpler but I can be easily convinced otherwise.

Checklist:

[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] I have made corresponding changes to the documentation
[ ] I have added tests that validate the behaviour of the software
[ ] I validated that new and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules
[ ] I Have bumped the version of the library

saltiyazan commented 7 months ago

The wording here makes it sound like without log forwarding this charm will not work. Is that the intention? Or is it just the metadata.yaml file of the LEGO charms we're talking about?

I think without adding the relation to metadata.yaml of a charm implementing this lib, the charm will crash when LogForwarder tries to observe events like relation joined.