Skip to content

Mackerel agent

services.mackerel-agent.apiKeyFile

Path to file containing the Mackerel API key. The file should contain a single line of the following form:

apikey = "EXAMPLE_API_KEY"

Type: path

Example

"/run/keys/mackerel-api-key"

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

services.mackerel-agent.autoRetirement

Whether to enable retiring the host upon OS shutdown . Type: boolean

Default

false

Example

true

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

services.mackerel-agent.enable

Whether to enable mackerel.io agent. Type: boolean

Default

false

Example

true

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

services.mackerel-agent.runAsRoot

Whether to enable running as root. Type: boolean

Default

false

Example

true

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

services.mackerel-agent.settings

Options for mackerel-agent.conf.

Documentation: https://mackerel.io/docs/entry/spec/agent

Type: TOML value

Default

{ }

Example

{silent = false;verbose = false;}

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

services.mackerel-agent.settings.diagnostic

Whether to enable collecting memory usage for the agent itself. Type: boolean

Default

false

Example

true

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

services.mackerel-agent.settings.host_status.on_start

Host status after agent startup. Type: one of "working", "standby", "maintenance", "poweroff"

Default

"working"

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

services.mackerel-agent.settings.host_status.on_stop

Host status after agent shutdown. Type: one of "working", "standby", "maintenance", "poweroff"

Default

"poweroff"

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