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

[AO] Update context.alertDetailsUrl and context.viewInAppUrl description #158437

Closed
2 tasks done
maryam-saeidi opened this issue May 25, 2023 · 6 comments · Fixed by #159571
Closed
2 tasks done

[AO] Update context.alertDetailsUrl and context.viewInAppUrl description #158437

maryam-saeidi opened this issue May 25, 2023 · 6 comments · Fixed by #159571
Assignees
Labels
Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge" v8.9.0

Comments

@maryam-saeidi
Copy link
Member

maryam-saeidi commented May 25, 2023

📝 Summary

We need to revisit and update alertDetailsUrl and viewInAppUrl descriptions to make them more clear and consistent with the rest of the URL variables.

image

Also, at the moment, we don't have any value inalertDetailsUrl field if server.publicBaseUrl is not configured (similar to other URLs) If we want this behavior this way, we can include it in the message otherwise we can change the logic

  • Deciding about the description (@katrin-freihofner)
    • alertDetailsUrl description: "Link to the alert troubleshooting view for further context and details"
  • @katrin-freihofner Shall we use an empty string if server.publicBaseUrl is not configured?
    • Yes, that way the URL can at least be copied.

✅ Acceptance Criteria

@maryam-saeidi maryam-saeidi added Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge" v8.9.0 labels May 25, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/actionable-observability (Team: Actionable Observability)

@maryam-saeidi maryam-saeidi changed the title [AO] Update context.alertDetailsUrl description [AO] Update context.alertDetailsUrl and context.viewInAppUrl description May 25, 2023
@katrin-freihofner
Copy link
Contributor

Shall we use an empty string if server.publicBaseUrl is not configured?

Yes, that way the URL can at least be copied.

@katrin-freihofner
Copy link
Contributor

My proposal for the description:
"Link to the alert troubleshooting view for further context and details"

@maryam-saeidi
Copy link
Member Author

@katrin-freihofner Would you please also propose a description for context.viewInAppUrl?

@kdelemme
Copy link
Contributor

@katrin-freihofner can you check this please?

@katrin-freihofner
Copy link
Contributor

My proposals for the description for context.viewInAppUrl:
"Link to the analyzed data", "Link to the alert source"

@maryam-saeidi maryam-saeidi self-assigned this Jun 9, 2023
maryam-saeidi added a commit that referenced this issue Jun 14, 2023
…le types (#159571)

Closes #157284, closes #158437

## Summary

This PR updates the default action and recovery message for
observability rule types. Only uptime is excluded in this PR, I will add
that after synching with the synthetics team.


[Here](https://docs.google.com/spreadsheets/d/15cJanv0xi4EKo1QZVXsi_NcFcPa_VQze3nQc4P8GZrQ/edit?pli=1#gid=0)
you can find the list of default messages and the new proposals.

![image](https://github.com/elastic/kibana/assets/12370520/4f36e971-d8c2-47a9-ac25-9cae567db774)

## 🧪 How to test
- Ensure that `server.publicBaseUrl` is configured in kibana.dev.yml
- Create an observability rule with an action such as Email to use the
default messages (both for alert and recover states)
- After an alert is triggered, check the generated action message, it
should
   - match the message mentioned in the list
- contain an alert details link pointing to the Alerts page filtered for
that specific alert

---------

Co-authored-by: kibanamachine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge" v8.9.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants