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

[Rules and Alerting][Stack Monitoring] Shard size rule type returns wrong URL with context.internalFullMessage #191250

Closed
consulthys opened this issue Aug 26, 2024 · 0 comments · Fixed by #190341
Labels
bug Fixes for quality problems that affect the customer experience Feature:Stack Monitoring Team:Monitoring Stack Monitoring team

Comments

@consulthys
Copy link
Contributor

consulthys commented Aug 26, 2024

Kibana version:
8.12.2

Elasticsearch version:
8.12.2

Server OS version:
N/A

Browser version:
N/A

Browser OS version:
N/A

Original install method (e.g. download page, yum, from source, etc.):
N/A

Describe the bug:
When creating a Shard size alerting rule in Kibana using the action variable {{ context.internalFullMessage}} in the body of the message, the URL contains a wrong cluster_UUID when received in an email.

The generated URL looks like this and triggers a rison decoder error when clicking on it
https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:foobar))

The URL should look like this instead (with single quotes around the cluster UUID)
https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:'foobar'))

Steps to reproduce:

  1. Go to Stack Monitoring
  2. Create a new alert of type Shard size (with email connector) and configure it by making sure that the email body contains {{ context.internalFullMessage}}
  3. Upon receiving the alert email, click the link and witness the rison decoder error

Expected behavior:
The URL in the alert email body should work.

Related issues:
#86917

@consulthys consulthys added bug Fixes for quality problems that affect the customer experience Team:Monitoring Stack Monitoring team Feature:Stack Monitoring labels Aug 26, 2024
@elastic elastic deleted a comment Aug 26, 2024
@elastic elastic deleted a comment Aug 26, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Aug 27, 2024
…tate link sent via alerting rules (elastic#190341)

## Summary

Closes elastic#191250

This PR fixes the URL contained in the Shard size alerting rule when the
email body contains the `{{ context.internalFullMessage}}` action
variable.

The generated URL which triggers a `rison decoder error`

`https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:foobar))`

is fixed by adding a pair of single quotes around the cluster UUID

`https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:'foobar'))`

Worth noting that this issue doesn't only impact the Shard size rule,
but many other rule types, namely:
* CPU usage
* Disk usage
* Memory usage
* CCR read exception
* ES version mismatch
* Kibana version mismatch
* Logstash version mismatch
* Missing monitoring data
* Thread pool search rejections
* Thread pool write rejections

---------

Co-authored-by: Valentin Crettaz <valentin.crettaz@consulthys.com>
Co-authored-by: Valentin Crettaz <valentin.crettaz@elastic.co>
(cherry picked from commit 6ba4d74)
kibanamachine referenced this issue Aug 27, 2024
…lobal state link sent via alerting rules (#190341) (#191496)

# Backport

This will backport the following commits from `main` to `8.15`:
- [[Rules and Alerting][Stack Monitoring] Quote cluster uuid in global
state link sent via alerting rules
(#190341)](#190341)

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

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

<!--BACKPORT [{"author":{"name":"Dominique
Clarke","email":"dominique.clarke@elastic.co"},"sourceCommit":{"committedDate":"2024-08-27T12:50:48Z","message":"[Rules
and Alerting][Stack Monitoring] Quote cluster uuid in global state link
sent via alerting rules (#190341)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/191250\r\n\r\nThis PR fixes the
URL contained in the Shard size alerting rule when the\r\nemail body
contains the `` action\r\nvariable.\r\n\r\nThe generated URL which
triggers a `rison decoder
error`\r\n\r\n`https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:foobar))`\r\n\r\nis
fixed by adding a pair of single quotes around the cluster
UUID\r\n\r\n`https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:'foobar'))`\r\n\r\nWorth
noting that this issue doesn't only impact the Shard size rule,\r\nbut
many other rule types, namely:\r\n* CPU usage\r\n* Disk usage\r\n*
Memory usage\r\n* CCR read exception\r\n* ES version mismatch\r\n*
Kibana version mismatch\r\n* Logstash version mismatch\r\n* Missing
monitoring data\r\n* Thread pool search rejections\r\n* Thread pool
write rejections\r\n\r\n---------\r\n\r\nCo-authored-by: Valentin
Crettaz <valentin.crettaz@consulthys.com>\r\nCo-authored-by: Valentin
Crettaz
<valentin.crettaz@elastic.co>","sha":"6ba4d7440d34bbea11699fbe218a0020ff88a4f4","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["backport","release_note:fix","Feature:Stack
Monitoring","v8.15.0","v8.16.0","v8.15.1","backport:version"],"title":"[Rules
and Alerting][Stack Monitoring] Quote cluster uuid in global state link
sent via alerting
rules","number":190341,"url":"https://github.com/elastic/kibana/pull/190341","mergeCommit":{"message":"[Rules
and Alerting][Stack Monitoring] Quote cluster uuid in global state link
sent via alerting rules (#190341)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/191250\r\n\r\nThis PR fixes the
URL contained in the Shard size alerting rule when the\r\nemail body
contains the `` action\r\nvariable.\r\n\r\nThe generated URL which
triggers a `rison decoder
error`\r\n\r\n`https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:foobar))`\r\n\r\nis
fixed by adding a pair of single quotes around the cluster
UUID\r\n\r\n`https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:'foobar'))`\r\n\r\nWorth
noting that this issue doesn't only impact the Shard size rule,\r\nbut
many other rule types, namely:\r\n* CPU usage\r\n* Disk usage\r\n*
Memory usage\r\n* CCR read exception\r\n* ES version mismatch\r\n*
Kibana version mismatch\r\n* Logstash version mismatch\r\n* Missing
monitoring data\r\n* Thread pool search rejections\r\n* Thread pool
write rejections\r\n\r\n---------\r\n\r\nCo-authored-by: Valentin
Crettaz <valentin.crettaz@consulthys.com>\r\nCo-authored-by: Valentin
Crettaz
<valentin.crettaz@elastic.co>","sha":"6ba4d7440d34bbea11699fbe218a0020ff88a4f4"}},"sourceBranch":"main","suggestedTargetBranches":["8.15"],"targetPullRequestStates":[{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/190341","number":190341,"mergeCommit":{"message":"[Rules
and Alerting][Stack Monitoring] Quote cluster uuid in global state link
sent via alerting rules (#190341)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/191250\r\n\r\nThis PR fixes the
URL contained in the Shard size alerting rule when the\r\nemail body
contains the `` action\r\nvariable.\r\n\r\nThe generated URL which
triggers a `rison decoder
error`\r\n\r\n`https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:foobar))`\r\n\r\nis
fixed by adding a pair of single quotes around the cluster
UUID\r\n\r\n`https://<host>/app/monitoring#/elasticsearch/indices/<index>?_g=(cluster_uuid:'foobar'))`\r\n\r\nWorth
noting that this issue doesn't only impact the Shard size rule,\r\nbut
many other rule types, namely:\r\n* CPU usage\r\n* Disk usage\r\n*
Memory usage\r\n* CCR read exception\r\n* ES version mismatch\r\n*
Kibana version mismatch\r\n* Logstash version mismatch\r\n* Missing
monitoring data\r\n* Thread pool search rejections\r\n* Thread pool
write rejections\r\n\r\n---------\r\n\r\nCo-authored-by: Valentin
Crettaz <valentin.crettaz@consulthys.com>\r\nCo-authored-by: Valentin
Crettaz
<valentin.crettaz@elastic.co>","sha":"6ba4d7440d34bbea11699fbe218a0020ff88a4f4"}}]}]
BACKPORT-->

Co-authored-by: Dominique Clarke <dominique.clarke@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Feature:Stack Monitoring Team:Monitoring Stack Monitoring team
Projects
None yet
3 participants
@consulthys and others