如何按端点注册Firebase Functions v2以独立收集指标？

问题 #

我正在使用Express运行Firebase Functions v2，目前将所有路由挂载到单个api函数中，代码如下：

const expressApp = express()
setupRoutes(expressApp)

export const api = onRequest(expressApp)

setupRoutes会遍历路由文件处理各类端点（如/api/user、/api/sign-up、/api/clients/{id}/invoices等），但Firebase/GCP控制台仅显示api这一个函数。我需要将每个端点单独注册，让它们能在谷歌控制台中独立列出并收集指标。

解决方案 #

要让每个Express路由对应独立的Firebase Functions v2函数，需要放弃将所有路由挂载到单个Express应用导出的方式，改为为每个路由创建独立的onRequest函数并单独导出。具体步骤如下：

1. 重构路由定义：导出路由配置数组 #

将原来直接挂载到Express应用的路由逻辑，改为导出包含路径、HTTP方法、处理函数的配置数组。比如拆分路由模块：

// routes/user.js
import { getUserHandler, signUpHandler } from '../handlers/userHandlers.js';

export const userRoutes = [
  { path: '/api/user', method: 'get', handler: getUserHandler },
  { path: '/api/sign-up', method: 'post', handler: signUpHandler },
];

// routes/invoice.js
import { getClientInvoicesHandler } from '../handlers/invoiceHandlers.js';

export const invoiceRoutes = [
  { path: '/api/clients/{id}/invoices', method: 'get', handler: getClientInvoicesHandler },
];

2. 遍历路由配置，生成独立Firebase函数 #

在主函数文件中，汇总所有路由配置，遍历生成合法的函数名并导出每个onRequest函数：

import { onRequest } from 'firebase-functions/v2/https';
import express from 'express';
import { userRoutes } from './routes/user.js';
import { invoiceRoutes } from './routes/invoice.js';

// 汇总所有路由配置
const allRoutes = [...userRoutes, ...invoiceRoutes];

// 遍历生成独立函数
allRoutes.forEach(route => {
  // 将路径转换为合法的函数名：移除特殊字符，斜杠替换为下划线
  const functionName = route.path
    .replace(/^\/|\/$/g, '') // 移除首尾斜杠
    .replace(/\/{/g, '') // 移除/{
    .replace(/}/g, '') // 移除}
    .replace(/\//g, '_'); // 斜杠替换为下划线

  // 创建仅挂载当前路由的Express子应用
  const app = express();
  // 根据HTTP方法挂载路由
  app[route.method](route.path, route.handler);

  // 导出为独立的Firebase函数
  exports[functionName] = onRequest(app);
});

3. 关键注意事项 #

• 函数命名规则：GCP函数名只能包含字母、数字、下划线，且不能以数字开头，必须按规则转换路径名（比如/api/clients/{id}/invoices会被转为api_clients_id_invoices）。
• 动态路由处理：动态参数（如{id}）不会拆分出独立函数，所有匹配该路径的请求都会触发同一个函数，指标会统一收集到该函数下。若需要按参数细分指标，需在处理函数内部使用Cloud Monitoring客户端自定义指标。
• 控制台显示：部署后，Firebase/GCP控制台会列出所有导出的函数，每个函数对应一个路由，可独立查看请求数、延迟、错误率等指标。

内容的提问来源于stack exchange，提问作者guarinex