[SLO] Add info on "SLO Overview" panel for custom dashboards #3331
Conversation
|
A documentation preview will be available soon: |
|
@colleenmcginnis LGTM! I have only one concern. I am currently working on a bug to hide the SLO Overview embeddable for users without proper license (it should be platinum and above). So I am wondering if we should backport the documentation to 8.11 or better postpone it for 8.12 with one additional information that the SLO Overview Panel will be available to users with |
I'd vote to remove the backport label on this PR and only add the docs to 8.12. We can add a link to the subscriptions page too—something similar to what we have in |
colleenmcginnis
added
backport-skip
| After you've created your SLO, you can monitor it from the _SLOs_ page in Observability, | ||
| but you can also add an _SLO Overview_ panel to a custom dashboard. | ||
| After you've created your SLO, you can monitor it from the _SLOs_ page in Observability. If you have | ||
| the {subscriptions}[appropriate license], you can also add an _SLO Overview_ panel to a custom dashboard. |
There was a problem hiding this comment.
Thanks! I like this wording as it ensures the subscriptions page remains the source of truth for the type of license that is needed.
colleenmcginnis
dismissed stale reviews from mgiota and bmorelli25
via
8b12534
| [IMPORTANT] | ||
| ==== | ||
| To create and manage SLOs, you need an {subscriptions}[appropriate license] and <<slo-privileges,SLO access>> must be configured. | ||
| ==== |
There was a problem hiding this comment.
@grabowskit confirmed that SLO access is limited to Platinum/Enterprise/Trial users so I added a note to the top of all pages that cover SLOs:
To create and manage SLOs, you need an appropriate license and SLO access must be configured.
There was a problem hiding this comment.
I'm not opposed to this approach, but this would be a new pattern that, AFAIK, we don't replicate elsewhere in the docs. If we move forward with adding a banner to the top of every SLO page because the feature requires an elevated license, we should consider doing the same for other features in Obs that have the same requirement. For example:
Closes #3269
Adds information on adding an SLO Overview panel to a custom dashboard. I wasn't sure where this should live, but decided on adding it to the end of the doc outlining how to create an SLO. I looked at the Kibana docs, but it doesn't look like we list all available panels anywhere over there (unless I missed it).
cc @grabowskit @emma-raffenne