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

[Alerting] rename alert client getStatus API #75332

Closed
pmuellr opened this issue Aug 18, 2020 · 3 comments · Fixed by #76541
Closed

[Alerting] rename alert client getStatus API #75332

pmuellr opened this issue Aug 18, 2020 · 3 comments · Fixed by #76541
Assignees
Labels
Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@pmuellr
Copy link
Member

pmuellr commented Aug 18, 2020

In retrospect, I picked a really bad name for the new alert client API we added in this PR: #68437 - getAlertStatus. Primarily because we will be promoting/enhancing an overall alert "status" in the fix for this issue: #51099 . There is also an alert state, which is a different thing, and as such ... it would be better to come up with a new name for this.

I don't have a lot of suggestions, other than since the data returned from the current getAlertStatus() is based off events that occurred during some time range (and some default time range based on the alert interval is used), and that time range always end with "now", it should factor some concept of "time" in it.

Perhaps something like getRecentAlertSummary()?

Note that the peer HTTP API should also be similarly renamed.

@pmuellr pmuellr added Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Aug 18, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@mikecote mikecote self-assigned this Aug 31, 2020
@pmuellr
Copy link
Member Author

pmuellr commented Sep 1, 2020

As I'm working on the "general" alert status, I realized that "instance" should be part of the API name here, as it's specifically getting instance status.

It does a bit more though, like collecting all the errors over the time range, so somehow working "summary" in the name might work, or a name indicating that it's working off historic data vs the current state.

Something like getHistoricSummary() feels like it captures the intent, but also sounds kinda weird.

@mikecote
Copy link
Contributor

mikecote commented Sep 1, 2020

@pmuellr would any of the following sound better?

  • getEventLogSummary
  • getEventLogActivity
  • getSummaryByRange
  • getSummaryFromEventLog
  • getEventLogActivityByRange
  • getSummaryOfAlertByLookingAtHistoricalData 😄

@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants