Skip to content

[8.19] [Response Ops][Reporting] Updating health API to return whether notification email service is available (#219785)#220555

Merged
ymao1 merged 1 commit intoelastic:8.19from
ymao1:backport/8.19/pr-219785
May 8, 2025
Merged

[8.19] [Response Ops][Reporting] Updating health API to return whether notification email service is available (#219785)#220555
ymao1 merged 1 commit intoelastic:8.19from
ymao1:backport/8.19/pr-219785

Conversation

@ymao1
Copy link
Contributor

@ymao1 ymao1 commented May 8, 2025

Backport

This will backport the following commits from main to 8.19:

Questions ?

Please refer to the Backport tool documentation

…ication email service is available (elastic#219785)

## Summary

Updates the internal reporting health API from
elastic#216857 to return whether the
notification email service is available. We'll be using this
notification email service to send the scheduled report notifications so
this lets us know if that service is available.

```
GET kbn:/internal/reporting/_health

Response
{
  "has_permanent_encryption_key": true,
  "is_sufficiently_secure": true,
  "are_notifications_enabled": true
}
```

## To Verify
1. Run kibana and ES with a preconfigured email connector in the
`kibana.yml` and the notification configured to use the connector

```
notifications.connectors.default.email: gmail
xpack.actions.preconfigured:
  gmail:
    name: 'email: my gmail'
    actionTypeId: '.email'
    config:
      <config>
    secrets:
      <secrets>
```
2. Access the health API, `are_notifications_enabled` should be `true`
3. Remove the config and restart Kibana
4. Access the health API, `are_notifications_enabled` should be `false`

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
(cherry picked from commit 25a873c)
@ymao1 ymao1 requested a review from kibanamachine as a code owner May 8, 2025 17:56
@ymao1 ymao1 added the backport This PR is a backport of another PR label May 8, 2025
@ymao1 ymao1 enabled auto-merge (squash) May 8, 2025 17:56
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

@ymao1 ymao1 merged commit 688ec6c into elastic:8.19 May 8, 2025
11 checks passed
@ymao1 ymao1 deleted the backport/8.19/pr-219785 branch May 8, 2025 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport This PR is a backport of another PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants