loadmill-monitor/index.d.ts

Performance monitoring for Node.js

export = LoadmillMonitor;

declare const LoadmillMonitor: {
    /**
     * Start Loadmill monitor according to given options.
     */
    (options: LoadmillMonitorOptions): void
};

type LoadmillMonitorOptions = {
    /**
     * Personal Loadmill access token.
     */
    apiToken: string

    /**
     * The node process's associated (case insensitive) environment name (e.g. `Staging`, `Test`, `My_MacBook`, etc.).
     * In general, Loadmill will monitor a single environment per load test.
     *
     * May contain (only) alphanumeric characters, `-` and `_`.
     * Default: `default_env`.
     */
    envName?: string;

    /**
     * The node process's associated (case insensitive) app / component / micro-service name
     * (e.g. `web_app`, `billing_service`, `scheduler`, etc.).
     *
     * The app name is used to group together processes of the same "kind" and
     * aggregate their performance metrics.
     *
     * May contain (only) alphanumeric characters, `-` and `_`.
     * Default: `default_app`.
     */
    appName?: string;
};