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

[Monitoring] Improved "Nodes changed" rule alert message #195699

Merged
merged 3 commits into from
Oct 11, 2024

Conversation

consulthys
Copy link
Contributor

@consulthys consulthys commented Oct 10, 2024

Closes #195533

Summary

This PR fixes the format of the message of the Stack Monitoring built-in "Nodes changed" alert to be less confusing.

The message now lists the added/removed/restarted nodes in a clearer fashion.

Instead of

Nodes changed alert is firing for cluster-name-xyz (abc123). The following Elasticsearch nodes have been added: removed: instance-0000000012 restarted.

The message now shows like

Nodes changed alert is firing for cluster-name-xyz (abc123). The following Elasticsearch nodes have been added: none / removed: instance-0000000012 / restarted: none

Checklist

@consulthys consulthys requested a review from a team as a code owner October 10, 2024 04:18
@consulthys consulthys self-assigned this Oct 10, 2024
@consulthys consulthys added Team:Monitoring Stack Monitoring team release_note:skip Skip the PR/issue when compiling release notes Feature:Stack Monitoring backport:skip This commit does not require backporting labels Oct 10, 2024
Copy link

@maramos-elastic maramos-elastic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
fallback value 'none' + updated message

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

cc @consulthys

@consulthys consulthys merged commit 819d80a into main Oct 11, 2024
20 checks passed
@consulthys consulthys deleted the fix-stack-monitoring-node-rule-message branch October 11, 2024 14:06
@consulthys consulthys added backport and removed backport:skip This commit does not require backporting labels Oct 16, 2024
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Oct 16, 2024
@consulthys consulthys removed the backport:skip This commit does not require backporting label Oct 16, 2024
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Oct 16, 2024
@consulthys consulthys added v8.15.3 v8.16.0 and removed backport:skip This commit does not require backporting v8.15.3 labels Oct 16, 2024
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Oct 17, 2024
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 195699 locally

@consulthys consulthys added backport:version Backport to applied version labels and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Oct 17, 2024
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.16

https://github.com/elastic/kibana/actions/runs/11379831385

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 17, 2024
)

Closes elastic#195533

## Summary

This PR fixes the format of the message of the Stack Monitoring built-in
"Nodes changed" alert to be less confusing.

The message now lists the added/removed/restarted nodes in a clearer
fashion.

Instead of
```
Nodes changed alert is firing for cluster-name-xyz (abc123). The following Elasticsearch nodes have been added: removed: instance-0000000012 restarted.
```
The message now shows like
```
Nodes changed alert is firing for cluster-name-xyz (abc123). The following Elasticsearch nodes have been added: none / removed: instance-0000000012 / restarted: none
```

### Checklist

- [X] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [X] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [X] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [X] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

(cherry picked from commit 819d80a)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.16

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Oct 18, 2024
@kibanamachine
Copy link
Contributor

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

@jbudz
Copy link
Member

jbudz commented Oct 18, 2024

@consulthys there's a version gap with this backport. Can you check if this should also be backported to 8.x/8.17?

@consulthys
Copy link
Contributor Author

@jbudz Sorry, my bad, 8.17 is totally fine

@consulthys consulthys removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Oct 20, 2024
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Oct 21, 2024
@kibanamachine
Copy link
Contributor

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

kibanamachine added a commit that referenced this pull request Oct 21, 2024
…sage (#195699) (#196630)

# Backport

This will backport the following commits from `main` to `8.16`:
- [[Monitoring] Improved "Nodes changed" rule alert message
(#195699)](#195699)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Valentin
Crettaz","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-11T14:06:45Z","message":"[Monitoring]
Improved \"Nodes changed\" rule alert message (#195699)\n\nCloses
https://github.com/elastic/kibana/issues/195533\r\n\r\n##
Summary\r\n\r\nThis PR fixes the format of the message of the Stack
Monitoring built-in\r\n\"Nodes changed\" alert to be less
confusing.\r\n\r\nThe message now lists the added/removed/restarted
nodes in a clearer\r\nfashion.\r\n\r\nInstead of\r\n```\r\nNodes changed
alert is firing for cluster-name-xyz (abc123). The following
Elasticsearch nodes have been added: removed: instance-0000000012
restarted.\r\n```\r\nThe message now shows like\r\n```\r\nNodes changed
alert is firing for cluster-name-xyz (abc123). The following
Elasticsearch nodes have been added: none / removed: instance-0000000012
/ restarted: none\r\n```\r\n\r\n### Checklist\r\n\r\n- [X] Any text
added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[X] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [X] This
renders correctly on smaller devices using a responsive\r\nlayout. (You
can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[X] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)","sha":"819d80a649dbcc6d7faf88f92b1f58039002ebe1","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["backport","Team:Monitoring","release_note:skip","Feature:Stack
Monitoring","v9.0.0","v8.16.0","backport:version"],"title":"[Monitoring]
Improved \"Nodes changed\" rule alert
message","number":195699,"url":"https://github.com/elastic/kibana/pull/195699","mergeCommit":{"message":"[Monitoring]
Improved \"Nodes changed\" rule alert message (#195699)\n\nCloses
https://github.com/elastic/kibana/issues/195533\r\n\r\n##
Summary\r\n\r\nThis PR fixes the format of the message of the Stack
Monitoring built-in\r\n\"Nodes changed\" alert to be less
confusing.\r\n\r\nThe message now lists the added/removed/restarted
nodes in a clearer\r\nfashion.\r\n\r\nInstead of\r\n```\r\nNodes changed
alert is firing for cluster-name-xyz (abc123). The following
Elasticsearch nodes have been added: removed: instance-0000000012
restarted.\r\n```\r\nThe message now shows like\r\n```\r\nNodes changed
alert is firing for cluster-name-xyz (abc123). The following
Elasticsearch nodes have been added: none / removed: instance-0000000012
/ restarted: none\r\n```\r\n\r\n### Checklist\r\n\r\n- [X] Any text
added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[X] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [X] This
renders correctly on smaller devices using a responsive\r\nlayout. (You
can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[X] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)","sha":"819d80a649dbcc6d7faf88f92b1f58039002ebe1"}},"sourceBranch":"main","suggestedTargetBranches":["8.16"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195699","number":195699,"mergeCommit":{"message":"[Monitoring]
Improved \"Nodes changed\" rule alert message (#195699)\n\nCloses
https://github.com/elastic/kibana/issues/195533\r\n\r\n##
Summary\r\n\r\nThis PR fixes the format of the message of the Stack
Monitoring built-in\r\n\"Nodes changed\" alert to be less
confusing.\r\n\r\nThe message now lists the added/removed/restarted
nodes in a clearer\r\nfashion.\r\n\r\nInstead of\r\n```\r\nNodes changed
alert is firing for cluster-name-xyz (abc123). The following
Elasticsearch nodes have been added: removed: instance-0000000012
restarted.\r\n```\r\nThe message now shows like\r\n```\r\nNodes changed
alert is firing for cluster-name-xyz (abc123). The following
Elasticsearch nodes have been added: none / removed: instance-0000000012
/ restarted: none\r\n```\r\n\r\n### Checklist\r\n\r\n- [X] Any text
added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[X] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [X] This
renders correctly on smaller devices using a responsive\r\nlayout. (You
can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[X] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)","sha":"819d80a649dbcc6d7faf88f92b1f58039002ebe1"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Valentin Crettaz <[email protected]>
@kibanamachine kibanamachine added v8.16.0 and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels backport Feature:Stack Monitoring release_note:skip Skip the PR/issue when compiling release notes Team:Monitoring Stack Monitoring team v8.16.0 v8.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Monitoring] Improve "Nodes changed" rule alert message
5 participants