proactive-deps
    Preparing search index...

    Type Alias DependencyMonitorOptions

    Configuration options for the DependencyMonitor. For information on how cache duration and refresh threshold work together, see cache-manager

    // monitor with default options
    const monitor = new DependencyMonitor();

    // monitor with custom options
    const options: DependencyMonitorOptions = {
      cacheDurationMs: 30000, // override cache duration of 30 seconds
      refreshThresholdMs: 2000, // override refresh threshold of 2 seconds
      checkIntervalMs: 10000, // override check interval of 10 seconds
    };
    const monitor = new DependencyMonitor(options);

    monitor.startDependencyCheckInterval();
    type DependencyMonitorOptions = {
        cacheDurationMs?: number;
        checkIntervalMs?: number;
        collectDefaultMetrics?: boolean;
        refreshThresholdMs?: number;
        registry?: Registry;
    }
    Index

    Properties

    cacheDurationMs? checkIntervalMs? collectDefaultMetrics? refreshThresholdMs? registry?

    Properties

    cacheDurationMs?: number

    Optional cache duration in milliseconds.

    60000
    checkIntervalMs?: number

    Optional interval for running dependency checks in milliseconds.

    15000
    collectDefaultMetrics?: boolean

    When true and a new Registry is created internally, default process metrics will also be collected.

    refreshThresholdMs?: number

    Optional refresh threshold in milliseconds.

    5000
    registry?: Registry

    Optional existing prom-client Registry instance to register metrics with. If omitted a new Registry is created.

    Settings

    Member Visibility

    On This Page

    Properties