Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Beispiele für synthetische Monitore

Mit vorkonfigurierten Vorlagen und Beispielcode können Sie synthetische Monitore in Node.js und TypeScript mit Frameworks wie Puppeteer, Selenium WebDriver und Mocha erstellen. Mit diesen Beispielen, die im GitHub-Repository synthetics-sdk-nodejs verfügbar sind, können Sie URLs abfragen, browserbasierte User Journeys ausführen, API-Endpunkte testen oder nach defekten Links suchen.

Richtlinien für die Verwendung von Beispielen und das Schreiben benutzerdefinierter Tests

Bevor Sie ein Beispiel bereitstellen oder einen benutzerdefinierten Test schreiben, sollten Sie die folgenden Anforderungen beachten:

Ziel-URL aktualisieren: Bevor Sie Beispielcode bereitstellen, aktualisieren Sie das Feld url, damit es auf Ihren Zielendpunkt verweist. Setzen Sie dieses Feld nicht auf https://www.google.com.
Error bei fehlgeschlagenem Test auslösen: Wenn Sie benutzerdefinierte Tests schreiben, anstatt eine Vorlage zu verwenden, muss Ihr Test bestanden werden, es sei denn, es wird ein Error ausgelöst. Wir empfehlen, die Assert-Bibliothek zu verwenden, damit alle Fehler der richtigen Codezeile zugeordnet werden.

Allgemeine Vorlagen

Die generischen Vorlagen sind so konfiguriert, dass Trace- und Logdaten für ausgehende HTTP-Anfragen erfasst werden. Die Lösung nutzt das OpenTelemetry-Modul auto-instrumentation-node und den Winston-Logger. Da die Struktur von Trace- und Logdaten von Open-Source-Produkten abhängt, kann es hier zu Änderungen kommen. Die erhobenen Trace- und Protokolldaten sollten daher nur zur Fehlerbehebung verwendet werden.

Sie können Ihren eigenen Ansatz zum Erfassen von Trace- und Logdaten für ausgehende HTTP-Anfragen implementieren. Ein Beispiel für einen benutzerdefinierten Ansatz finden Sie in der Klasse SyntheticAutoInstrumentation.

Generisches Node.js-Beispiel

Im Beispiel generic-synthetic-nodejs wird gezeigt, wie eine URL abgefragt wird. Dieses Beispiel enthält denselben Code wie die Standardfunktion, die in der Google Cloud -Konsole angezeigt wird. Wenn Sie das vollständige Beispiel sehen möchten, wählen Sie in der Symbolleiste des Beispiels das GitHub-Logo aus.

const { instantiateAutoInstrumentation, runSyntheticHandler } = require('@google-cloud/synthetics-sdk-api');
// Run instantiateAutoInstrumentation before any other code runs, to get automatic logs and traces
instantiateAutoInstrumentation();
const functions = require('@google-cloud/functions-framework');
const axios = require('axios');
const assert = require('node:assert');

functions.http('SyntheticFunction', runSyntheticHandler(async ({logger, executionId}) => {
  /*
   * This function executes the synthetic code for testing purposes.
   * If the code runs without errors, the synthetic test is considered successful.
   * If an error is thrown during execution, the synthetic test is considered failed.
   */
  logger.info('Making an http request using synthetics, with execution id: ' + executionId);
  const url = 'https://www.google.com/'; // URL to send the request to
  return await assert.doesNotReject(axios.get(url));
}));

TypeScript-Beispiel

Im generic-synthetic-typescript-Beispiel wird gezeigt, wie eine URL abgefragt wird. Wenn Sie das vollständige Beispiel sehen möchten, wählen Sie in der Symbolleiste des Beispiels das GitHub-Logo aus.

import {runSyntheticHandler, instantiateAutoInstrumentation} from '@google-cloud/synthetics-sdk-api'
// Run instantiateAutoInstrumentation before any other code runs, to get automatic logs and traces
instantiateAutoInstrumentation();
import * as ff from '@google-cloud/functions-framework';
import axios from 'axios';
import assert from 'node:assert';
import {Logger} from 'winston';

ff.http('SyntheticFunction', runSyntheticHandler(async ({logger, executionId}: {logger: Logger, executionId: string|undefined}) => {
  /*
   * This function executes the synthetic code for testing purposes.
   * If the code runs without errors, the synthetic test is considered successful.
   * If an error is thrown during execution, the synthetic test is considered failed.
   */
  logger.info('Making an http request using synthetics, with execution id: ' + executionId);
  const url = 'https://www.google.com/'; // URL to send the request to
  return await assert.doesNotReject(axios.get(url));
}));

Puppeteer-Vorlage

Wenn Sie Puppeteer verwenden, sollten Sie mit dem generic-puppeteer-nodejs-Beispiel beginnen.

Erforderliche Puppeteer-Einrichtung

Führen Sie die folgenden Schritte aus, um Puppeteer zu verwenden:

Fügen Sie .puppeteerrc.cjs in das Quellverzeichnis Ihrer Cloud Run-Funktion ein:

const { join } = require('path');

/**
 * @type {import("puppeteer").Configuration}
 */
module.exports = {
  cacheDirectory: join(__dirname, '.cache', 'puppeteer'),
};

Fügen Sie der Datei package.json Ihrer Cloud Run Functions-Funktion das folgende Skript hinzu:
```
"scripts": {
     "gcp-build": "node node_modules/puppeteer/install.mjs"
},
```

Puppeteer-Beispiel

Im generic-puppeteer-nodejs-Beispiel wird veranschaulicht, wie Sie Puppeteer mit Ihrer Cloud Run-Funktion verwenden. Wenn Sie das vollständige Beispiel sehen möchten, wählen Sie in der Symbolleiste des Beispiels das GitHub-Logo aus.

const { instantiateAutoInstrumentation, runSyntheticHandler } = require('@google-cloud/synthetics-sdk-api');
// Run instantiateAutoInstrumentation before any other code runs, to get automatic logs and traces
instantiateAutoInstrumentation();
const functions = require('@google-cloud/functions-framework');
const axios = require('axios');
const assert = require('node:assert');
const puppeteer = require('puppeteer');


functions.http('CustomPuppeteerSynthetic', runSyntheticHandler(async ({logger, executionId}) => {
 /*
  * This function executes the synthetic code for testing purposes.
  * If the code runs without errors, the synthetic test is considered successful.
  * If an error is thrown during execution, the synthetic test is considered failed.
  */

 // Launch a headless Chrome browser and open a new page
 const browser = await puppeteer.launch({ headless: 'new', timeout: 0});
 const page = await browser.newPage();

 // Navigate to the target URL
 const result = await page.goto('https://www.example.com', {waitUntil: 'load'});

 // Confirm successful navigation
 await assert.equal(result.status(), 200);

 // Print the page title to the console
 const title = await page.title();
 logger.info(`My Page title: ${title} ` + executionId);

 // Close the browser
 await browser.close();
}));

Selenium WebDriver-Vorlage

Wenn Sie Selenium WebDriver verwenden, sollten Sie mit dem generic-selenium-nodejs-Beispiel beginnen. Das Beispiel, das auf GitHub verfügbar ist, enthält die Dateien index.js und package.json.

Wenn Sie das vollständige Beispiel sehen möchten, wählen Sie in der Symbolleiste des Beispiels das GitHub-Logo aus.

const {
  instantiateAutoInstrumentation,
  runSyntheticHandler,
} = require('@google-cloud/synthetics-sdk-api');
// Run instantiateAutoInstrumentation before any other code runs, to get automatic logs and traces
instantiateAutoInstrumentation();
const functions = require('@google-cloud/functions-framework');
const assert = require('node:assert');

const { Builder, Browser, By } = require('selenium-webdriver');
const chrome = require('selenium-webdriver/chrome');

/*
 * This function executes the synthetic code for testing purposes.
 * If the code runs without errors, the synthetic test is considered successful.
 * If an error is thrown during execution, the synthetic test is considered failed.
 */
functions.http(
  'CustomSeleniumSynthetic',
  runSyntheticHandler(async ({ logger, executionId }) => {
    /*
     * Construct chrome options
     * Note: `setChromeBinaryPath` must be set to '/srv/bin/chromium' when running in
     *   GCF (but will need to be changed if running on local machine).
     */
    const options = new chrome.Options();
    options.setChromeBinaryPath('/srv/bin/chromium');
    options.addArguments('--headless', '--disable-gpu', '--no-sandbox');

    // Launch headless chrome webdriver with options
    const driver = await new Builder()
      .forBrowser(Browser.CHROME)
      .setChromeOptions(options)
      .build();

    // Navigate to the target URL
    await driver.get('https://example.com');

    // Retrieve title and `a` tag of page
    const title = await driver.getTitle();
    const aTag = await driver.findElement(By.css('a')).getText();

    // assert title is as expected and print to console
    await assert.equal(title, 'Example Domain');
    logger.info(`My URL title is: ${title} ` + executionId);

    await driver.quit();
  })
);

Mocha-Vorlage

Wenn Sie Tests schreiben, die auf der Mocha-Vorlage basieren, sollten Sie überlegen, ob eine Testsequenz fortgesetzt oder beendet werden soll, wenn ein Fehler auftritt. Wenn Sie eine Testsequenz nach einem Fehler beenden möchten, müssen Sie das Flag bail festlegen.

Ein End-to-End-Beispiel, das die Bereitstellung einer API, das Schreiben einer Beispiel-Mocha-Testsuite für die API-Endpunkte und die Konfiguration des synthetischen Monitors umfasst, finden Sie im Blog Google Cloud Synthetic Monitoring Tutorial.

Das mocha-url-ok-Beispiel veranschaulicht, wie eine Cloud Run-Funktion eine Mocha-Test-Suite aufrufen kann. Außerdem wird eine Beispiel-Test-Suite bereitgestellt. Wenn Sie das vollständige Beispiel sehen möchten, wählen Sie in der Symbolleiste des Beispiels das GitHub-Logo aus.


const functions = require('@google-cloud/functions-framework');
const GcmSynthetics = require('@google-cloud/synthetics-sdk-mocha');

/*
 * This is the server template that is required to run a synthetic monitor in
 * Google Cloud Functions.
 */

functions.http('SyntheticMochaSuite', GcmSynthetics.runMochaHandler({
  spec: `${__dirname}/mocha_tests.spec.js`
}));


/*
 * This is the file may be interacted with to author mocha tests. To interact
 * with other GCP products or services, users should add dependencies to the
 * package.json file, and require those dependencies here A few examples:
 *  - @google-cloud/secret-manager:
 *        https://www.npmjs.com/package/@google-cloud/secret-manager
 *  - @google-cloud/spanner: https://www.npmjs.com/package/@google-cloud/spanner
 *  - Supertest: https://www.npmjs.com/package/supertest
 */

const {expect} = require('chai');
const fetch = require('node-fetch');

it('pings my website', async () => {
  const url = 'https://google.com/'; // URL to send the request to
  const externalRes = await fetch(url);
  expect(externalRes.ok).to.be.true;
});

Vorlage für fehlerhafte Links

Im broken-links-ok-Beispiel wird gezeigt, wie ein Tool zum Prüfen auf defekte Links konfiguriert wird. Für diese Vorlage geben Sie nur die Werte des options-Objekts an. Dieses Objekt gibt den zu testenden URI und die Parameter des Tests an.

Wenn Sie Puppeteer verwenden, müssen Sie die Schritte unter Erforderliche Puppeteer-Einrichtung ausführen.