@n8n/n8n-benchmark/dist/test-execution/test-report.d.ts

Cli for running benchmark tests for n8n

import type { Scenario } from '../types/scenario';
export type K6Tag = {
    name: string;
    value: string;
};
export type Check = {
    name: string;
    passes: number;
    fails: number;
};
export type CounterMetric = {
    type: 'counter';
    count: number;
    rate: number;
};
export type TrendMetric = {
    type: 'trend';
    'p(95)': number;
    avg: number;
    min: number;
    med: number;
    max: number;
    'p(90)': number;
};
export type AppMetricStats = {
    max: number;
    avg: number;
    min: number;
    count: number;
};
export type AppMetricsReport = {
    heapSizeTotal?: AppMetricStats;
    heapSizeUsed?: AppMetricStats;
    externalMemory?: AppMetricStats;
    eventLoopLag?: AppMetricStats;
};
export type TestReport = {
    runId: string;
    ts: string;
    scenarioName: string;
    tags: K6Tag[];
    metrics: {
        iterations: CounterMetric;
        dataReceived: CounterMetric;
        dataSent: CounterMetric;
        httpRequests: CounterMetric;
        httpRequestDuration: TrendMetric;
        httpRequestSending: TrendMetric;
        httpRequestReceiving: TrendMetric;
        httpRequestWaiting: TrendMetric;
    };
    checks: Check[];
    appMetrics?: AppMetricsReport;
};
export declare function buildAppMetricsReport(metricsData: string[]): AppMetricsReport;
export declare function buildTestReport(scenario: Scenario, endOfTestSummary: K6EndOfTestSummary, tags: K6Tag[], appMetricsData?: string[]): TestReport;