@ngn-net/nestjs-telescope 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
A full-featured developer assistant and application monitoring suite for NestJS, inspired by Laravel Telescope. It monitors incoming HTTP requests, database queries, cache operations, background queue jobs, application events, outgoing mail, logs, unhandled exceptions, cron job schedules, Redis commands, CLI commands, ORM model lifecycle events, notifications, and authorization gate checks.
|
|
6
6
|
|
|
7
|
-
All telemetry records are persisted to **MongoDB** (via Mongoose)
|
|
7
|
+
All telemetry records are persisted to a **dedicated MongoDB** (via Mongoose) and accessible via a modern, high-fidelity dark-themed single-page application dashboard. Telescope uses its own MongoDB connection — completely separate from your project's database.
|
|
8
8
|
|
|
9
9
|
---
|
|
10
10
|
|
|
@@ -41,18 +41,18 @@ Telescope stores its telemetry data in a **dedicated MongoDB collection** (`tele
|
|
|
41
41
|
|
|
42
42
|
### MongoDB Connection
|
|
43
43
|
|
|
44
|
-
Telescope connects to MongoDB using the `
|
|
44
|
+
Telescope connects to its own dedicated MongoDB using the `TELESCOPE_MONGO_URI` environment variable, or falls back to `mongodb://localhost:27017/telescope`.
|
|
45
45
|
|
|
46
46
|
```bash
|
|
47
47
|
# .env
|
|
48
|
-
|
|
48
|
+
TELESCOPE_MONGO_URI=mongodb://localhost:27017/telescope
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
Or pass the URI directly in configuration:
|
|
52
52
|
|
|
53
53
|
```typescript
|
|
54
54
|
TelescopeModule.forRoot({
|
|
55
|
-
mongoUri: 'mongodb://
|
|
55
|
+
mongoUri: 'mongodb://your-mongo-host:27017/telescope',
|
|
56
56
|
// ... other options
|
|
57
57
|
})
|
|
58
58
|
```
|
|
@@ -64,10 +64,10 @@ TelescopeModule.forRoot({
|
|
|
64
64
|
Install the package:
|
|
65
65
|
|
|
66
66
|
```bash
|
|
67
|
-
npm install @ngn-net/nestjs-telescope @nestjs/
|
|
67
|
+
npm install @ngn-net/nestjs-telescope @nestjs/jwt @nestjs/passport passport-jwt
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
No need to install `mongoose` or configure `MongooseModule` — Telescope handles its own MongoDB connection internally.
|
|
71
71
|
|
|
72
72
|
---
|
|
73
73
|
|
|
@@ -75,25 +75,23 @@ Ensure you have `MongooseModule` initialized in your NestJS application.
|
|
|
75
75
|
|
|
76
76
|
```typescript
|
|
77
77
|
import { Module } from '@nestjs/common';
|
|
78
|
-
import { MongooseModule } from '@nestjs/mongoose';
|
|
79
78
|
import { TelescopeModule } from '@ngn-net/nestjs-telescope';
|
|
80
79
|
|
|
81
80
|
@Module({
|
|
82
81
|
imports: [
|
|
83
|
-
MongooseModule.forRoot(process.env.MONGO_URI || 'mongodb://localhost:27017/telescope'),
|
|
84
82
|
TelescopeModule.forRoot({
|
|
85
83
|
path: 'telescope',
|
|
86
84
|
jwtSecret: 'your-secret-key',
|
|
87
85
|
password: 'your-password',
|
|
86
|
+
// Telescope connects to its own MongoDB automatically
|
|
87
|
+
// Default: mongodb://localhost:27017/telescope
|
|
88
88
|
}),
|
|
89
89
|
],
|
|
90
90
|
})
|
|
91
91
|
export class AppModule {}
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
## Optional & Peer Dependencies
|
|
94
|
+
Your app's database (TypeORM/Prisma/Sequelize/etc.) stays completely separate — Telescope never touches it.
|
|
97
95
|
|
|
98
96
|
All watchers are dynamically activated. If your application does not use certain modules, Telescope will safely boot without them. Simply install the peer dependencies for the watchers you want to enable:
|
|
99
97
|
|
|
@@ -147,35 +145,22 @@ You can pass configuration options into `TelescopeModule.forRoot(options)`:
|
|
|
147
145
|
|
|
148
146
|
```typescript
|
|
149
147
|
import { Module } from '@nestjs/common';
|
|
150
|
-
import {
|
|
148
|
+
import { TypeOrmModule } from '@nestjs/typeorm';
|
|
151
149
|
import { TelescopeModule, EntryType } from '@ngn-net/nestjs-telescope';
|
|
152
150
|
|
|
153
151
|
@Module({
|
|
154
152
|
imports: [
|
|
155
|
-
|
|
153
|
+
// Your project database — completely separate from Telescope
|
|
154
|
+
TypeOrmModule.forRoot({
|
|
155
|
+
type: 'postgres',
|
|
156
|
+
database: 'myapp_db',
|
|
157
|
+
}),
|
|
156
158
|
TelescopeModule.forRoot({
|
|
157
159
|
path: 'telescope',
|
|
158
160
|
password: 'my-secure-password',
|
|
159
161
|
jwtSecret: 'my-jwt-secret',
|
|
160
162
|
maxEntries: 500,
|
|
161
|
-
|
|
162
|
-
enabledEntryTypes: [
|
|
163
|
-
EntryType.REQUEST,
|
|
164
|
-
EntryType.HTTP_CLIENT,
|
|
165
|
-
EntryType.QUERY,
|
|
166
|
-
EntryType.CACHE,
|
|
167
|
-
EntryType.JOB,
|
|
168
|
-
EntryType.EVENT,
|
|
169
|
-
EntryType.LOG,
|
|
170
|
-
EntryType.EXCEPTION,
|
|
171
|
-
EntryType.SCHEDULED_TASK,
|
|
172
|
-
EntryType.REDIS,
|
|
173
|
-
EntryType.MAIL,
|
|
174
|
-
EntryType.GATE,
|
|
175
|
-
EntryType.COMMAND,
|
|
176
|
-
EntryType.MODEL,
|
|
177
|
-
EntryType.NOTIFICATION,
|
|
178
|
-
],
|
|
163
|
+
// Telescope uses its own MongoDB: mongodb://localhost:27017/telescope
|
|
179
164
|
}),
|
|
180
165
|
],
|
|
181
166
|
})
|
|
@@ -277,14 +262,14 @@ npm run test
|
|
|
277
262
|
|
|
278
263
|
If upgrading from v0.2.x (which used TypeORM/SQL):
|
|
279
264
|
|
|
280
|
-
1.
|
|
265
|
+
1. Update the package:
|
|
281
266
|
```bash
|
|
282
|
-
npm install @ngn-net/nestjs-telescope
|
|
267
|
+
npm install @ngn-net/nestjs-telescope@latest
|
|
283
268
|
```
|
|
284
269
|
|
|
285
|
-
2.
|
|
270
|
+
2. Ensure MongoDB is available at `mongodb://localhost:27017/telescope` (or configure `mongoUri`).
|
|
286
271
|
|
|
287
|
-
3. Remove the old
|
|
272
|
+
3. Remove the old `TypeOrmModule` import if it was only added for Telescope.
|
|
288
273
|
|
|
289
274
|
4. The old `telescope_entries` SQL table can be dropped after migration.
|
|
290
275
|
|
package/dist/ui/manifest.json
CHANGED
|
@@ -10,7 +10,6 @@ var __metadata = (this && this.__metadata) || function (k, v) {
|
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
12
|
exports.ExceptionWatcher = void 0;
|
|
13
|
-
// src/watchers/exception.watcher.ts
|
|
14
13
|
const common_1 = require("@nestjs/common");
|
|
15
14
|
const rxjs_1 = require("rxjs");
|
|
16
15
|
const operators_1 = require("rxjs/operators");
|
|
@@ -22,11 +21,14 @@ let ExceptionWatcher = class ExceptionWatcher {
|
|
|
22
21
|
this.telescope = telescope;
|
|
23
22
|
}
|
|
24
23
|
intercept(context, next) {
|
|
25
|
-
// Skip non-HTTP execution contexts (e.g. RPC/RabbitMQ or WebSockets)
|
|
26
24
|
if (context.getType() !== 'http') {
|
|
27
25
|
return next.handle();
|
|
28
26
|
}
|
|
29
27
|
const request = context.switchToHttp().getRequest();
|
|
28
|
+
const url = request.originalUrl || request.url || '';
|
|
29
|
+
if (this.telescope.shouldIgnorePath(url)) {
|
|
30
|
+
return next.handle();
|
|
31
|
+
}
|
|
30
32
|
return next.handle().pipe((0, operators_1.catchError)((err) => {
|
|
31
33
|
this.telescope.record({
|
|
32
34
|
type: entry_type_enum_1.EntryType.EXCEPTION,
|
|
@@ -35,10 +37,9 @@ let ExceptionWatcher = class ExceptionWatcher {
|
|
|
35
37
|
message: err.message || String(err),
|
|
36
38
|
stack: err.stack || null,
|
|
37
39
|
status: err.status || err.statusCode || 500,
|
|
38
|
-
// Include request context for easier debugging
|
|
39
40
|
request: {
|
|
40
41
|
method: request?.method,
|
|
41
|
-
url
|
|
42
|
+
url,
|
|
42
43
|
ip: request?.ip,
|
|
43
44
|
},
|
|
44
45
|
},
|
|
@@ -24,6 +24,10 @@ let GateWatcher = class GateWatcher {
|
|
|
24
24
|
return next.handle();
|
|
25
25
|
}
|
|
26
26
|
const request = context.switchToHttp().getRequest();
|
|
27
|
+
const url = request.originalUrl || request.url || '';
|
|
28
|
+
if (this.telescope.shouldIgnorePath(url)) {
|
|
29
|
+
return next.handle();
|
|
30
|
+
}
|
|
27
31
|
const user = request.user || request.auth || null;
|
|
28
32
|
return next.handle().pipe((0, rxjs_1.tap)({
|
|
29
33
|
next: () => {
|
|
@@ -34,7 +38,7 @@ let GateWatcher = class GateWatcher {
|
|
|
34
38
|
allowed: true,
|
|
35
39
|
user: user ? { id: user.sub || user.id || user.username } : null,
|
|
36
40
|
method: request.method,
|
|
37
|
-
url
|
|
41
|
+
url,
|
|
38
42
|
},
|
|
39
43
|
}).catch(() => { });
|
|
40
44
|
},
|
|
@@ -50,7 +54,7 @@ let GateWatcher = class GateWatcher {
|
|
|
50
54
|
reason: err.message || err.constructor?.name || 'Access denied',
|
|
51
55
|
user: user ? { id: user.sub || user.id || user.username } : null,
|
|
52
56
|
method: request.method,
|
|
53
|
-
url
|
|
57
|
+
url,
|
|
54
58
|
},
|
|
55
59
|
}).catch(() => { });
|
|
56
60
|
}
|
|
@@ -41,7 +41,7 @@ let LogWatcher = class LogWatcher {
|
|
|
41
41
|
rawMessage = chunk.toString(encoding || 'utf8');
|
|
42
42
|
}
|
|
43
43
|
// Skip telescope internal queries or module logs
|
|
44
|
-
if (rawMessage.includes('telescope_entries') || rawMessage.includes('TelescopeModule')) {
|
|
44
|
+
if (rawMessage.includes('telescope_entries') || rawMessage.includes('TelescopeModule') || rawMessage.includes('Telescope')) {
|
|
45
45
|
return;
|
|
46
46
|
}
|
|
47
47
|
// Parse the log message
|