@google-cloud/synthetics-sdk-api

中文文档
0.7.0发布于 2025/06/11Apache-2.0TypeScriptCommonJS近 30 天下载 1.7万

与Google Cloud 监控合成器集成时必须遵守的 API 规格的节点JS 分布

中文使用文档
文档目录3 节
  1. 用云函数 V2
  2. 使用合成汉德勒中件
  3. 无框架的使用

npm version

合成 SDK API

注:这是正在积极开发的实验包. 新的发布可能包括突破变化.

安装

npm install --save @google-cloud/synthetics-sdk-api

用云函数 V2

Google Cloud 监控合成需要一个 Cloud 函数 v2 目标,因此,本指南解释了如何设置一个使用该函数的简单函数 @google-cloud/synthetics-sdk-api 软件包.

$ npm init
$ npm install --save @google-cloud/synthetics-sdk-api
$ npm install --save @google-cloud/functions-framework

# This example uses node-fetch for http requests
$ npm install --save node-fetch

使用合成汉德勒中件

这个软件包为Google Cloud Monitoring Synthetics所引用的写作代码提供了一种便于使用可快速兼容的中间软件. 当向它提供用户书面功能时,会发送可能被Google服务所消耗的回复. 以下是一个例子 index.js 可用作云函数入口的文件.

// index.js
const assert = require("node:assert");
const functions = require('@google-cloud/functions-framework');
const fetch = require("node-fetch");
const GcmSynthetics = require('@google-cloud/synthetics-sdk-api');

functions.http('SyntheticFunction', GcmSynthetics.runSyntheticHandler(async () => {
  const url = 'https://www.google.com/'; // URL to send the request to
  return await assert.doesNotReject(fetch(url));
}));

无框架的使用

只要Google Cloud函数暴露出符合Synthetics SDK API软件包所定义的API光谱的http端点,Cloud函数就会成为Synthetic Monitor的目标. 因此,本套件包括了包含api spec的原型定义,以及由该原型所生成的打字类型.

如果您想要运行一个程序工作流程, 而其他 SyntheticSDK 并不适合该工作流程, 或者您想要为您的 Google Cloud 函数使用另一种语言, 但没有直接支持的话, 这是非常重要的 .

const functions = require('@google-cloud/functions-framework');
const { SyntheticResult, GenericResultV1 } = require('@google-cloud/synthetics-sdk-api');

有用链接

版本与发布记录

@google-cloud/synthetics-sdk-api 共发布 10 个版本,首次发布于 2023/06/23;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.7.0latest2025/06/111.4 年前
0.6.02024/04/182 年前
0.5.12024/01/252 年前
0.5.02023/11/023 年前
0.4.12023/10/253 年前
0.4.02023/10/203 年前

关于 @google-cloud/synthetics-sdk-api 的常见问题

@google-cloud/synthetics-sdk-api 是什么?

与Google Cloud 监控合成器集成时必须遵守的 API 规格的节点JS 分布

如何安装 @google-cloud/synthetics-sdk-api?

在项目目录运行 npm install @google-cloud/synthetics-sdk-api,或使用 pnpm add / yarn add / bun add。

@google-cloud/synthetics-sdk-api 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@google-cloud/synthetics-sdk-api 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@google-cloud/synthetics-sdk-api 可以商用吗?

@google-cloud/synthetics-sdk-api 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@google-cloud/synthetics-sdk-api 的下载量有多少?

根据 npm 官方下载统计,@google-cloud/synthetics-sdk-api 在 2026/10/17 – 2026/11/15 这 30 天内被下载 16,593 次,日均约 553 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@google-cloud/synthetics-sdk-api 还在维护吗?

最新版本 0.7.0 发布于 2025/06/11(1.4 年前);至今共发布 10 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/06/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。