sitespeed.io plugin for Elasticsearch

Send metrics from sitespeed.io to Elasticsearch. Captures browsertime, lighthouse, coach, and other summary data as flattened numeric documents via the bulk API.

You need sitespeed.io 39.0 or later.

Install

npm install sitespeed-plugin-elasticsearch -g

Run

sitespeed.io --plugins.add sitespeed-plugin-elasticsearch \
  --elasticsearch.host https://localhost:9200 \
  --elasticsearch.apiKey YOUR_API_KEY \
  https://www.example.com

Configuration

--elasticsearch.host       Elasticsearch URL (required)
--elasticsearch.apiKey     API key for authentication
--elasticsearch.username   Basic auth username
--elasticsearch.password   Basic auth password
--elasticsearch.index      Index name pattern (default: "sitespeed")
--elasticsearch.bulkSize   Documents buffered before bulk flush (default: 200)

Use {origin} in the index pattern for per-type indices:

--elasticsearch.index "sitespeed-{origin}"

This creates separate indices like sitespeed-browsertime, sitespeed-lighthouse, etc.

What data is sent

The plugin listens for pageSummary and summary messages and flattens all numeric values into dot-path keys. A browsertime document looks roughly like:

{
  "@timestamp": "2025-01-15T10:00:00.000Z",
  "origin": "browsertime",
  "summary_type": "pageSummary",
  "url": "https://www.example.com/",
  "group": "example.com",
  "statistics.timings.firstPaint.median": 320,
  "statistics.timings.fullyLoaded.median": 1850
}

Development

pnpm install
pnpm test

Test against a real sitespeed.io run:

pnpm build
npx sitespeed.io -n 1 --plugins.add ./dist/index.js \
  --elasticsearch.host https://localhost:9200 \
  https://www.example.com