Server-Timing 中间件

Server-Timing 中间件在响应头中提供性能指标。

INFO

注意：在 Cloudflare Workers 上，计时器指标可能不准确， 因为 计时器仅显示上次 I/O 的时间。

导入

npm

import { Hono } from 'hono'
import {
  timing,
  setMetric,
  startTime,
  endTime,
  wrapTime,
} from 'hono/timing'
import type { TimingVariables } from 'hono/timing'

用法

// 指定变量类型以推断 `c.get('metric')`：
type Variables = TimingVariables

const app = new Hono<{ Variables: Variables }>()

// 将中间件添加到你的路由
app.use(timing());

app.get('/', async (c) => {

  // 添加自定义指标
  setMetric(c, 'region', 'europe-west3')

  // 添加带计时的自定义指标，必须是毫秒
  setMetric(c, 'custom', 23.8, 'My custom Metric')

  // 启动一个新计时器
  startTime(c, 'db');
  const data = await db.findMany(...);

  // 结束计时器
  endTime(c, 'db');

  // ...或者你也可以使用此函数包装一个 Promise：
  const data = await wrapTime(c, 'db', db.findMany(...));

  return c.json({ response: data });
});

条件启用

const app = new Hono()

app.use(
  '*',
  timing({
    // c: 请求的上下文
    enabled: (c) => c.req.method === 'POST',
  })
)

结果

选项

可选 total: boolean

显示总响应时间。默认为 true。

可选 enabled: boolean | (c: Context) => boolean

是否应将计时信息添加到头中。默认为 true。

可选 totalDescription: boolean

总响应时间的描述。默认为 Total Response Time。

可选 autoEnd: boolean

如果 startTime() 应在请求结束时自动结束。 如果禁用，未手动结束的计时器将不会显示。

可选 crossOrigin: boolean | string | (c: Context) => boolean | string

此计时头可被读取的源。

• 如果为 false，仅来自当前源。
• 如果为 true，来自所有源。
• 如果为字符串，来自此域名。多个域名必须用逗号分隔。

默认为 false。查看更多 文档。