💡 [REQUEST] - Add a "Why?" section to `README.md`

google / slo-generator

SLO Generator computes SLIs, SLOs, Error Budgets and Burn Rates from supported backends, then exports an SLO report to supported targets.

Apache License 2.0

470 stars 74 forks source link

💡 [REQUEST] - Add a "Why?" section to `README.md` #375

Open lvaylet opened 8 months ago

lvaylet commented 8 months ago

Summary

Explain how, when and why the SLO Generator was developed in the first place.

Basic Example

Co-development with Adeo during a PSO engagement, as there was no simple solution to query multiple backends on top of Cloud Monitoring (Datadog, Splunk...).

Screenshots

![DESCRIPTION](LINK.png)

Drawbacks

None.

Unresolved questions

No response

Code of Conduct

[X] I agree to follow this project's Code of Conduct

lvaylet commented 1 month ago

Based on https://github.com/google/slo-generator/discussions/483, also add an architecture diagram of a sample deployment, even at a very high level.