adonisjs-server-stats 1.10.0 → 1.11.0

package/dist/core/log-utils-helpers.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Parse an entry's `data` field into a Record, if possible.
+ *
+ * Handles both raw objects and JSON-encoded strings. Returns `null`
+ * if the field is not parseable as a plain object.
+ */
+export declare function parseDataBlob(data: unknown): Record<string, unknown> | null;
+/**
+ * Extract all keys from a record that are NOT in the standard log key set.
+ *
+ * Returns `null` when no non-standard keys are found.
+ */
+export declare function extractNonStandardKeys(record: Record<string, unknown>): Record<string, unknown> | null;

package/dist/core/metrics.d.ts

@@ -8,33 +8,8 @@ export type { MetricDefinition } from './types.js';
  * the predicate returns `false` for the current stats snapshot.
  */
 export declare const METRIC_DEFINITIONS: MetricDefinition[];
-/**
- * Look up a metric definition by its ID.
- *
- * @param id - Metric identifier (e.g. `'cpu'`, `'memory'`).
- * @returns The matching definition, or `undefined` if not found.
- */
+/** Look up a metric definition by its ID. */
 export declare function getMetricById(id: string): MetricDefinition | undefined;
-/**
- * Group metric definitions by their `group` field.
- *
- * Returns a `Map` where keys are group names and values are
- * arrays of metrics in that group. Metrics without an explicit
- * `group` default to `'core'`.
- *
- * The map iteration order matches first-seen order of groups
- * in {@link METRIC_DEFINITIONS}.
- *
- * @returns A map of group name to metric definitions.
- */
+/** Group metric definitions by their `group` field. */
 export declare function getMetricsByGroup(): Map<string, MetricDefinition[]>;
-/**
- * Maximum number of data points to keep in the sparkline history
- * buffer per metric. Matches the Edge implementation.
- */
-export declare const MAX_HISTORY = 60;
-/**
- * Milliseconds after the last successful update before the connection
- * is considered stale (amber dot indicator).
- */
-export declare const STALE_MS = 10000;
+export { MAX_HISTORY, STALE_MS } from './constants.js';

package/dist/core/pagination.d.ts

@@ -72,15 +72,6 @@ export declare function createFilterState(): FilterState;
  * @param direction - Default sort direction.
  */
 export declare function createSortState(field?: string, direction?: 'asc' | 'desc'): SortState;
-/**
- * Build a URL query parameter string from dashboard hook options.
- *
- * Accepts the flat options shape used by React/Vue hooks and converts
- * it to a query string compatible with the dashboard API.
- *
- * @param options - Dashboard hook options (page, perPage, search, sort, etc.).
- * @returns A query string (without leading `?`).
- */
 export declare function buildQueryParams(options: {
     page?: number;
     perPage?: number;

package/dist/core/server-stats-controller.d.ts

@@ -89,6 +89,12 @@ export declare class ServerStatsController {
      * Get the current connection mode.
      */
     getConnectionMode(): ConnectionMode;
+    /** Initialize the SSE subscription. Returns true if SSE failed and polling should be used. */
+    private initSseSubscription;
+    /** Set up a 3-second fallback timer to start polling if SSE hasn't connected. */
+    private setupSseFallbackTimer;
+    /** Start the stale detection interval. */
+    private startStaleDetection;
     /** Process incoming stats data from either SSE or polling. */
     private processStats;
     /** Poll the HTTP endpoint once. */

package/dist/core/transmit-helpers.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Build the options object for the Transmit constructor.
+ *
+ * When an authToken is provided, adds `beforeSubscribe` and
+ * `beforeUnsubscribe` hooks that attach a Bearer token header.
+ */
+export declare function buildTransmitOptions(baseUrl: string, authToken?: string): Record<string, unknown>;

package/dist/core/types-dashboard.d.ts

@@ -0,0 +1,178 @@
+/**
+ * Aggregated overview metrics returned by the dashboard overview endpoint.
+ */
+export interface OverviewMetrics {
+    avgResponseTime: number;
+    p95ResponseTime: number;
+    requestsPerMinute: number;
+    errorRate: number;
+    totalRequests: number;
+    slowestEndpoints: {
+        url?: string;
+        pattern?: string;
+        avgDuration: number;
+        count: number;
+    }[];
+    queryStats: {
+        total: number;
+        avgDuration: number;
+        perRequest: number;
+    };
+    recentErrors: {
+        id?: number;
+        level: string;
+        message: string;
+        timestamp?: number | string;
+    }[];
+    topEvents: {
+        eventName?: string;
+        name?: string;
+        event_name?: string;
+        event?: string;
+        count: number;
+    }[];
+    emailActivity: {
+        sent: number;
+        queued: number;
+        failed: number;
+    };
+    logLevelBreakdown: {
+        error: number;
+        warn: number;
+        info: number;
+        debug: number;
+    };
+    cacheStats: {
+        available: boolean;
+        totalKeys: number;
+        hitRate: number;
+        memoryUsedHuman: string;
+    } | null;
+    jobQueueStatus: {
+        available: boolean;
+        active: number;
+        waiting: number;
+        failed: number;
+        completed: number;
+    } | null;
+    statusDistribution: {
+        '2xx': number;
+        '3xx': number;
+        '4xx': number;
+        '5xx': number;
+    };
+    slowestQueries: {
+        sqlNormalized?: string;
+        normalizedSql?: string;
+        sql_normalized?: string;
+        sql?: string;
+        avgDuration: number;
+        count: number;
+    }[];
+    sparklines?: {
+        avgResponseTime?: number[];
+        p95ResponseTime?: number[];
+        requestsPerMinute?: number[];
+        errorRate?: number[];
+    };
+}
+/**
+ * Extended overview data used by Vue dashboard components.
+ * Extends {@link OverviewMetrics} with sparkline time-series data.
+ */
+export interface OverviewData extends OverviewMetrics {
+    avgResponseTimeSeries?: number[];
+    p95ResponseTimeSeries?: number[];
+    requestsPerMinuteSeries?: number[];
+    errorRateSeries?: number[];
+    recentErrors: {
+        id?: number;
+        level: string;
+        message: string;
+        timestamp: number | string;
+    }[];
+}
+/** Single data point for dashboard time-series charts. */
+export interface ChartDataPoint {
+    bucket: string;
+    total: number;
+    count2xx: number;
+    count3xx: number;
+    count4xx: number;
+    count5xx: number;
+    requestCount?: number;
+    errorCount?: number;
+    avgDuration?: number;
+    p95Duration?: number;
+}
+/** A grouped/aggregated query pattern for the dashboard queries section. */
+export interface GroupedQuery {
+    pattern: string;
+    count: number;
+    avgDuration: number;
+    minDuration: number;
+    maxDuration: number;
+    totalDuration: number;
+    percentOfTotal: number;
+}
+/** Redis / cache store statistics returned by the dashboard cache endpoint. */
+export interface DashboardCacheStats {
+    connected: boolean;
+    hits: number;
+    misses: number;
+    hitRate: number;
+    memoryUsedBytes: number;
+    memoryUsedHuman: string;
+    connectedClients: number;
+    totalKeys: number;
+    keyCount?: number;
+}
+/** Individual cache key entry in the dashboard cache inspector. */
+export interface DashboardCacheKeyEntry {
+    key: string;
+    type: string;
+    ttl: number;
+    size?: number | null;
+}
+/** Full response from the dashboard cache API endpoint. */
+export interface DashboardCacheResponse {
+    available: boolean;
+    stats: DashboardCacheStats | null;
+    keys?: DashboardCacheKeyEntry[];
+    data?: DashboardCacheKeyEntry[];
+    cursor: string;
+}
+/**
+ * Server response shape from the dashboard API `/api/jobs` endpoint.
+ */
+export interface JobsApiResponse {
+    available?: boolean;
+    overview?: JobStats;
+    stats?: JobStats;
+    data?: JobRecord[];
+    jobs?: JobRecord[];
+    total?: number;
+}
+/** Aggregate queue statistics. */
+export interface JobStats {
+    active: number;
+    waiting: number;
+    delayed: number;
+    completed: number;
+    failed: number;
+}
+/** Individual job record from the queue inspector. */
+export interface JobRecord {
+    id: string;
+    name: string;
+    status: string;
+    data: unknown;
+    payload: unknown;
+    attempts: number;
+    duration: number | null;
+    timestamp: number | string;
+    createdAt: number | string;
+    processedAt: number | string | null;
+    finishedAt: number | string | null;
+    failedReason: string | null;
+}

package/dist/core/types-diagnostics.d.ts

@@ -0,0 +1,85 @@
+/** Buffer usage info returned by the diagnostics endpoint. */
+export interface DiagnosticsBufferInfo {
+    current: number;
+    max: number;
+}
+/** Collector metadata returned by the diagnostics endpoint. */
+export interface DiagnosticsCollectorInfo {
+    name: string;
+    label: string;
+    status: 'healthy' | 'errored' | 'stopped';
+    lastError: string | null;
+    lastErrorAt: number | null;
+    config: Record<string, unknown>;
+}
+/** Timer state returned by the diagnostics endpoint. */
+export interface DiagnosticsTimerInfo {
+    active: boolean;
+    intervalMs?: number;
+    debounceMs?: number;
+}
+/**
+ * Full diagnostics response from `GET {debugEndpoint}/diagnostics`.
+ *
+ * Used by both React `InternalsContent` and Vue `InternalsTab` / `InternalsSection`.
+ */
+export interface DiagnosticsResponse {
+    package: {
+        version: string;
+        nodeVersion: string;
+        adonisVersion: string;
+        uptime?: number;
+    };
+    config: {
+        intervalMs: number;
+        transport: string;
+        channelName: string;
+        endpoint: string | false;
+        skipInTest: boolean;
+        hasOnStatsCallback: boolean;
+        hasShouldShowCallback: boolean;
+    };
+    devToolbar: {
+        enabled: boolean;
+        maxQueries: number;
+        maxEvents: number;
+        maxEmails: number;
+        maxTraces: number;
+        slowQueryThresholdMs: number;
+        tracing: boolean;
+        dashboard: boolean;
+        dashboardPath: string;
+        debugEndpoint: string;
+        retentionDays: number;
+        dbPath: string;
+        persistDebugData: boolean | string;
+        renderer: string;
+        excludeFromTracing: string[];
+        customPaneCount: number;
+    };
+    collectors: DiagnosticsCollectorInfo[];
+    buffers: Record<string, DiagnosticsBufferInfo>;
+    timers: Record<string, DiagnosticsTimerInfo>;
+    transmit: {
+        available: boolean;
+        channels: string[];
+    };
+    integrations: Record<string, {
+        active?: boolean;
+        available?: boolean;
+        mode?: string;
+    }>;
+    storage: {
+        ready: boolean;
+        dbPath: string;
+        fileSizeMb: number;
+        walSizeMb: number;
+        retentionDays: number;
+        tables: Array<{
+            name: string;
+            rowCount: number;
+        }>;
+        lastCleanupAt: number | null;
+    } | null;
+    uptime?: number;
+}