Node.js-Bibliotheksfunktionen, die für alle Canarys gelten Node.js-Bibliotheksklassen und -funktionen, die nur für UI-Canaries gelten Klassen und Funktionen der Bibliothek Node.js, die nur für API Kanarienvögel gelten

Für Node.js-Canary-Skripte verfügbare Bibliotheksfunktionen

In diesem Abschnitt werden die Bibliotheksfunktionen aufgelistet, die für Canary-Skripts von Node.js verfügbar sind.

Themen

Node.js-Bibliotheksfunktionen, die für alle Canarys gelten
Node.js-Bibliotheksklassen und -funktionen, die nur für UI-Canaries gelten
Klassen und Funktionen der Bibliothek Node.js, die nur für API Kanarienvögel gelten

Node.js-Bibliotheksfunktionen, die für alle Canarys gelten

Die folgenden CloudWatch Synthetics-Bibliotheksfunktionen für Node.js sind für alle Kanarienvögel nützlich.

Synthetics-Klasse

Die folgenden Funktionen für alle Canarys befinden sich in der Klasse Synthetics.

addExecutionError(errorMessage, ex);

errorMessage beschreibt den Fehler und ex ist die aufgetretene Ausnahme

Sie können Folgendes verwenden:addExecutionError, um Ausführungsfehler für Ihren Canary festzulegen. Es lässt den Canary fehlschlagen, ohne die Skriptausführung zu unterbrechen. Es wirkt sich auch nicht auf Ihre successPercent-Metriken aus.

Sie sollten Fehler nur dann als Ausführungsfehler verfolgen, wenn sie nicht wichtig sind, um den Erfolg oder Misserfolg Ihres Canary-Skripts anzuzeigen.

Ein Beispiel für die Verwendung von addExecutionError ist das folgende. Sie überwachen die Verfügbarkeit Ihres Endpunkts und machen Screenshots, nachdem die Seite geladen wurde. Da der Fehler beim Erstellen eines Screenshots die Verfügbarkeit des Endpunkts nicht bestimmt, können Sie beim Erstellen von Screenshots aufgetretene Fehler abfangen und sie als Ausführungsfehler hinzufügen. Ihre Verfügbarkeitsmetriken zeigen weiterhin an, dass der Endpunkt aktiv ist und ausgeführt wird, aber Ihr Canary-Status wird als fehlgeschlagen markiert. Der folgende Codeblock fängt einen solchen Fehler ab und fügt ihn als Ausführungsfehler hinzu.


try {
        await synthetics.takeScreenshot(stepName, "loaded");
    } catch(ex) {
        synthetics.addExecutionError('Unable to take screenshot ', ex);
    }

getCanaryName();

Gibt den Namen des Canarys zurück.

getCanaryArn();

Gibt den Wert ARN des Kanarienvogels zurück.

getCanaryUserAgentString();

Gibt den benutzerdefinierten Benutzeragenten des Canary zurück.

getRuntimeVersion();

Diese Funktion ist in Laufzeitversion syn-nodejs-puppeteer-3.0 und höher verfügbar. Es gibt die Synthetics Laufzeitversion des Canarys zurück. Der Rückgabewert könnte beispielsweise syn-nodejs-puppeteer-3.0 sein.

getLogLevel();

Ruft die aktuelle Protokollebene für die Synthetics-Bibliothek ab. Folgende Werte sind möglich:

0 – Debug
1 – Info
2 – Warnen
3 – Fehler

Beispiel:


let logLevel = synthetics.getLogLevel();

setLogLevel();

Legt die Protokollebene für die Synthetics-Bibliothek fest. Folgende Werte sind möglich:

0 – Debug
1 – Info
2 – Warnen
3 – Fehler

Beispiel:


synthetics.setLogLevel(0);

SyntheticsConfiguration Klasse

Diese Klasse ist nur in der syn-nodejs-2.1-Laufzeitversion oder höher verfügbar.

Sie können die SyntheticsConfiguration Klasse verwenden, um das Verhalten von Synthetics-Bibliotheksfunktionen zu konfigurieren. Sie können diese Klasse beispielsweise verwenden, um die executeStep()-Funktion so zu konfigurieren, dass keine Screenshots erfasst werden.

Sie können CloudWatch Synthetics-Konfigurationen auf globaler Ebene festlegen, die auf alle Stufen der Kanaren angewendet werden. Sie können diese Konfigurationen auch auf Schrittebene überschreiben, indem Sie Konfigurationsschlüssel-Wert-Paare übergeben.

Sie können Optionen auf Schrittebene übergeben. Beispiele finden Sie unter asynchron executeStep (stepName, functionToExecute, [stepConfig]); und executeHttpStep(stepName,requestOptions, [Rückruf], []) stepConfig.

Funktionsdefinitionen:

setConfig(Optionen)

options ist ein Objekt, bei dem es sich um eine Reihe konfigurierbarer Optionen für Ihren Canary handelt. In den folgenden Abschnitten werden die möglichen Felder in options erläutert.

setConfig(Optionen) für alle Kanaren

Für Kanarienvögel, die eine neuere Version verwendensyn-nodejs-puppeteer-3.2, setConfigkönnen die (Optionen) für die folgenden Parameter enthalten:

includeRequestHeaders (boolean) – Gibt an, ob Anforderungs-Header in den Bericht aufgenommen werden sollen. Der Standardwert ist false.
includeResponseHeaders (boolean) – Gibt an, ob Antwort-Header in den Bericht aufgenommen werden sollen. Der Standardwert ist false.
restrictedHeaders (array) – Eine Liste von Header-Werten, die ignoriert werden sollen, wenn Header enthalten sind. Dies gilt sowohl für Anforderungs- als auch für Antwort-Header. Sie können Ihre Anmeldeinformationen beispielsweise verbergen, indem Sie includeRequestHeadersals true und restrictedHeadersals ['Authorization'] übergeben.
includeRequestBody (boolean) – Gibt an, ob der Anforderungstext in den Bericht aufgenommen werden soll. Der Standardwert ist false.
includeResponseBody (boolean) – Gibt an, ob der Antworttext in den Bericht aufgenommen werden soll. Der Standardwert ist false.

setConfig(Optionen) in Bezug auf CloudWatch Metriken

Für Kanarienvögel, die syn-nodejs-puppeteer-3.1 oder später verwenden, setConfigkönnen die (Optionen) für die folgenden booleschen Parameter enthalten, die bestimmen, welche Metriken vom Kanarienvogel veröffentlicht werden. Der Standardwert für jede dieser Optionen ist true. Die Optionen, die mit aggregated beginnen, bestimmen, ob die Metrik ohne die CanaryName-Dimension ausgegeben wird. Sie können diese Metriken verwenden, um die aggregierten Ergebnisse für alle Canarys anzuzeigen. Die anderen Optionen bestimmen, ob die Metrik mit der CanaryName Dimension ausgegeben wird. Sie können diese Metriken verwenden, um die Ergebnisse für jeden einzelnen Canary anzuzeigen.

Eine Liste der von Canaries ausgegebenen CloudWatch Messwerte finden Sie unter. CloudWatch von Canaries veröffentlichte Metriken

failedCanaryMetric (boolean) – Gibt an, ob die Failed-Metrik (mit der CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
failedRequestsMetric (boolean) – Gibt an, ob die Failed requests-Metrik (mit der CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
_2xxMetric (boolean) – Gibt an, ob die 2xx-Metrik (mit der CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
_4xxMetric (boolean) – Gibt an, ob die 4xx-Metrik (mit der CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
_5xxMetric (boolean) – Gibt an, ob die 5xx-Metrik (mit der CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
stepDurationMetric (boolean) – Gibt an, ob die Step duration-Metrik (mit der CanaryName-Dimension StepName) für diesen Canary emittiert werden soll. Der Standardwert ist true.
stepSuccessMetric (boolean) – Gibt an, ob die Step success-Metrik (mit der CanaryName-Dimension StepName) für diesen Canary emittiert werden soll. Der Standardwert ist true.
aggregatedFailedCanaryMetric (boolean) – Gibt an, ob die Failed-Metrik (ohne die CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
aggregatedFailedRequestsMetric (boolean) – Gibt an, ob die Failed Requests-Metrik (ohne die CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
aggregated2xxMetric (boolean) – Gibt an, ob die 2xx-Metrik (ohne die CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
aggregated4xxMetric (boolean) – Gibt an, ob die 4xx-Metrik (ohne die CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
aggregated5xxMetric (boolean) – Gibt an, ob die 5xx-Metrik (ohne die CanaryName-Dimension) für diesen Canary emittiert werden soll. Der Standardwert ist true.
visualMonitoringSuccessPercentMetric (boolean) – Gibt an, ob die visualMonitoringSuccessPercent-Metrik für diesen Canary emittiert werden soll. Der Standardwert ist true.
visualMonitoringTotalComparisonsMetric (boolean) – Gibt an, ob die visualMonitoringTotalComparisons-Metrik für diesen Canary emittiert werden soll. Der Standardwert ist false.
stepsReport (boolean) – Gibt an, ob eine Zusammenfassung der Schrittausführung gemeldet werden soll. Der Standardwert ist true.
includeUrlPassword(boolean) — Ob ein Passwort aufgenommen werden soll, das in der erscheint. URL Standardmäßig werden Passwörter, die in erscheinen, aus Protokollen und Berichten entfernt, um zu verhindern, dass vertrauliche Daten offengelegt URLs werden. Der Standardwert ist false.
restrictedUrlParameters(Array) — Eine Liste von URL Pfad- oder Abfrageparametern, die geschwärzt werden sollen. Dies gilt für das URLs Auftreten in Protokollen, Berichten und Fehlern. Bei dem Parameter wird die Groß-/Kleinschreibung nicht beachtet. Sie können ein Sternchen (*) als Wert angeben, um alle URL Pfad- und Abfrageparameterwerte zu unkenntlich zu machen. Der Standardwert ist ein leeres Array.
logRequest (boolean) – Gibt an, ob jede Anforderung in Canary-Protokollen protokolliert werden soll. Bei UI-Canarys protokolliert dies jede Anforderung, die vom Browser gesendet wird. Der Standardwert ist true.
logResponse (boolean) – Gibt an, ob jede Antwort in Canary-Protokollen protokolliert werden soll. Bei UI-Canarys protokolliert dies jede vom Browser empfangene Antwort. Der Standardwert ist true.
logRequestBody (boolean) – Gibt an, ob Anforderungstexte zusammen mit den Anforderungen in Canary- Protokollen protokolliert werden sollen. Diese Konfiguration gilt nur, wenn logRequest true ist. Der Standardwert ist false.
logResponseBody (boolean) – Gibt an, ob Antworttexte zusammen mit den Antworten in Canary-Logs protokolliert werden sollen. Diese Konfiguration gilt nur, wenn logResponse true ist. Der Standardwert ist false.
logRequestHeaders (boolean) – Gibt an, ob Anforderungsheader zusammen mit den Anforderungen in Canary-Protokollen protokolliert werden sollen. Diese Konfiguration gilt nur, wenn logRequest true ist. Der Standardwert ist false.

Beachten Sie, dass includeRequestHeaders Header in Artefakten aktiviert.
logResponseHeaders (boolean) – Gibt an, ob Antwortheader zusammen mit den Antworten in Canary-Protokollen protokolliert werden sollen. Diese Konfiguration gilt nur, wenn logResponse true ist. Der Standardwert ist false.

Beachten Sie, dass includeResponseHeaders Header in Artefakten aktiviert.

Anmerkung

Die Duration- und SuccessPercent-Metriken werden immer für jeden Canary ausgegeben, sowohl mit als auch ohne die CanaryName-Metrik

Methoden zum Aktivieren oder Deaktivieren von Metriken

disableAggregatedRequestMetriken ()

Verhindert, dass der Canary alle Anforderungsmesswerte ausgibt, die ohne CanaryName-Dimension ausgegeben werden.

disableRequestMetrics()

Deaktiviert alle Anforderungsmetriken, einschließlich aller Canary-Metriken und Metriken, die über alle Canarys aggregiert werden.

disableStepMetrics()

Deaktiviert alle Schrittmetriken, einschließlich Metriken für den Schritterfolg und für die Schrittdauer.

enableAggregatedRequestMetriken ()

Ermöglicht dem Canary, alle Anforderungsmesswerte auszugeben, die ohne CanaryName-Dimension ausgegeben werden.

enableRequestMetrics()

Aktiviert alle Anforderungsmetriken, einschließlich aller Canary-Metriken und Metriken, die über alle Canarys aggregiert werden.

enableStepMetrics()

Aktiviert alle Schrittmetriken, einschließlich Metriken für den Schritterfolg und für die Schrittdauer.

erhalte 2 xxMetric ()

Gibt zurück, ob der Canary eine 2xx-Metrik mit der CanaryName-Dimension ausgibt.

erhalte 4 () xxMetric

Gibt zurück, ob der Canary eine 4xx-Metrik mit der CanaryName-Dimension ausgibt.

erhalte 5 () xxMetric

Gibt zurück, ob der Canary eine 5xx-Metrik mit der CanaryName-Dimension ausgibt.

getAggregatedxxMetric(2)

Gibt zurück, ob der Canary eine 2xx-Metrik ohne Dimension ausgibt.

getAggregatedxxMetric(4)

Gibt zurück, ob der Canary eine 4xx-Metrik ohne Dimension ausgibt.

getAggregatedFailedCanaryMetric()

Gibt zurück, ob der Canary eine Failed-Metrik ohne Dimension ausgibt.

getAggregatedFailedRequestsMetric()

Gibt zurück, ob der Canary eine Failed requests-Metrik ohne Dimension ausgibt.

getAggregatedxxMetric(5)

Gibt zurück, ob der Canary eine 5xx-Metrik ohne Dimension ausgibt.

getFailedCanaryMetrisch ()

Gibt zurück, ob der Canary eine Failed-Metrik mit der CanaryName-Dimension ausgibt.

getFailedRequestsMetrisch ()

Gibt zurück, ob der Canary eine Failed requests-Metrik mit der CanaryName-Dimension ausgibt.

getStepDurationMetrisch ()

Gibt zurück, ob der Canary eine Duration-Metrik mit der CanaryName-Dimension für dieses Canary ausgibt.

getStepSuccessMetrisch ()

Gibt zurück, ob der Canary eine StepSuccess-Metrik mit der CanaryName-Dimension für dieses Canary ausgibt.

mit 2 xxMetric (_2) xxMetric

Akzeptiert ein boolesches Argument, das angibt, ob eine 2xx-Metrik mit der CanaryName-Dimension für diesen Canary emittiert werden soll.

mit 4 xxMetric (_4) xxMetric

Akzeptiert ein boolesches Argument, das angibt, ob eine 4xx-Metrik mit der CanaryName-Dimension für diesen Canary emittiert werden soll.

mit 5 (_5) xxMetric xxMetric

Akzeptiert ein boolesches Argument, das angibt, ob eine 5xx-Metrik mit der CanaryName-Dimension für diesen Canary emittiert werden soll.

withAggregated2 xxMetric (aggregiert 2) xxMetric

Akzeptiert ein boolesches Argument, das angibt, ob eine 2xx-Metrik mit keiner Dimension für diesen Canary emittiert werden soll.

withAggregated4 xxMetric (aggregiert 4) xxMetric

Akzeptiert ein boolesches Argument, das angibt, ob eine 4xx-Metrik mit keiner Dimension für diesen Canary emittiert werden soll.

withAggregated5 xxMetric (aggregiert 5) xxMetric

Akzeptiert ein boolesches Argument, das angibt, ob eine 5xx-Metrik mit keiner Dimension für diesen Canary emittiert werden soll.

withAggregatedFailedCanaryMetric(Metrisch) aggregatedFailedCanary

Akzeptiert ein boolesches Argument, das angibt, ob eine Failed-Metrik mit keiner Dimension für diesen Canary emittiert werden soll.

withAggregatedFailedRequestsMetric(aggregatedFailedRequestsMetrisch)

Akzeptiert ein boolesches Argument, das angibt, ob eine Failed requests-Metrik mit keiner Dimension für diesen Canary emittiert werden soll.

withFailedCanaryMetrisch (failedCanaryMetric)

Akzeptiert ein boolesches Argument, das angibt, ob eine Failed-Metrik mit der CanaryName-Dimension für diesen Canary emittiert werden soll.

withFailedRequestsMetrisch (failedRequestsMetric)

Akzeptiert ein boolesches Argument, das angibt, ob eine Failed requests-Metrik mit der CanaryName-Dimension für diesen Canary emittiert werden soll.

withStepDurationMetrisch (stepDurationMetric)

Akzeptiert ein boolesches Argument, das angibt, ob eine Duration-Metrik mit der CanaryName-Dimension für diesen Canary emittiert werden soll.

withStepSuccessMetrisch (stepSuccessMetric)

Akzeptiert ein boolesches Argument, das angibt, ob eine StepSuccess-Metrik mit der CanaryName-Dimension für diesen Canary emittiert werden soll.

Methoden zum Aktivieren oder Deaktivieren anderer Features

withHarFile()

Akzeptiert ein boolesches Argument, das angibt, ob eine HAR Datei für diesen Canary erstellt werden soll.

withStepsReport()

Akzeptiert ein boolesches Argument, das angibt, ob eine Zusammenfassung der Schrittausführung für diesen Canary gemeldet werden soll.

withIncludeUrlPasswort ()

Akzeptiert ein boolesches Argument, das angibt, ob Passwörter, die URLs in Protokollen und Berichten vorkommen, eingeschlossen werden sollen.

withRestrictedUrlParameter ()

Akzeptiert ein Array von URL Pfad- oder Abfrageparametern zum Redigieren. Dies gilt für das URLs Erscheinen in Protokollen, Berichten und Fehlern. Sie können ein Sternchen (*) als Wert angeben, um alle URL Pfad- und Abfrageparameterwerte zu schwärzen

withLogRequest()

Akzeptiert ein boolesches Argument, das angibt, ob jede Anforderung in den Protokollen des Canarys protokolliert werden soll.

withLogResponse()

Akzeptiert ein boolesches Argument, das angibt, ob jede Antwort in den Protokollen des Canarys protokolliert werden soll.

withLogRequestKörper ()

Akzeptiert ein boolesches Argument, das angibt, ob jeder Anforderungstext in den Protokollen des Canarys protokolliert werden soll.

withLogResponseKörper ()

Akzeptiert ein boolesches Argument, das angibt, ob jeder Antworttext in den Protokollen des Canarys protokolliert werden soll.

withLogRequestÜberschriften ()

Akzeptiert ein boolesches Argument, das angibt, ob jeder Anforderungs-Header in den Protokollen des Canarys protokolliert werden soll.

withLogResponseÜberschriften ()

Akzeptiert ein boolesches Argument, das angibt, ob jeder Antwort-Header in den Protokollen des Canarys protokolliert werden soll.

getHarFile()

Gibt zurück, ob der Canary eine HAR Datei erstellt.

getStepsReport()

Gibt zurück, ob der Canary eine Zusammenfassung der Schrittausführung meldet

getIncludeUrlPasswort ()

Gibt zurück, ob der Canary Passwörter enthält, die URLs in Protokollen und Berichten vorkommen.

getRestrictedUrlParameter ()

Gibt zurück, ob der Canary URL Pfad- oder Abfrageparameter redigiert.

getLogRequest()

Gibt zurück, ob der Canary jede Anforderung in den Canaryprotokollen protokolliert.

getLogResponse()

Gibt zurück, ob der Canary jede Antwort in den Canaryprotokollen protokolliert.

getLogRequestKörper ()

Gibt zurück, ob der Canary jeden Anforderungstext in den Canaryprotokollen protokolliert.

getLogResponseKörper ()

Gibt zurück, ob der Canary jeden Antworttext in den Canaryprotokollen protokolliert.

getLogRequestÜberschriften ()

Gibt zurück, ob der Canary jeden Anforderungsheader in den Protokollen des Canarys.

getLogResponseÜberschriften ()

Gibt zurück, ob der Canary alle Antwort-Header in den Canaryprotokollen protokolliert.

Funktionen für alle Canarys

withIncludeRequestHeaders(includeRequestHeaders)
withIncludeResponseHeaders(includeResponseHeaders)
withRestrictedHeaders(restrictedHeaders)
withIncludeRequestBody(includeRequestBody)
withIncludeResponseBody(includeResponseBody)
enableReportingOptions() — Aktiviert alle Berichtsoptionen-- includeRequestHeaders, includeResponseHeadersincludeRequestBody, und includeResponseBody,.
disableReportingOptions() — Deaktiviert alle Berichtsoptionen-- includeRequestHeaders, includeResponseHeadersincludeRequestBody, und includeResponseBody,.

setConfig(Optionen) für UI Canaries

setConfigKann für UI Canaries die folgenden booleschen Parameter enthalten:

continueOnStepFailure(boolean) — Ob mit der Ausführung des Canary-Skripts fortgefahren werden soll, nachdem ein Schritt fehlgeschlagen ist (dies bezieht sich auf die Funktion). executeStep Wenn Schritte fehlschlagen, wird der Canary-Lauf weiterhin als fehlgeschlagen markiert. Der Standardwert ist false.
harFile(boolean) — Ob eine Datei erstellt werden soll. HAR Der Standardwert ist True.
screenshotOnStepStart (boolean) – Gibt an, ob ein Screenshot erstellt werden soll, bevor ein Schritt gestartet wird.
screenshotOnStepSuccess (boolean) – Gibt an, ob nach einem erfolgreichen Schritt ein Screenshot erstellt werden soll.
screenshotOnStepFailure (boolean) - Ob ein Screenshot erstellt werden soll, nachdem ein Schritt fehlgeschlagen ist.

Methoden zum Aktivieren oder Deaktivieren von Screenshots

disableStepScreenshots()

Deaktiviert alle Screenshot-Optionen (screenshotOnStepStart, screenshotOnStep Erfolg und screenshotOnStep Fehler).

enableStepScreenshots()

Aktiviert alle Screenshot-Optionen (screenshotOnStepStart, screenshotOnStep Erfolg und screenshotOnStep Fehler). Standardmäßig sind alle diese Methoden aktiviert.

getScreenshotOnStepFailure()

Gibt zurück, ob der Canary einen Screenshot macht, nachdem ein Schritt fehlschlägt.

getScreenshotOnStepStart()

Gibt zurück, ob der Canary einen Screenshot erstellt, bevor er einen Schritt startet.

getScreenshotOnStepSuccess()

Gibt zurück, ob der Canary nach erfolgreichem Abschluss eines Schritts einen Screenshot erstellt.

withScreenshotOnStepStart(screenshotOnStepStart)

Akzeptiert ein boolesches Argument, das angibt, ob ein Screenshot erstellt werden soll, bevor ein Schritt gestartet wird.

withScreenshotOnStepSuccess(screenshotOnStepErfolg)

Akzeptiert ein boolesches Argument, das angibt, ob nach erfolgreichem Abschluss eines Schritts ein Screenshot erstellt werden soll.

withScreenshotOnStepFailure(screenshotOnStepMisserfolg)

Akzeptiert ein boolesches Argument, das angibt, ob nach einem Schritt ein Screenshot erstellt werden soll.

Verwendung in UI-Canarys

Importieren Sie zuerst die Synthetics-Abhängigkeit und holen Sie die Konfiguration ab.


// Import Synthetics dependency
const synthetics = require('Synthetics');

// Get Synthetics configuration
const synConfig = synthetics.getConfiguration();

Legen Sie dann die Konfiguration für jede Option fest, indem Sie die setConfig Methode mit einer der folgenden Optionen aufrufen.


// Set configuration values
    synConfig.setConfig({
        screenshotOnStepStart: true, 
        screenshotOnStepSuccess: false,
        screenshotOnStepFailure: false
    });

Oder


synConfig.withScreenshotOnStepStart(false).withScreenshotOnStepSuccess(true).withScreenshotOnStepFailure(true)

Um alle Screenshots zu deaktivieren, verwenden Sie die Funktion disableStepScreenshots () wie in diesem Beispiel.


synConfig.disableStepScreenshots();

Sie können Screenshots jederzeit im Code aktivieren oder deaktivieren. Wenn Sie beispielsweise Screenshots nur für einen Schritt deaktivieren möchten, deaktivieren Sie sie, bevor Sie diesen Schritt ausführen, und aktivieren Sie sie dann nach dem Schritt.

setConfig(Optionen) für API Kanarienvögel

APIKann für Kanarienvögel die folgenden booleschen Parameter enthalten: setConfig

continueOnHttpStepFailure(boolean) — Ob mit der Ausführung des Canary-Skripts fortgefahren werden soll, nachdem ein HTTP Schritt fehlgeschlagen ist (dies bezieht sich auf die Funktion). executeHttpStep Wenn Schritte fehlschlagen, wird der Canary-Lauf weiterhin als fehlgeschlagen markiert. Der Standardwert ist true.

Visuelle Überwachung

Die visuelle Überwachung vergleicht Screenshots, die während eines Canary-Laufs aufgenommen wurden, mit Screenshots, die während eines Baseline-Canary-Laufs aufgenommen wurden. Wenn die Diskrepanz zwischen den beiden Screenshots einen Schwellenwert überschreitet, schlägt der Canary fehl, und Sie können die Bereiche mit Unterschieden in der Farbe im Canarylauf-Bericht sehen. Die visuelle Überwachung wird auf Canaries unterstützt, auf denen syn-puppeteer-node-3.2 und höher ausgeführt wird. Es wird derzeit nicht in Canarys unterstützt, die Python und Selenium ausführen.

Um die visuelle Überwachung zu aktivieren, fügen Sie dem Canary-Skript die folgende Codezeile hinzu. Weitere Details finden Sie unter SyntheticsConfiguration Klasse.


syntheticsConfiguration.withVisualCompareWithBaseRun(true);

Wenn der Canary zum ersten Mal erfolgreich ausgeführt wird, nachdem diese Zeile zum Skript hinzugefügt wurde, verwendet er die während dieser Ausführung erstellten Screenshots als Vergleichsbasis. Nach dem ersten Canary-Run kannst du die CloudWatch Konsole verwenden, um den Canary zu bearbeiten, um einen der folgenden Schritte auszuführen:

Legen Sie den nächsten Lauf des Canarys als neue Basislinie fest.
Zeichnen Sie Grenzen auf dem aktuellen Baseline-Screenshot, um Bereiche des Screenshots festzulegen, die bei visuellen Vergleichen ignoriert werden sollen.
Entfernen Sie einen Screenshot, der für die visuelle Überwachung verwendet wird.

Weitere Informationen zur Verwendung der CloudWatch Konsole zum Bearbeiten eines Canary finden Sie unterEinen Canary bearbeiten oder löschen.

Weitere Optionen für die visuelle Überwachung

syntheticsConfiguration.withVisualVarianceThresholdPercentage(desiredPercentage)

Legen Sie den akzeptablen Prozentsatz für die Screenshot-Varianz in visuellen Vergleichen fest.

syntheticsConfiguration. withVisualVarianceHighlightHexColor(“ #fafa00 „)

Legen Sie die Hervorhebungsfarbe fest, die Varianzbereiche angibt, wenn Sie Canary-Lauf-Berichte betrachten, die visuelle Überwachung verwenden.

syntheticsConfiguration.withFailCanaryRunOnVisualVariance(failCanary)

Legen Sie fest, ob der Canary fehlschlägt, wenn ein visueller Unterschied größer als der Schwellenwert ist. Die Standardeinstellung ist, dass der Canary fehlschlägt.

Synthetics Logger

SyntheticsLogger schreibt Logs sowohl in die Konsole als auch in eine lokale Protokolldatei auf derselben Protokollebene. Diese Protokolldatei wird nur dann an beide Speicherorte geschrieben, wenn die Protokollebene auf oder unter der gewünschten Protokollierungsebene der aufgerufenen Protokollfunktion liegt.

Den Protokollanweisungen in der lokalen Protokolldatei werden "DEBUG: „,"INFO: „usw. vorangestellt, um der Protokollebene der aufgerufenen Funktion zu entsprechen.

Sie können das verwenden SyntheticsLogger, vorausgesetzt, Sie möchten die Synthetics Library auf derselben Protokollebene wie Ihr Synthetics Canary-Logging ausführen.

Die Verwendung von SyntheticsLogger ist nicht erforderlich, um eine Protokolldatei zu erstellen, die an Ihren S3-Ergebnisspeicherort hochgeladen wird. Sie können stattdessen eine andere Protokolldatei im /tmp-Ordner erstellen. Alle Dateien, die unter dem /tmp-Ordner erstellt wurden, werden als Artefakte an den Ergebnisspeicherort in S3 hochgeladen.

So verwenden Sie den Synthetics Library Logger:


const log = require('SyntheticsLogger');

Nützliche Funktionsdefinitionen:

log.debug (message, ex);