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

Document planned use cases #11

Open
steventhurgood opened this issue May 19, 2021 · 5 comments
Open

Document planned use cases #11

steventhurgood opened this issue May 19, 2021 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@steventhurgood
Copy link

What are the expected consumers for these SLO definitions? There should be a section in the introduction which gives a few examples, to give people a better understanding of why they would use this.

For example:

  • Auto-generating documentation
  • Auto-generating alerts and reports
  • Providing an agenda for SLO review meetings
  • etc.
@iredelmeier
Copy link

Agreed. I'm very interested to learn what the larger roadmap is.

As an end user, the spec alone feels like it provides sugar but doesn't yet solve my larger problems - and I imagine that everyone involved has many ideas on their mind!

@gplasky
Copy link

gplasky commented May 21, 2021

I would add something even more fundamental: To ensure that we* articulate SLOs in a consistent, understandable, and consumable format. Auto-generated dashboards / docs / etc. are second-order outcomes (but nevertheless still important :) ).

*we = companies / SREs / the broader community

@ian-bartholomew ian-bartholomew added the documentation Improvements or additions to documentation label Jun 17, 2021
@ian-bartholomew ian-bartholomew added this to the v1.0.0 milestone Jul 14, 2021
@pushpdeep
Copy link

Hi @ian-bartholomew I am thinking to add a use case.

@programmer04 programmer04 removed this from the v1.0.0 milestone Jun 28, 2022
@bobo
Copy link

bobo commented May 15, 2023

I'm aware this is a very old issue but still feels relevant. I want to add some more things that would be interesting to see if they are in/outside scope.

  • Non slo/sli alerts, not every alert is based on an slo.
  • Non slo/sli metrics, for example to generate dashboards.

Im myself very sceptical to if theese should be in scope. But i would also hate to have separate definitions of the "same" thing just because they are not slo/sli based. I dont want to add metrics to monitor some non slo value in one way, and another way to monitor my slo values.
But also, having openslo support creating non slo dashboards sounds weird.
Maybe someone has already given lots of thought into this? I think stating what's not in scope is just as important as what is in scope sometimes.

@fourstepper
Copy link
Contributor

@bobo my thoughts on this are currently to let these be defined by other specifications, for example PrometheusRule from the prometheus-operator project for alerts that aren't based on an SLO

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

8 participants