Telescope

A beautiful debug assistant for your CanxJS application. Insight into requests, exceptions, database queries, and more.

Overview

Request Monitoring

Monitor incoming HTTP requests, response statuses, and duration.

Query Watcher

inspect executed database queries and their execution time.

Schedule & Jobs

Track background jobs and scheduled tasks execution.

Log Inspector

View application logs and exceptions in real-time.

Installation

terminal

1bun add @canxjs/telescope
2# or
3npm install @canxjs/telescope

Configuration

Telescope can be configured in your `config/telescope.ts` or passed directly when initializing.

src/bootstrap.ts

1import { telescope } from '@canxjs/telescope';
2
3// Initialize with custom config
4telescope.init({
5  enabled: process.env.NODE_ENV === 'development',
6  limit: 100,
7  watchers: {
8    request: true,
9    query: true,
10    exception: true,
11    log: true,
12    job: false
13  }
14});

Usage

Access the dashboard at /telescope in your browser.

Note: Ensure you protect this route in production environments!