vercel/dist/chunks/chunk-IFATV36R.js

The command-line interface for Vercel

import { createRequire as __createRequire } from 'node:module';
import { fileURLToPath as __fileURLToPath } from 'node:url';
import { dirname as __dirname_ } from 'node:path';
const require = __createRequire(import.meta.url);
const __filename = __fileURLToPath(import.meta.url);
const __dirname = __dirname_(__filename);
import {
  formatOption
} from "./chunk-4GQQJY5Y.js";
import {
  packageName
} from "./chunk-UGXBNJMO.js";

// src/commands/metrics/command.ts
var schemaSubcommand = {
  name: "schema",
  aliases: [],
  description: "List available metrics or inspect a specific metric.",
  arguments: [{ name: "metric-or-prefix", required: false }],
  options: [formatOption],
  examples: [
    {
      name: "List all metrics",
      value: `${packageName} metrics schema`
    },
    {
      name: "Show metric details",
      value: `${packageName} metrics schema vercel.function_invocation`
    },
    {
      name: "Schema as JSON for agents",
      value: `${packageName} metrics schema vercel.request.count --format=json`
    }
  ]
};
var metricsCommand = {
  name: "metrics",
  aliases: [],
  description: "Query observability metrics for your Vercel project or team.",
  arguments: [{ name: "metric-id", required: false }],
  subcommands: [
    // Hidden placeholder so the help synopsis renders [command] as optional
    // (help.ts treats `command` as required unless a subcommand has `default: true`)
    {
      name: "query",
      aliases: [],
      description: "",
      default: true,
      hidden: true,
      arguments: [],
      options: [],
      examples: []
    },
    schemaSubcommand
  ],
  options: [
    {
      name: "aggregation",
      shorthand: "a",
      type: String,
      deprecated: false,
      description: "Aggregation function (default: sum for counts/bytes/currency, avg for durations/memory/ratios)",
      argument: "FN"
    },
    {
      name: "group-by",
      shorthand: null,
      type: [String],
      deprecated: false,
      description: "Dimensions to group by (repeatable)",
      argument: "DIM"
    },
    {
      name: "limit",
      shorthand: null,
      type: Number,
      deprecated: false,
      description: "Max groups per time bucket (default: 10)",
      argument: "N"
    },
    {
      name: "filter",
      shorthand: "f",
      type: String,
      deprecated: false,
      description: "OData filter expression",
      argument: "EXPR"
    },
    {
      name: "since",
      shorthand: null,
      type: String,
      deprecated: false,
      description: "Start time: relative (1h, 30m, 2d) or ISO date (default: 1h)",
      argument: "TIME"
    },
    {
      name: "until",
      shorthand: null,
      type: String,
      deprecated: false,
      description: "End time (default: now)",
      argument: "TIME"
    },
    {
      name: "granularity",
      shorthand: "g",
      type: String,
      deprecated: false,
      description: "Time bucket size: 5m, 15m, 1h, 1d (default: auto)",
      argument: "SIZE"
    },
    {
      name: "project",
      shorthand: "p",
      type: String,
      deprecated: false,
      description: "Project name or ID (default: linked project)",
      argument: "NAME_OR_ID"
    },
    {
      name: "all",
      shorthand: null,
      type: Boolean,
      deprecated: false,
      description: "Query across all projects for the team"
    },
    formatOption
  ],
  examples: [
    {
      name: "5xx errors by error code in the last hour",
      value: `${packageName} metrics vercel.function_invocation.count -f "http_status ge 500" --group-by error_code --since 1h`
    },
    {
      name: "Function invocations by HTTP status code",
      value: `${packageName} metrics vercel.function_invocation.count --group-by http_status --since 6h`
    },
    {
      name: "Function duration by route",
      value: `${packageName} metrics vercel.function_invocation.request_duration_ms -a avg --group-by route --since 1h`
    },
    {
      name: "AI Gateway costs by provider",
      value: `${packageName} metrics vercel.ai_gateway_request.cost -a sum --group-by ai_provider --since 7d`
    },
    {
      name: "Core Web Vitals (LCP) by route",
      value: `${packageName} metrics vercel.speed_insights_metric.lcp -a p75 --group-by route --since 7d`
    },
    {
      name: "List available metrics",
      value: `${packageName} metrics schema`
    },
    {
      name: "Function executions matching a path pattern",
      value: `${packageName} metrics vercel.function_invocation.count -f "contains(request_path, '/api')" --group-by route --since 1h`
    },
    {
      name: "Show schema for a metric prefix",
      value: `${packageName} metrics schema vercel.request`
    },
    {
      name: "Team-wide function executions by project",
      value: `${packageName} metrics --all vercel.function_invocation.count --group-by project_id --since 24h`
    }
  ]
};

export {
  schemaSubcommand,
  metricsCommand
};