From e47ba190148dc15c2b20980fb0a9c9ebd7a02f4d Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Fri, 10 Jan 2025 09:31:56 -0600 Subject: [PATCH] apply suggestions from code review Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> --- .../synthetics-uptime-tls-alert.asciidoc | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/en/observability/synthetics-uptime-tls-alert.asciidoc b/docs/en/observability/synthetics-uptime-tls-alert.asciidoc index 1d4cb7bc94..f05198cd64 100644 --- a/docs/en/observability/synthetics-uptime-tls-alert.asciidoc +++ b/docs/en/observability/synthetics-uptime-tls-alert.asciidoc @@ -42,8 +42,8 @@ The *Rule schedule* defines how often to evaluate the condition. You can also set *Advanced options* such as the number of consecutive runs that must meet the rule conditions before an alert occurs. -In this example, the conditions will be met when any of the TLS certificates on sites we’re monitoring -is expiring within 30 days or is older than 730 days. These conditions will be evaluated every 6 hours, +In this example, the conditions are met when any of the TLS certificates on sites we’re monitoring +is expiring within 30 days or is older than 730 days. These conditions are evaluated every 6 hours, and you will only receive an alert when the conditions are met three times consecutively. [role="screenshot"] @@ -102,15 +102,15 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to `context.labels`:: Labels associated with the monitor. `context.lastErrorMessage`:: Monitor last error message. `context.lastErrorStack`:: Monitor last error stack trace. -`context.locationId`:: Location id from which the check is performed. +`context.locationId`:: Location ID from which the check is performed. `context.locationName`:: Location name from which the check is performed. `context.locationNames`:: Location names from which the checks are performed. -`context.monitorType`:: Type (e.g. HTTP/TCP) of the monitor. +`context.monitorType`:: Type (for example, HTTP/TCP) of the monitor. `context.monitorUrl`:: URL of the monitor. -`context.reason`:: A concise description of the reason for the alert -`context.recoveryReason`:: A concise description of the reason for the recovery +`context.reason`:: A concise description of the reason for the alert. +`context.recoveryReason`:: A concise description of the reason for the recovery. `context.serviceName`:: Service name associated with the monitor. -`context.status`:: Monitor status (e.g "down"). +`context.status`:: Monitor status (for example, "down"). `context.viewInAppUrl`:: Open alert details and context in Synthetics app. [discrete] @@ -146,8 +146,8 @@ about certificates that are approaching expiration dates. that have been valid for too long. |=== -In this example, the conditions will be met when any of the TLS certificates on sites we’re monitoring -is expiring within 30 days or is older than 730 days. These conditions will be evaluated every 6 hours, +In this example, the conditions are met when any of the TLS certificates on sites we’re monitoring +is expiring within 30 days or is older than 730 days. These conditions are evaluated every 6 hours, and you will only receive an alert when the conditions are met three times consecutively. [role="screenshot"] @@ -207,7 +207,7 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to `context.agingCommonNameAndDate`:: The common names and expiration date/time of the detected certs. `context.agingCount`:: The number of detected certs that are becoming too old. -`context.alertDetailsUrl`:: Link to the alert troubleshooting view for further context and details. This will be an empty string if the server.publicBaseUrl is not configured. +`context.alertDetailsUrl`:: Link to the alert troubleshooting view for further context and details. This will be an empty string if the `server.publicBaseUrl` is not configured. `context.count`:: The number of certs detected by the alert executor. `context.currentTriggerStarted`:: Timestamp indicating when the current trigger state began, if alert is triggered. `context.expiringCommonNameAndDate`:: The common names and expiration date/time of the detected certs.