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] Should we use custom deprecated messages for removing .enabled config? #114190

Closed
chrisronline opened this issue Oct 6, 2021 · 7 comments
Assignees
Labels
estimate:small Small Estimated Level of Effort Feature:Actions Feature:Alerting Feature:EventLog Feature:Task Manager Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.16.0

Comments

@chrisronline
Copy link
Contributor

Relates to #114188

In #114188, the core team is advising plugin authors to ensure the default messaging around the .enabled deprecation is the best UX. If not, they are recommending to use custom messaging with examples of how to do that.

Plugin Should we?
Actions ?
Alerting ?
Stack alerts ?
Task manager ?
Event log ?
@chrisronline chrisronline added Feature:Alerting Feature:Task Manager Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:EventLog estimate:needs-research Estimated as too large and requires research to break down into workable issues labels Oct 6, 2021
@elasticmachine
Copy link
Contributor

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

@gmmorris gmmorris added estimate:small Small Estimated Level of Effort and removed estimate:needs-research Estimated as too large and requires research to break down into workable issues labels Oct 18, 2021
@pmuellr
Copy link
Member

pmuellr commented Oct 18, 2021

Wondering if we want to add some doc on the new enabled/disabled config going away, and how to tell users to perform equivalent functionality. For instance, using feature controls to make sure no one has access to the feature ...

We could leave the message as is, and customize it later if we find it's confusing users - by including a link to the docs, for instance.

@chrisronline
Copy link
Contributor Author

@pmuellr Which plugins have something like that to even mention in the docs? I know we added #111036 to give users a way to disable tasks from execution (which we felt was a replacement for disabling actions/alerting plugins directly)

@pmuellr
Copy link
Member

pmuellr commented Oct 21, 2021

I doubt any other plugins have anything like that in their doc, but alerting is special! :-)

I believe we did recently update a logged message to include a link to the doc, since it remediation wasn't something we'd really want in just an error message - can't remember what message that was though.

I was thinking of it more as a way to not have to bake details into the messages, but instead bake it into the doc, since it's probably a good thing to doc anyway (hmmm, didn't it just come up in an internal conversation? :-) )

@mikecote
Copy link
Contributor

I believe we did recently update a logged message to include a link to the doc, since it remediation wasn't something we'd really want in just an error message - can't remember what message that was though.

I was thinking of it more as a way to not have to bake details into the messages, but instead bake it into the doc, since it's probably a good thing to doc anyway (hmmm, didn't it just come up in an internal conversation? :-) )

This was the thread we had back in August around linking to documentation on the server side: #109741 (comment) 🙂 The limitation was around not knowing the documentation URL + version suffix. But the thread explored a way to work around it for now.

@ymao1 ymao1 self-assigned this Dec 1, 2021
@ymao1
Copy link
Contributor

ymao1 commented Dec 1, 2021

It looks like enabled is not part of the Alerting plugin config (and looking through the code history, has never been?) so setting xpack.alerting.enabled doesn't generate a deprecation message, just an error message due to invalid config.

@ymao1
Copy link
Contributor

ymao1 commented Dec 2, 2021

Closed with #120151

@ymao1 ymao1 closed this as completed Dec 2, 2021
@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
estimate:small Small Estimated Level of Effort Feature:Actions Feature:Alerting Feature:EventLog Feature:Task Manager Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.16.0
Projects
None yet
Development

No branches or pull requests

8 participants