Skip to content

Below

services.below.cgroupFilterOut

A regexp matching the full paths of cgroups whose data shouldn't be collected Type: null or string

Default

null

Example

"user.slice.*"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix

services.below.collect.diskStats

Whether to enable dist_stat collection. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix

services.below.collect.exitStats

Whether to enable eBPF-based exitstats. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix

services.below.collect.ioStats

Whether to enable io.stat collection for cgroups. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix

services.below.compression.enable

Whether to enable data compression. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix

services.below.dirs.log

Where to store below's logs Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix

services.below.dirs.store

Where to store below's data Type: null or path

Default

null

Example

"/var/lib/below"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix

services.below.enable

Whether to enable 'below' resource monitor. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix

services.below.retention.size

Size limit for below's data, in bytes. Data is deleted oldest-first, in 24h 'shards'.

::: {.note} The size limit may be exceeded by at most the size of the active shard, as: - the active shard cannot be deleted; - the size limit is only enforced when a new shard is created. :::

Type: null or signed integer

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix

services.below.retention.time

Retention time, in seconds.

::: {.note} As data is stored in 24 hour shards which are discarded as a whole, only data expired by 24h (or more) is guaranteed to be discarded. :::

::: {.note} If retention.size is set, data may be discarded earlier than the specified time. :::

Type: null or signed integer

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/below.nix