合成监控工具示例

本文档介绍了可帮助您创建合成监视器的模板和示例代码。示例函数可在 Google Cloud/synthetics-sdk-nodjs GitHub 代码库中找到。

如果您编写测试而不依赖模板，请确保您的测试通过，除非抛出 Error。我们建议 使用 Assert 库，以确保 如果发生故障，则会将其归因于正确的代码行。

警告：请务必先更新 url 字段的值，然后再部署示例代码。请勿将此字段设置为 https://www.google.com。

通用模板

通用模板已配置为收集 发送 HTTP 请求。该解决方案利用 OpenTelemetry auto-instrument-node 模块 和 winston 日志记录器。 由于依赖于开源产品，轨迹和日志数据的结构可能会发生变化。因此，收集的跟踪记录和 日志数据应仅用于调试目的。

注意 ：如需启用日志和跟踪记录收集功能，您的代码必须导入 instantiateAutoInstrumentation 软件包，并调用 instantiateAutoInstrumentation() 方法，然后再执行任何其他操作。 此外，请确保您的代码将 logger 指定为异步回调处理脚本。

您可以实现自己的方法来收集出站跟踪记录和日志数据 HTTP 请求。有关自定义方法的示例 请参阅 SyntheticAutoInstrumentation 类。

通用 Node.js 示例

generic-synthetic-nodejs 示例展示了如何查询网址。此示例包含与 Google Cloud 控制台中显示的默认函数相同的内容。如需查看完整示例，请点击 更多，然后选择在 GitHub 上查看。

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 示例

generic-synthetic-typescript 示例展示了如何查询网址。如需查看完整示例，请点击 更多，然后选择在 GitHub 上查看。

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 模板

如果您使用 Puppeteer，不妨考虑从 generic-puppeteer-nodejs 示例。

注意：分配的内存、CPU 和安全性默认设置可能不够用。我们建议将内存设置为至少 1GiB。

必需的 Puppeteer 设置

如需使用 Puppeteer，请务必完成以下步骤：

1. 在 Cloud Run 函数的源代码目录中添加 .puppeteerrc.cjs：

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

2. 将以下脚本添加到 package.json Cloud Run 函数：

   "scripts": {
        "gcp-build": "node node_modules/puppeteer/install.mjs"
   },
   

Puppeteer 示例

generic-puppeteer-nodejs 示例展示了如何将 Puppeteer 与 Cloud Run 函数搭配使用。如需查看完整示例，请点击 更多，然后选择在 GitHub 上查看。

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 模板

如果您使用 Selenium WebDriver，则不妨考虑从 generic-selenium-nodejs 示例。示例 可在 GitHub 上找到，其中包含 index.js 和 package.json 文件。

注意：分配的内存、CPU 和安全性默认设置可能不够用。我们建议将内存设置为至少 1GiB。

如需查看完整示例，请点击 更多，然后选择在 GitHub 上查看。

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 模板

如果您编写的测试依赖于 Mocha 模板，请考虑在发生失败时，一系列测试应继续还是停止。要在失败后停止一系列测试，您必须设置 bail 标志。

如需查看端到端示例，其中包括部署 API、Mocha 测试示例 以及如何配置合成监控工具，请参阅 博客 Google Cloud 合成监控教程。

mocha-url-ok 示例演示了 Cloud Run 函数如何调用 Mocha 测试套件，并提供了一个示例测试套件。如需查看完整示例，请点击 更多。 然后选择在 GitHub 上查看。

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;
});

损坏的链接模板

broken-links-ok 示例说明了如何配置损坏链接检查工具。 对于此模板，您只需指定 options 对象的值。此对象指定要测试的 URI 以及测试的参数。

如果您使用的是 Puppeteer，请务必完成 所需的 Puppeteer 设置步骤。

注意：分配的内存、CPU 和安全性默认设置可能不够用。我们建议将内存设置为 至少为 1GiB。

如需查看完整示例，请点击 更多，然后选择在 GitHub 上查看。

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

const options = {
  origin_uri: "https://example.com",
  // link_limit: 10,
  // query_selector_all: "a", // https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll
  // get_attributes: ['href'], // https://developer.mozilla.org/en-US/docs/Web/API/Element/getAttribute
  // link_order: "FIRST_N", // "FIRST_N" or "RANDOM"
  // link_timeout_millis: 30000, // timeout per link
  // max_retries: 0, // number of retries per link if it failed for any reason
  // wait_for_selector: '', // https://pptr.dev/api/puppeteer.page.waitforselector
  // per_link_options: {},
    /*
    // example:
      per_link_options: {
        'http://fake-link1': { expected_status_code: "STATUS_CLASS_4XX" },
        'http://fake-link2': { expected_status_code: 304 },
        'http://fake-link3': { link_timeout_millis: 10000 },
        'http://fake-link4': {
          expected_status_code: "STATUS_CLASS_3XX",
          link_timeout_millis: 10,
        },
      },
    */
  // total_synthetic_timeout_millis: 60000 // Timeout set for the entire Synthetic Monitor
  // screenshot_options: { capture_condition: 'FAILING', storage_location: '' }
};

functions.http('BrokenLinkChecker', GcmSynthetics.runBrokenLinksHandler(options));

后续步骤

• 创建合成监控
• 创建断开链接检查工具
• 管理合成监控工具
• 探索合成监控工具的结果