@ bydefault/ vercel( 默认/ vercel )

请求抓取 Vercel 和 Next.js proxy.ts 编号 : middleware.ts。 。 。 .

SDK只跟踪 GET 请求类似页面的路径。 飞行前型 请求,例如 HEAD, (中文(简体) ), POST,其他方法则被忽略.

默认, /api 财务报告和审定财务报表 /api/* 路线不包括在内,因此引用数反映 内容读取时不抓取 API 端点。 您可以自定义此选项 exclude。 。 。 .

安装

npm install @bydefault/vercel

Vercel 中间软件( 任何框架)

在韦尔塞尔, track 解决部署本身 waitUntil 从 请求上下文(Node.js 和 Edge 运行时间相同),因此,报告运行 在没有上下文参数的响应后接受:

import { Tracker } from '@bydefault/vercel'

const tracker = new Tracker({
  token: process.env.BYDEFAULT_INGEST_TOKEN,
})

export default function middleware(request: Request) {
  tracker.track(request)
}

工作作为 middleware.ts 任何框架的基础 Vercel,和作为下一位.js middleware.ts 编号 : proxy.ts (名称为导出) proxy 下册.

Next.js 代理.ts(自办)

在Vercel外没有请求上下文,所以手 track 框架的 使报告远离响应路径的事件 :

import { Tracker } from '@bydefault/vercel'
import { NextResponse, type NextFetchEvent, type NextRequest } from 'next/server'

const tracker = new Tracker({
  token: process.env.BYDEFAULT_INGEST_TOKEN,
})

export function proxy(request: NextRequest, event: NextFetchEvent) {
  tracker.track(request, event)
  return NextResponse.next()
}

不包括路线

const tracker = new Tracker({
  token: process.env.BYDEFAULT_INGEST_TOKEN,
  exclude: ['/api', '/admin', /^\/internal\//],
})

字符串排除了精确的路径名和后人,所以 '/api' 不包括 两者 /api 财务报告和审定财务报表 /api/ping。通过 exclude: [] 以禁用默认 /api 除外.

超时

每份报告默认为5秒。 报告紧接着 通过 waitUntil (或下一个) after())),保留了援引 活着,直到它解决, 所以一个束缚 是保持一个停滞的连接 持有一个函数打开直到平台杀死它. 报告错过了 捆绑掉下 表面穿过 onError;网站从未受到影响.

const tracker = new Tracker({
  token: process.env.BYDEFAULT_INGEST_TOKEN,
  timeoutMs: 2_000, // 0 disables the bound
})

地方发展

点 endpoint 在默认应用中:

const tracker = new Tracker({
  token: process.env.BYDEFAULT_INGEST_TOKEN,
  endpoint: 'http://localhost:3000',
})

有效载荷

SDK发送一个简单的请求信封:

type RequestPayload = {
  timestamp?: string
  method: string
  url: string
  ip?: string
  geo?: {
    country?: string
  }
  referer?: string
  userAgent?: string
  accept?: string
  acceptLanguage?: string
  requestId?: string
}

它不读请求正文,也不发送完整的请求头 设置。 SDK只发送字段 默认需要请求归属, 国家显示, 和 AI 提供者检测 。 没有精确的地点(区域, 城市,坐标)被传输;访问者IP被使用服务器侧到 对照操作员公布的 IP 验证声称的爬行者身份 区域并永远不存储.

如果没有配置任何符号,则禁用单个控制台跟踪 警告 警告他们 SDK从不从中间软件路径扔出,所以一个缺失或 错误配置的符号永远不会影响您的网站 .