adonisjs-pulse 0.0.1

package/build/src/types.d.ts

@@ -0,0 +1,91 @@
+import type { Entry } from './entry.js';
+import type { Value } from './value.js';
+import type { Recorder, RecorderOptions } from './recorders/recorder.js';
+export type AggregationType = 'count' | 'min' | 'max' | 'sum' | 'avg';
+export interface EntryAttributes {
+    timestamp: number;
+    type: string;
+    key: string;
+    value: number | null;
+}
+export interface ValueAttributes {
+    timestamp: number;
+    type: string;
+    key: string;
+    value: string;
+}
+export interface StoredEntry extends EntryAttributes {
+    id: number;
+    key_hash: string;
+}
+export interface StoredValue extends ValueAttributes {
+    id: number;
+    key_hash: string;
+}
+export interface StoredAggregate {
+    id: number;
+    bucket: number;
+    period: number;
+    type: string;
+    key: string;
+    key_hash: string;
+    aggregate: AggregationType;
+    value: number;
+    count: number | null;
+}
+export interface AggregateResult {
+    key: string;
+    count?: number;
+    min?: number;
+    max?: number;
+    sum?: number;
+    avg?: number;
+}
+export interface AggregateTypesResult {
+    key: string;
+    [type: string]: string | number | undefined;
+}
+export type LazyRecorder = () => Promise<{
+    default: new (options?: RecorderOptions) => Recorder;
+}>;
+export interface RecorderEntry extends RecorderOptions {
+    recorder: LazyRecorder;
+}
+export interface PulseConfig {
+    enabled: boolean;
+    storage: {
+        connection?: string;
+    };
+    ingest: {
+        interval: number;
+        lottery: {
+            chance: number;
+            outOf: number;
+        };
+    };
+    recorders: RecorderEntry[];
+}
+export interface ResolvedPulseConfig {
+    enabled: boolean;
+    ingestInterval: number;
+    trimLotteryChance: [number, number];
+    connection?: string;
+    retain: {
+        entries: number;
+        values: number;
+        aggregates: number;
+    };
+    recorders: RecorderEntry[];
+}
+export interface PulseStorage {
+    store(entries: Entry[], values: Value[]): Promise<void>;
+    trim(): Promise<void>;
+    purge(types?: string[]): Promise<void>;
+    values(type: string, keys?: string[]): Promise<StoredValue[]>;
+    aggregate(type: string, aggregates: AggregationType[], interval: number, orderBy?: AggregationType, direction?: 'asc' | 'desc', limit?: number): Promise<Map<string, AggregateResult>>;
+    aggregateTypes(types: string[], aggregate: AggregationType, interval: number, orderBy?: string, direction?: 'asc' | 'desc', limit?: number): Promise<AggregateTypesResult[]>;
+    aggregateTotal(types: string[], aggregate: AggregationType, interval: number): Promise<Record<string, number>>;
+    graph(types: string[], aggregate: AggregationType, interval: number): Promise<Map<number, Map<string, number>>>;
+}
+export type RecordCallback = () => Entry | Value | Entry[] | Value[] | null | Promise<Entry | Value | Entry[] | Value[] | null>;
+export declare function defineConfig(config: PulseConfig): PulseConfig;

package/build/src/types.js

@@ -0,0 +1,3 @@
+export function defineConfig(config) {
+    return config;
+}

package/build/src/value.d.ts

@@ -0,0 +1,9 @@
+import type { ValueAttributes } from './types.js';
+export declare class Value {
+    timestamp: number;
+    type: string;
+    key: string;
+    value: string;
+    constructor(timestamp: number, type: string, key: string, value: string);
+    attributes(): ValueAttributes;
+}

package/build/src/value.js

@@ -0,0 +1,20 @@
+export class Value {
+    timestamp;
+    type;
+    key;
+    value;
+    constructor(timestamp, type, key, value) {
+        this.timestamp = timestamp;
+        this.type = type;
+        this.key = key;
+        this.value = value;
+    }
+    attributes() {
+        return {
+            timestamp: this.timestamp,
+            type: this.type,
+            key: this.key,
+            value: this.value,
+        };
+    }
+}

package/build/stubs/config.stub

@@ -0,0 +1,58 @@
+{{{
+  exports({ to: app.configPath('pulse.ts') })
+}}}
+import env from '#start/env'
+import { defineConfig } from 'adonisjs-pulse'
+
+export default defineConfig({
+  enabled: env.get('PULSE_ENABLED', true),
+
+  storage: {
+    connection: env.get('PULSE_DB_CONNECTION'),
+  },
+
+  ingest: {
+    interval: 5000,
+    lottery: {
+      chance: 1,
+      outOf: 1000,
+    },
+  },
+
+  recorders: [
+    {
+      recorder: () => import('adonisjs-pulse/recorders/slow_requests'),
+      enabled: env.get('PULSE_SLOW_REQUESTS_ENABLED', true),
+      sampleRate: env.get('PULSE_SLOW_REQUESTS_SAMPLE_RATE', 1),
+      threshold: env.get('PULSE_SLOW_REQUESTS_THRESHOLD', 1000),
+      ignore: ['/pulse'],
+    },
+    {
+      recorder: () => import('adonisjs-pulse/recorders/slow_queries'),
+      enabled: env.get('PULSE_SLOW_QUERIES_ENABLED', true),
+      sampleRate: env.get('PULSE_SLOW_QUERIES_SAMPLE_RATE', 1),
+      threshold: env.get('PULSE_SLOW_QUERIES_THRESHOLD', 1000),
+      ignore: ['/pulse_/'],
+    },
+    {
+      recorder: () => import('adonisjs-pulse/recorders/exceptions'),
+      enabled: env.get('PULSE_EXCEPTIONS_ENABLED', true),
+      sampleRate: env.get('PULSE_EXCEPTIONS_SAMPLE_RATE', 1),
+      ignore: [],
+    },
+    {
+      recorder: () => import('adonisjs-pulse/recorders/servers'),
+      enabled: env.get('PULSE_SERVERS_ENABLED', true),
+      directories: ['/'],
+    },
+    {
+      recorder: () => import('adonisjs-pulse/recorders/cache_interactions'),
+      enabled: env.get('PULSE_CACHE_INTERACTIONS_ENABLED', true),
+      sampleRate: env.get('PULSE_CACHE_INTERACTIONS_SAMPLE_RATE', 1),
+      ignore: [],
+      groups: {
+        '/^job-exceptions:.*/': 'job-exceptions:*',
+      },
+    },
+  ],
+})

package/build/stubs/main.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export declare const stubsRoot: string;

package/build/stubs/main.js

@@ -0,0 +1,7 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export const stubsRoot = dirname(fileURLToPath(import.meta.url));

package/build/stubs/migration.stub

@@ -0,0 +1,58 @@
+{{{
+  exports({ to: app.migrationsPath(time + '_create_pulse_tables.ts') })
+}}}
+import { BaseSchema } from '@adonisjs/lucid/schema'
+
+export default class extends BaseSchema {
+  async up() {
+    this.schema.createTable('pulse_values', (table) => {
+      table.increments('id')
+      table.integer('timestamp').unsigned()
+      table.string('type')
+      table.text('key', 'medium')
+      table.string('key_hash')
+      table.text('value', 'medium')
+
+      table.index('timestamp') // For trimming...
+      table.index('type') // For fast lookups and purging...
+      table.unique(['type', 'key_hash']) // For data integrity and upserts...
+    })
+
+    this.schema.createTable('pulse_entries', (table) => {
+      table.increments('id')
+      table.integer('timestamp').unsigned()
+      table.string('type')
+      table.text('key', 'medium')
+      table.string('key_hash')
+      table.bigInteger('value').nullable()
+
+      table.index('timestamp') // For trimming...
+      table.index('type') // For purging...
+      table.index('key_hash') // For mapping...
+      table.index(['timestamp', 'type', 'key_hash', 'value']) // For aggregate queries...
+    })
+
+    this.schema.createTable('pulse_aggregates', (table) => {
+      table.increments('id')
+      table.integer('bucket').unsigned()
+      table.mediumint('period').unsigned()
+      table.string('type')
+      table.text('key', 'medium')
+      table.string('key_hash')
+      table.string('aggregate')
+      table.decimal('value', 20, 2)
+      table.integer('count').nullable()
+
+      table.unique(['bucket', 'period', 'type', 'aggregate', 'key_hash']) // Force "on duplicate update"...
+      table.index(['period', 'bucket']) // For trimming...
+      table.index('type') // For purging...
+      table.index(['period', 'type', 'aggregate', 'bucket']) // For aggregate queries...
+    })
+  }
+
+  async down() {
+    this.schema.dropTable('pulse_values')
+    this.schema.dropTable('pulse_entries')
+    this.schema.dropTable('pulse_aggregates')
+  }
+}

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "adonisjs-pulse",
+  "description": "",
+  "version": "0.0.1",
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "type": "module",
+  "files": [
+    "build/src",
+    "build/providers",
+    "build/services",
+    "build/stubs",
+    "build/resources",
+    "build/index.d.ts",
+    "build/index.js",
+    "build/configure.d.ts",
+    "build/configure.js"
+  ],
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js",
+    "./pulse_provider": "./build/providers/pulse_provider.js",
+    "./services/pulse": "./build/services/pulse.js",
+    "./recorders/slow_requests": "./build/src/recorders/slow_requests.js",
+    "./recorders/slow_queries": "./build/src/recorders/slow_queries.js",
+    "./recorders/exceptions": "./build/src/recorders/exceptions.js",
+    "./recorders/servers": "./build/src/recorders/servers.js",
+    "./recorders/cache_interactions": "./build/src/recorders/cache_interactions.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/core": "^6.12.0",
+    "@adonisjs/eslint-config": "2.0.0-beta.7",
+    "@adonisjs/lucid": "^21.8.2",
+    "@adonisjs/prettier-config": "^1.4.0",
+    "@adonisjs/tsconfig": "^1.3.0",
+    "@japa/assert": "^3.0.0",
+    "@japa/runner": "^3.1.4",
+    "@swc/core": "^1.6.3",
+    "@types/node": "^20.14.5",
+    "adonisjs-livewire": "^0.15.1",
+    "c8": "^10.1.2",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^5.1.0",
+    "edge.js": "^6.4.0",
+    "eslint": "^9.15.0",
+    "np": "^10.0.6",
+    "prettier": "^3.3.2",
+    "ts-node-maintained": "^10.9.4",
+    "typescript": "^5.4.5"
+  },
+  "peerDependencies": {
+    "@adonisjs/core": "^6.2.0",
+    "@adonisjs/lucid": "^21.8.2",
+    "adonisjs-livewire": "^0.15.1",
+    "edge.js": "^6.4.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "np": {
+    "message": "chore(release): %s",
+    "tag": "latest",
+    "branch": "main",
+    "anyBranch": false
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "dependencies": {
+    "unreflect": "^0.0.7"
+  },
+  "scripts": {
+    "clean": "del-cli build",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" \"resources/**/*\" build",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
+    "pretest": "npm run lint",
+    "test": "c8 npm run quick:test",
+    "prebuild": "npm run lint && npm run clean",
+    "build": "tsc",
+    "postbuild": "npm run copy:templates",
+    "release": "np",
+    "version": "npm run build"
+  }
+}