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

[DOCS] Observability Alerting - Enhancements to O11y Alerting doc #4609

Open
lucabelluccini opened this issue Nov 27, 2024 · 6 comments · May be fixed by #4709
Open

[DOCS] Observability Alerting - Enhancements to O11y Alerting doc #4609

lucabelluccini opened this issue Nov 27, 2024 · 6 comments · May be fixed by #4709
Assignees

Comments

@lucabelluccini
Copy link
Contributor

lucabelluccini commented Nov 27, 2024

List all available alerts with the "real" name in the Kibana

On the documentation page Create and Manage Rules under Observability, I would recommend to use the real names and categorization we have in the UI.

From:

Image

To:

Image

Or create sections, one for each app.

Remove or rework the Uptime deprecation message

(REMOVED)

Guidance on migrating from Uptime to Synthetics

In this section, I think we're mixing up SLI/SLO with Alerting. I do not know how we can make this visible. Maybe we should add a warning migration banner in all the Uptime sections to hint to the fact one is invited to move to Synthetics.

Prerequisites for APM - Anomaly rule

The APM - Anomaly rule requires Machine Learning. ML features require Platinum license.

Suggest the data being queried on each alert type

It would be handy to have an hint to which data stream / data view / index pattern each kind of rule uses.
E.g. for APM, one might think the user is allowed to use all the data from the traces-apm* data streams, while it's not true.
This might be covered in a separate issue and provide in-product hints about each alert.


FYI @paulb-elastic, @jasonrhodes
Not urgent, but it would be nice to address this in the future.

@paulb-elastic
Copy link
Contributor

Regarding deprecation, we do still identify Uptime as deprecated, as it will be removed at some point in the future (albeit not in v 9.0.0)

@lucabelluccini
Copy link
Contributor Author

I've updated the suggestions above

@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

@maryam-saeidi
Copy link
Member

cc @dedemorton Should we move this ticket to https://github.com/elastic/observability-docs repo?

@dedemorton
Copy link
Contributor

@maryam-saeidi Yes. I'll move it.

@dedemorton dedemorton transferred this issue from elastic/kibana Dec 2, 2024
@colleenmcginnis
Copy link
Contributor

In this section, I think we're mixing up SLI/SLO with Alerting.

That was intentional based on the conversation happening in the initial PR. If it's too confusing, we can remove content related to the SLI/SLO and just mention it instead.

My question (#4345):

I'm not sure if this section (preview) is what you had in mind. I'm not sure there's a 1:1 comparison for everything included in the Uptime rule unless I'm misunderstanding. For example, I don't think you can recreate the Uptime rule's availability condition exactly using the new Synthetics rule conditions (would you use an synthetics SLI instead?). Let me know if I'm missing something or if there's a different way we should approach this.

The answer I got from @shahzad31 (#4345 (comment)):

we don't allow know creating availability alert from status rules, it doesn't make sense as far as i can understand. if you want you can mention Synthetics Availability SLI indicator, that's more suited for that kind of scenerio, where user want to get alerted on availability. So user looking for availability alert can learn about Synthetics Availability SLI indicator.

@colleenmcginnis colleenmcginnis self-assigned this Dec 18, 2024
@colleenmcginnis colleenmcginnis linked a pull request Dec 18, 2024 that will close this issue
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants