Getting Started Guide

Overview & Quick Start

Turnkey Node.js backend observability for Express, NestJS, Fastify, and Koa, paired with ready-to-mount React & Next.js admin dashboards. Collect Prometheus metrics, OpenTelemetry traces, and intelligent error fingerprints with zero external framework lock-in.

PRODUCTION-READY TELEMETRY
Stacklenzz runs directly inside your existing infrastructure without requiring expensive third-party SaaS agents or external collectors.

Architecture & Pipeline Overview

Stacklenzz provides an end-to-end telemetry pipeline designed specifically for JavaScript and TypeScript applications.

Backend Core SDK

One-line middleware setup for Express and NestJS. Exposes /metrics for Prometheus and /api/observability/stats.

React Dashboard UI

6 pre-built dashboard layouts, 6 runtime color themes, deep error inspector with stack traces and breadcrumb timelines.

Zero-Config CLI

Detects Next.js App/Pages Router and Vite. Installs UI routes, initializes configs, and validates connectivity with doctor.

Telemetry Data Flow

1. Incoming HTTP requests pass through the Stacklenzz backend middleware.
2. Latencies, HTTP status codes, CPU/memory stats, and error stack traces are aggregated into memory buffers.
3. React administrative UI fetches aggregated stats from your server or queries OpenTelemetry traces.

⚡️ Quick Start in 3 Steps

1Instrument Your Backend

npm install @stacklenzz/server

2Scaffold Frontend Dashboard

npx stacklenzz dashboard

3View Live Protected Route

Navigate to your frontend application to inspect live traffic, latencies, and errors in real-time:

📦 Package Installation Options

Select your preferred package manager to view installation commands:

Terminal Command (CLI)

# 1. Scaffold Dashboard Route
npx stacklenzz dashboard

# 2. Run Doctor to Validate Connection
npx stacklenzz doctor