0.1.15

deno_dist/helpers.ts

@@ -1,10 +1,19 @@
 import process from "node:process";
 import { ValidationSchema } from './types.ts';
+import { Inspector } from './inspector.ts';
 
 export function isBun() {
   return !!process.versions.bun;
 }
 
+export function isInspectorLike(inspector: any) {
+  return (
+    !!inspector &&
+    (inspector instanceof Inspector ||
+      ('instruments' in inspector && 'createSession' in inspector))
+  );
+}
+
 export function getFunctionCallStack(
   ignore: string[] = ['getFunctionCallStack']
 ): string[] {

deno_dist/inspector.ts

@@ -7,6 +7,7 @@ import { LogsInstrument } from './instruments/logs.ts';
 import { MetricsInstrument } from './instruments/metrics.ts';
 import { NetworkInstrument } from './instruments/network.ts';
 import { TracesInstrument } from './instruments/traces.ts';
+import { MemoryStore } from './store.ts';
 import defaultDashboards from './default-dashboards.ts';
 import defaultMeasurements from './default-measurements.ts';
 import type { Dashboard, InspectorInit, SessionInit } from './types.ts';
@@ -21,9 +22,9 @@ export class Inspector {
     return defaultMeasurements;
   }
 
-  env: Record<string, string> = {};
+  readonly env: Record<string, string> = {};
 
-  instruments: {
+  readonly instruments: {
     errors: ErrorsInstrument;
     events: EventsInstrument;
     logs: LogsInstrument;
@@ -32,9 +33,9 @@ export class Inspector {
     traces: TracesInstrument;
   };
 
-  sessions: Set<Session> = new Set();
+  readonly sessions: Set<Session> = new Set();
 
-  store: Store;
+  readonly store: Store;
 
   get info() {
     const cpus = os.cpus();
@@ -54,8 +55,13 @@ export class Inspector {
     };
   }
 
-  constructor(init: InspectorInit) {
-    const { activate = true, env = true, instruments = {}, store } = init;
+  constructor(init: InspectorInit = {}) {
+    const {
+      activate = true,
+      env = true,
+      instruments = {},
+      store = new MemoryStore(),
+    } = init;
     this.store = store;
     this.instruments = {
       errors: new ErrorsInstrument(store, instruments.errors),
@@ -102,6 +108,7 @@ export class Inspector {
     return session;
   }
 
+  /** @deprecated */
   getInstrument(instrument: keyof typeof this.instruments) {
     if (!this.instruments[instrument]) {
       throw new Error(`Unknown instrument "${instrument}".`);

deno_dist/types.ts

@@ -154,7 +154,7 @@ export interface InspectorInit {
   activate?: boolean;
   env?: boolean;
   instruments?: InspectorInitInstruments;
-  store: Store;
+  store?: Store;
 }
 
 export interface ErrorsInstrumentValue {

dist/helpers.d.ts

@@ -1,5 +1,6 @@
 import { ValidationSchema } from './types.js';
 export declare function isBun(): boolean;
+export declare function isInspectorLike(inspector: any): boolean;
 export declare function getFunctionCallStack(ignore?: string[]): string[];
 export declare function getModulesFromCallStack(stack: string[]): string[];
 export declare function validate(schema: Record<string, ValidationSchema>, obj: any): void;

dist/helpers.js

@@ -1,6 +1,12 @@
+import { Inspector } from './inspector.js';
 export function isBun() {
     return !!process.versions.bun;
 }
+export function isInspectorLike(inspector) {
+    return (!!inspector &&
+        (inspector instanceof Inspector ||
+            ('instruments' in inspector && 'createSession' in inspector)));
+}
 export function getFunctionCallStack(ignore = ['getFunctionCallStack']) {
     const obj = {};
     Error.captureStackTrace(obj);

dist/inspector.d.ts

@@ -11,17 +11,17 @@ import type { MeasurementConfig, Store } from '@exotjs/measurements/types';
 export declare class Inspector {
     static defaultDashboards(): Dashboard[];
     static defaultMeasurements(): MeasurementConfig[];
-    env: Record<string, string>;
-    instruments: {
+    readonly env: Record<string, string>;
+    readonly instruments: {
         errors: ErrorsInstrument;
         events: EventsInstrument;
         logs: LogsInstrument;
         metrics: MetricsInstrument;
         network: NetworkInstrument;
         traces: TracesInstrument;
     };
-    sessions: Set<Session>;
-    store: Store;
+    readonly sessions: Set<Session>;
+    readonly store: Store;
     get info(): {
         apiVersion: string;
         arch: string;
@@ -34,10 +34,11 @@ export declare class Inspector {
         runtimeVersion: string;
         startedAt: number;
     };
-    constructor(init: InspectorInit);
+    constructor(init?: InspectorInit);
     destroy(): void;
     activate(): void;
     deactivate(): void;
     createSession(init?: SessionInit): Session;
+    /** @deprecated */
     getInstrument(instrument: keyof typeof this.instruments): ErrorsInstrument | EventsInstrument | LogsInstrument | MetricsInstrument | NetworkInstrument | TracesInstrument;
 }

dist/inspector.js

@@ -7,6 +7,7 @@ import { LogsInstrument } from './instruments/logs.js';
 import { MetricsInstrument } from './instruments/metrics.js';
 import { NetworkInstrument } from './instruments/network.js';
 import { TracesInstrument } from './instruments/traces.js';
+import { MemoryStore } from './store.js';
 import defaultDashboards from './default-dashboards.js';
 import defaultMeasurements from './default-measurements.js';
 export class Inspector {
@@ -36,8 +37,8 @@ export class Inspector {
             startedAt: performance.timeOrigin,
         };
     }
-    constructor(init) {
-        const { activate = true, env = true, instruments = {}, store } = init;
+    constructor(init = {}) {
+        const { activate = true, env = true, instruments = {}, store = new MemoryStore(), } = init;
         this.store = store;
         this.instruments = {
             errors: new ErrorsInstrument(store, instruments.errors),
@@ -79,6 +80,7 @@ export class Inspector {
         });
         return session;
     }
+    /** @deprecated */
     getInstrument(instrument) {
         if (!this.instruments[instrument]) {
             throw new Error(`Unknown instrument "${instrument}".`);

dist/types.d.ts

@@ -117,7 +117,7 @@ export interface InspectorInit {
     activate?: boolean;
     env?: boolean;
     instruments?: InspectorInitInstruments;
-    store: Store;
+    store?: Store;
 }
 export interface ErrorsInstrumentValue {
     attributes?: Record<string, any>;

lib/helpers.ts

@@ -1,9 +1,18 @@
 import { ValidationSchema } from './types.js';
+import { Inspector } from './inspector.js';
 
 export function isBun() {
   return !!process.versions.bun;
 }
 
+export function isInspectorLike(inspector: any) {
+  return (
+    !!inspector &&
+    (inspector instanceof Inspector ||
+      ('instruments' in inspector && 'createSession' in inspector))
+  );
+}
+
 export function getFunctionCallStack(
   ignore: string[] = ['getFunctionCallStack']
 ): string[] {

lib/inspector.ts

@@ -7,6 +7,7 @@ import { LogsInstrument } from './instruments/logs.js';
 import { MetricsInstrument } from './instruments/metrics.js';
 import { NetworkInstrument } from './instruments/network.js';
 import { TracesInstrument } from './instruments/traces.js';
+import { MemoryStore } from './store.js';
 import defaultDashboards from './default-dashboards.js';
 import defaultMeasurements from './default-measurements.js';
 import type { Dashboard, InspectorInit, SessionInit } from './types.js';
@@ -21,9 +22,9 @@ export class Inspector {
     return defaultMeasurements;
   }
 
-  env: Record<string, string> = {};
+  readonly env: Record<string, string> = {};
 
-  instruments: {
+  readonly instruments: {
     errors: ErrorsInstrument;
     events: EventsInstrument;
     logs: LogsInstrument;
@@ -32,9 +33,9 @@ export class Inspector {
     traces: TracesInstrument;
   };
 
-  sessions: Set<Session> = new Set();
+  readonly sessions: Set<Session> = new Set();
 
-  store: Store;
+  readonly store: Store;
 
   get info() {
     const cpus = os.cpus();
@@ -54,8 +55,13 @@ export class Inspector {
     };
   }
 
-  constructor(init: InspectorInit) {
-    const { activate = true, env = true, instruments = {}, store } = init;
+  constructor(init: InspectorInit = {}) {
+    const {
+      activate = true,
+      env = true,
+      instruments = {},
+      store = new MemoryStore(),
+    } = init;
     this.store = store;
     this.instruments = {
       errors: new ErrorsInstrument(store, instruments.errors),
@@ -102,6 +108,7 @@ export class Inspector {
     return session;
   }
 
+  /** @deprecated */
   getInstrument(instrument: keyof typeof this.instruments) {
     if (!this.instruments[instrument]) {
       throw new Error(`Unknown instrument "${instrument}".`);

lib/types.ts

@@ -153,7 +153,7 @@ export interface InspectorInit {
   activate?: boolean;
   env?: boolean;
   instruments?: InspectorInitInstruments;
-  store: Store;
+  store?: Store;
 }
 
 export interface ErrorsInstrumentValue {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exotjs/inspector",
-  "version": "0.1.14",
-  "description": "Exot application inspector",
+  "version": "0.1.15",
+  "description": "Exot Inspector - monitoring, tracing and debugging for Node.js, Bun and Deno.",
   "author": "Daniel Regeci",
   "license": "MIT",
   "keywords": [
@@ -36,6 +36,10 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
+    "./helpers": {
+      "types": "./dist/helpers.d.ts",
+      "import": "./dist/helpers.js"
+    },
     "./session": {
       "types": "./dist/session.d.ts",
       "import": "./dist/session.js"
@@ -50,6 +54,9 @@
       "types": [
         "./dist/types"
       ],
+      "helpers": [
+        "./dist/helpers"
+      ],
       "session": [
         "./dist/session"
       ],

tests/helpers.test.ts

@@ -2,11 +2,37 @@ import { describe, expect, it } from 'vitest';
 import {
   getFunctionCallStack,
   getModulesFromCallStack,
+  isInspectorLike,
   validate,
 } from '../lib/helpers.js';
+import { Inspector } from '../lib/inspector.js';
 import { ValidationSchema } from '../lib/types.js';
 
 describe('helpers', () => {
+  describe('isInspectorLike()', () => {
+    it('should return false if undefined', () => {
+      expect(isInspectorLike(void 0)).toEqual(false);
+    });
+
+    it('should return false if null', () => {
+      expect(isInspectorLike(null)).toEqual(false);
+    });
+
+    it('should return false if an object', () => {
+      expect(isInspectorLike({})).toEqual(false);
+    });
+
+    it('should return true if instance', () => {
+      expect(isInspectorLike(new Inspector())).toEqual(true);
+    });
+
+    it('should return true if an instance-compatible object', () => {
+      expect(
+        isInspectorLike({ instruments: {}, createSession: () => {} })
+      ).toEqual(true);
+    });
+  });
+
   describe('validate()', () => {
     it('should throw if the object does not match the schema', () => {
       expect(() =>