Karma

services.karma.configFile

A YAML config file which can be used to configure karma instead of the nix-generated file.

Type: path

Default

"A configuration file generated from the provided nix attributes settings option."

Example

"/etc/karma/karma.conf"

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

services.karma.enable

Whether to enable the Karma dashboard service. Type: boolean

Default

false

Example

true

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

services.karma.environment

Additional environment variables to provide to karma.

Type: attribute set of string

Default

{ }

Example

{ALERTMANAGER_NAME = "single";ALERTMANAGER_URI = "https://alertmanager.example.com";}

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

services.karma.extraOptions

Extra command line options.

Type: list of string

Default

[ ]

Example

["--alertmanager.timeout 10s"]

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

services.karma.openFirewall

Whether to open ports in the firewall needed for karma to function.

Type: boolean

Default

false

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

services.karma.package

The karma package to use. Type: package

Default

pkgs.karma

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

services.karma.settings

Karma dashboard configuration as nix attributes.

Reference: https://github.com/prymitive/karma/blob/main/docs/CONFIGURATION.md

Type: YAML value

Default

{listen = {address = "127.0.0.1";};}

Example

{alertmanager = {interval = "15s";servers = [{name = "prod";uri = "http://alertmanager.example.com";}];};listen = {address = "192.168.1.4";port = "8000";prefix = "/dashboard";};}

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

services.karma.settings.listen.address

Hostname or IP to listen on.

Type: string

Default

"127.0.0.1"

Example

"[::]"

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

services.karma.settings.listen.port

HTTP port to listen on.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

8080

Example

8182

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