Como usar
- Copie o comando e verifique o pacote antes de instalar no seu ambiente de agente.
- Consulte no original as ferramentas, credenciais e ambientes necessários.
- Descreva os dados de entrada e a entrega esperada; confira a saída com as fontes.
npx skills add https://github.com/vercel/vercel-plugin --skill custom-metricsAntes de começar
- A instalação não inclui assinatura de modelo, franquia API ou acesso aos seus arquivos.
- Estrelas e instalações indicam atividade, não um teste independente de qualidade ou segurança.
Renderizado do repositório de origem, preservando títulos, exemplos, código, tabelas, links e imagens.
Vercel Custom Metrics
Use Custom Metrics for numeric application and business measurements emitted by server-side code running in a Vercel Function. The workflow is emit a numeric sample with `metric()` → invoke the deployed function → discover and query the metric with `vc metrics` or Observability.
Add metrics proactively
Do not wait for the user to ask. When you create or meaningfully change server code that runs as a Vercel Function, add metric() calls in the same change if the code does work someone would want to watch in production:
- Business events: signups, orders, payments, checkouts, invites, subscriptions.
- Calls to slow or fallible dependencies: AI model calls, external APIs, databases, caches, queues. Record duration and outcome.
- Background work: webhooks, scheduled jobs, queue consumers, workflow steps. Record processed counts, failures, and batch sizes.
- AI features: token usage, model, latency, and tool-call outcomes.
Keep it small: usually one outcome counter and one duration per handler or dependency call, tagged with outcome and one or two other bounded attributes. Skip trivial handlers (health checks, static redirects, pure pass-through proxies), client components, and code that does not run in a Vercel Function.
metric() is safe to add by default once @vercel/functions is 3.9.0 or later; check the installed version and upgrade it in the same change if it is older. It is synchronous, does not need awaiting, and is a no-op when the runtime does not support Custom Metrics (for example local development or another host), so it does not break those environments.
Custom Metrics are available on Pro and Enterprise with Observability Plus, and each metric() call is billed as one Observability event ($1.20 per 1M). A function can call metric() at most 100 times per invocation. Emit once per logical operation, not inside tight loops or once per item of a large batch; record a batch total or size instead.
When you add metrics, say so in one line of your summary and list the metric names, so the user can find them with vc metrics schema or in Observability.
If the project already uses a third-party metrics SDK (Datadog, StatsD, Prometheus, OpenTelemetry metrics), do not remove it unasked. For new metrics in Vercel Functions, prefer metric() unless the user wants everything in the existing tool.
Emit a metric
Install or upgrade @vercel/functions, then import metric from its root entry point:
pnpm add @vercel/functionsimport { metric } from '@vercel/functions';
export async function POST() {
const startedAt = performance.now();
try {
await createOrder();
metric('orders.created', 1, { outcome: 'success' });
return Response.json({ ok: true });
} catch (error) {
metric('orders.created', 1, { outcome: 'error' });
throw error;
} finally {
metric('orders.duration_ms', performance.now() - startedAt);
}
}The signature is:
metric(name: string, value: number, tags?: Record<string, string>): voidnameidentifies one stable measurement, such asorders.createdororders.duration_ms.valueis the numeric sample. Emit1for an increment that will be summed; emit the observed value for a duration, size, or score.tagsare optional string attributes. After ingestion, discovered tag keys appear as dimensions for filtering and grouping.metric()is synchronous and returnsvoid; do notawaitit.- The helper is a no-op when the runtime does not expose Custom Metrics support. Verify instrumentation through a deployed Vercel Function invocation, not local execution alone.
Model metrics for useful queries
- Prefer stable, dotted names with a unit suffix where useful:
checkout.completed,checkout.duration_ms,queue.batch_size. - Do not use the reserved
vercel.prefix for application-defined names. - Keep variable data in tags instead of metric names. Use
checkout.completedwith{ plan: 'pro' }, notcheckout.completed.pro. - Keep tag cardinality bounded. Good tags are
outcome,plan,provider, or a normalized route. Do not attach user IDs, request IDs, email addresses, raw URLs, or other unique or sensitive values. - Emit one sample at the point where the outcome is known. For retryable or at-least-once work, decide whether attempts or successful logical operations are the intended measurement and name the metric accordingly.
Choose the query aggregation to match what was emitted:
| Measurement | Emit | Query |
|---|---|---|
| Occurrence or increment | metric('checkout.completed', 1) | sum or persecond |
| Duration or size | metric('checkout.duration_ms', duration) | avg, p75, p95, max |
| Sampled level | metric('queue.batch_size', size) | avg, min, max, percentiles |
Discover and query the metric
Run the deployed code at least once, then use the linked project and correct team scope:
vc metrics schema
vc metrics schema orders.duration_ms
vc metrics orders.created --aggregation sum --group-by outcome --since 24h
vc metrics orders.duration_ms --aggregation p95 --since 1h
vc metrics orders.duration_ms --aggregation p95 --group-by outcome --since 24h --jsonvc and vercel are equivalent. Use --aggregation; -a still works but is a deprecated shorthand. Use --json for machine-readable output (CLI 58.1+; older CLIs use --format=json). Always inspect the exact metric first with vc metrics schema <name> because the schema reports the available aggregations and discovered tag dimensions. Use -S <team> and -p <project> when the current link or scope is ambiguous; use --all only for a deliberate team-wide query.
Custom Metrics querying requires Observability Plus and availability for the selected team. If a metric is missing:
- Confirm the function was deployed to Vercel and the instrumented path actually ran.
- Confirm
@vercel/functionsis 3.9.0 or later, the first version that exportsmetric; upgrade it if necessary. - Check
vc whoami, the selected team, and the linked project. - Allow for ingestion delay, then rerun
vc metrics schema. - Confirm Observability Plus and Custom Metrics are enabled for the team.
Use the right signal
- Use Custom Metrics for numeric values you want to aggregate, trend, and filter.
- Use Web Analytics custom events for user interaction and conversion events in Web Analytics.
- Use OpenTelemetry spans for traces, operation timing, and request causality.
- Use logs for detailed diagnostic context and individual records.
Do not encode detailed event payloads into metric tags. Pair a low-cardinality metric with structured logs or traces when investigation needs per-request detail.