Type Alias MetricsCollectorSettings

type MetricsCollectorSettings = {
    baseScrapeIntervalSeconds: number;
    dataRetentionCheckIntervalMinutes: number;
    enabled: boolean;
    localDatabaseFileLocation?: string;
    localDataRetentionDays: number;
    port: number;
}
Index

Properties

baseScrapeIntervalSeconds dataRetentionCheckIntervalMinutes enabled localDatabaseFileLocation? localDataRetentionDays port

Properties

baseScrapeIntervalSeconds: number

The base interval in seconds for the metrics collection loop. This defines how frequently the collector checks whether to scrape each connector, not the interval at which each connector is scraped. Must be equal to or less than the lowest individual connector scrape interval.

dataRetentionCheckIntervalMinutes: number

The interval in minutes the metrics collector checks for and deletes old data.

enabled: boolean

Indicates whether the metrics collector is enabled.

localDatabaseFileLocation?: string

The file location for the local metrics database. If not specified, defaults to C:\ProgramData\Qlik\Gateway\tmp.

localDataRetentionDays: number

The number of days to retain local data.

port: number

The port number that the metrics collector API will run on. This must match the port that the SYSTEM connector runs on to enable network metrics collection.

Settings

Member Visibility

On This Page

Properties