Turn SigNoz into a universal embedded business dashboard — drop any live dashboard into your product, portal, or big screen with a single iframe.

Your metrics already live in SigNoz. Your users — customers checking service health, ops watching a NOC wall, teammates reading a weekly report — don't. This project bridges that gap: it serves every SigNoz dashboard as a portable, read-only, live widget that renders anywhere an iframe can go. No login page, no SigNoz account for viewers, no frontend to build — just a URL.

• Customer-facing status & SLA pages — show live health, latency, and usage on your support portal without giving customers console access.
• In-product analytics — put real operational charts inside your admin panel, SaaS settings page, or partner portal.
• Ops & NOC walls — kiosk-ready chrome toggles (title/toolbar/fullscreen) turn any dashboard into a big-screen view.
• Reports & reviews — time, variables, and refresh all live in the URL, so every shared link reproduces the exact same view.

• One-line embed: GET /embed/:dashboardId?... renders toolbar + dashboard grid. Callers just build the URL.
• Always live, never stale: data streams from your SigNoz backend on every load and refresh interval — no exports, no screenshots, no scheduled sync jobs.
• Read-only by design: no edit/clone/delete/settings/lock/alerts UI; dashboard writes and all non-allowlisted APIs return 403. Safe to put in front of strangers.
• Key flexibility: effective key = x-embed-api-key header (from the URL apiKey, kept in memory only) ?? env.SIGNOZ_API_KEY. A missing key renders a friendly 401 empty state, never a stack trace.
• URL-driven view: time, theme, color mode, locale, refresh, variables, toolbar/title/fullscreen all come from query params and sync back via history.replaceState — every view is a shareable link.
• Two themes: shadcn (default, tailwind + Recharts) and legacy (antd + echarts), switched with ?theme=. Unknown values fall back to shadcn.
• Public iframe: CSP frame-ancestors * and CORS * are intentional — anyone with the link can view.
• Observable: GET /healthz, GET /metrics (prom-client), JSON logs that record only the key source and an 8-char key hash, never the plaintext key.

• Node >=20, pnpm@9.
• A running SigNoz v0.97.0 backend and an API key with dashboard view permission.

pnpm install

# dev (run both; web on :5173 proxies /api/signoz to :8080):
SIGNOZ_BASE_URL=http://<signoz-host>:30303 SIGNOZ_API_KEY=<key> pnpm dev:api
pnpm dev:web

Production:

pnpm build   # builds all packages + syncs apps/web/dist -> apps/api/web-dist
SIGNOZ_BASE_URL=http://<signoz-host>:30303 SIGNOZ_API_KEY=<key> node apps/api/dist/main.js
# health: GET /healthz | metrics: GET /metrics

Docker (single image):

SIGNOZ_BASE_URL=http://<signoz-host>:30303 SIGNOZ_API_KEY=<key> docker compose up --build
# serves on :8080

Published image (the docker-publish workflow builds linux/amd64 + linux/arm64 and pushes to taosherio/signoz-open-dashboard on v* tags and manual runs; set the DOCKERHUB_TOKEN repository secret once):

docker run -p 8080:8080 \
  -e SIGNOZ_BASE_URL=http://<signoz-host>:30303 \
  -e SIGNOZ_API_KEY=<key> \
  taosherio/signoz-open-dashboard:latest

Connectivity probe (against SigNoz directly):

curl -H "SIGNOZ-API-KEY: <key>" \
  http://<signoz-host>:30303/api/v1/dashboards/<dashboardId>

Then you can embed the dashboard into a third-party website with a single iframe:

<iframe
  src="https://embed.example.com/embed/<dashboardId>?apiKey=<key>&relativeTime=30m&theme=shadcn&mode=light"
  style="width:100%;border:0"
  allowfullscreen>
</iframe>

Base: {EMBED_ORIGIN}/embed/:dashboardId. dashboardId is a SigNoz UUID; an invalid format short-circuits to a 404 empty state without calling upstream.

Auto-resize: the child ships @iframe-resizer/child. Parent pages may optionally load @iframe-resizer/parent@5; without it the embed falls back to internal scroll.

ALL /api/signoz/* → strip prefix → SIGNOZ_BASE_URL + path + query, preserving method/body/streaming, injecting SIGNOZ-API-KEY, stripping inbound authorization/cookie, and appending x-embed-request-id.

Timeouts: 30s for query_range, 10s for dashboard meta; the frontend cancels via AbortSignal. Global throttle ≈ 120 req/min/IP.

Error codes (packages/shared/errors.ts): EMBED_MISSING_API_KEY (401), EMBED_INVALID_API_KEY (401), EMBED_DASHBOARD_NOT_FOUND (404), EMBED_UPSTREAM_UNAVAILABLE (502), EMBED_READONLY / EMBED_BLOCKED (403) — each maps to an empty state with Retry where applicable.

Copy .env.example to .env for local runs (both are git-ignored; never commit keys).

Third-party site (portal, product, NOC wall, report)
  │ <iframe src="https://raw.githubusercontent.com/taosher/signoz-open-dashboard/HEAD/.../embed/:id?...">
  ▼
┌────────────────────────────────────────┐
│ signoz-open-dashboard (single image)   │
│  ┌──────────────┐  ┌─────────────────┐ │
│  │ apps/web     │─▶│ apps/api :8080  │ │
│  │ /embed/:id   │  │ /api/signoz/*───┼─┼─▶ Upstream SigNoz
│  │ shadcn/legacy│  │ /healthz        │ │   (SIGNOZ-API-KEY injected)
│  └──────────────┘  └─────────────────┘ │
│  NestJS ServeStatic serves web/dist    │
└────────────────────────────────────────┘

Browser loads static HTML → web parses the URL into a memory-only auth context (never localStorage/cookie) → all data calls go to same-origin /api/signoz/... with x-embed-api-key → NestJS injects SIGNOZ-API-KEY and streams the upstream response back.

website/ is the project landing site and usage documentation (/ intro, /docs, /design), built with vinext + Tailwind CSS v4 + Magic UI. It is an isolated pnpm project (own pnpm-workspace.yaml + lockfile, Node >=22) so the embedding runtime and its Docker image stay untouched.

cd website
pnpm install
pnpm dev      # vinext dev server
pnpm build    # static export -> website/dist/client (deploy to any static host)

The website-deploy workflow builds it and publishes the static export to Cloudflare on pushes to main that touch website/: Workers static assets (signoz-open-dashboard-website.<account>.workers.dev) and a Pages project (signoz-open-dashboard-website.pages.dev). Configure the CLOUDFLARE_API_TOKEN (Workers Scripts: Edit + Cloudflare Pages: Edit) and CLOUDFLARE_ACCOUNT_ID repository secrets. Deploy locally with pnpm run deploy:workers / pnpm run deploy:pages (or validate the Worker with pnpm run deploy:workers:dry-run).

pnpm install
pnpm build                 # all packages + web-dist sync
pnpm build:api | pnpm build:web | pnpm build:shared
pnpm test                  # all
pnpm --filter @signoz-open-dashboard/api test:e2e  # proxy matrix with mock upstream
pnpm typecheck

Layout: apps/api (NestJS proxy + static hosting + health/metrics) · apps/web/src/{core,signoz,themes} (embed app; core is theme-agnostic, each theme implements the ThemeModule contract: Tokens/Toolbar/WidgetCard/ErrorState) · packages/shared (URL params, error codes).

MIT. See LICENSE. SigNoz is a trademark of its respective owner; this project is independent and not affiliated with SigNoz, Inc.