ElasticWatchManager
in package
Orchestrates e-mail alerting over the ES integration.
Runs the pure checks EsMonitor::check() and, if after deduplication at least one issue
is due for sending (shouldAlert), sends one summary e-mail (not one per issue).
A plain class without a Doctrine entity (like FileSystemManager). It lives in the Api
layer, not Core, because it needs EmailManager (SendEmailTrait); Core does not know Api.
Called by the thin action ElasticPresenter::actionWatch().
Fail-open: an e-mail send error is only logged (channel elasticsearch); the monitor report is
returned anyway, so the cron never fails because of e-mail.
Table of Contents
Constants
- SETTINGS_GROUP : mixed = 1
- SETTINGS_KEY : mixed = 'email.address'
Properties
Methods
- __construct() : mixed
-
watch()
: array{issues: list
- buildAlertBody() : string
- safeHtml() : string
- `sendEmailFromText()` renders the body through the Latte `StringLoader` (`email.latte`, see `SendEmailTrait::setTemplate()`), so raw `{`/`}` (e.g. JSON in an ES error message wrapped in `$issue['message']`) would break template parsing. HTML-escape first, then hide the Latte-significant braces too.
- sendAlertEmail() : bool
Constants
SETTINGS_GROUP
private
mixed
SETTINGS_GROUP
= 1
SETTINGS_KEY
private
mixed
SETTINGS_KEY
= 'email.address'
Properties
$emailManager read-only
private
EmailManager
$emailManager
$esMonitor read-only
private
EsMonitor
$esMonitor
$settingContext read-only
private
SettingContext
$settingContext
Methods
__construct()
public
__construct(EsMonitor $esMonitor, EmailManager $emailManager, SettingContext $settingContext) : mixed
Parameters
- $esMonitor : EsMonitor
- $emailManager : EmailManager
- $settingContext : SettingContext
watch()
public
watch() : array{issues: list, data: array, emailSent: bool}
Return values
array{issues: listbuildAlertBody()
private
buildAlertBody(string $host, array<int, array{type: string, source: ?string, message: string, shouldAlert: bool}> $issues) : string
Parameters
- $host : string
- $issues : array<int, array{type: string, source: ?string, message: string, shouldAlert: bool}>
Return values
stringsafeHtml()
`sendEmailFromText()` renders the body through the Latte `StringLoader` (`email.latte`, see `SendEmailTrait::setTemplate()`), so raw `{`/`}` (e.g. JSON in an ES error message wrapped in `$issue['message']`) would break template parsing. HTML-escape first, then hide the Latte-significant braces too.
private
safeHtml(string $text) : string
Parameters
- $text : string
Return values
stringsendAlertEmail()
private
sendAlertEmail(array<int, array{type: string, source: ?string, message: string, shouldAlert: bool}> $issues) : bool
Parameters
- $issues : array<int, array{type: string, source: ?string, message: string, shouldAlert: bool}>