metricsServer

Start a metrics server on the pipe process. Required by Pipes UI and by anything that scrapes Prometheus (Grafana, Alertmanager, etc.).

import { metricsServer } from "@subsquid/pipes/metrics/node";
import { evmPortalStream } from "@subsquid/pipes/evm";

evmPortalStream({
  // ...
  metrics: metricsServer({ port: 9090 }),
  // ...
});

Parameters:

port: HTTP port for the server (default: 9090).

Endpoints

metricsServer() serves four HTTP endpoints on the configured port. They are all also useful for ad-hoc inspection with curl.

Path	Content
`/stats`	JSON — per-pipe progress, speed, portal query, SDK version. This is what Pipes UI polls.
`/metrics`	Prometheus text — built-in `sqd_*` series plus any custom metrics you registered. Scrape this from Prometheus.
`/profiler`	JSON — recent per-batch span trees. See Profiling. Empty when profiling is disabled.
`/health`	Responds with `ok`.

Custom metrics

Register counters, gauges, histograms, and summaries via ctx.metrics in whole-pipe transformers, targets, or when consuming the pipe as an async iterator. See the Metrics guide.

Overview

Pipes SDK

Squid SDK

Alternative clients

Endpoints

Custom metrics

See also

​Endpoints

​Custom metrics

​See also

Endpoints

Custom metrics

See also