Healthchecks Options

healthchecks.defaultInterval

Default interval for automatic healthcheck runs in seconds. Set to null to disable automatic checks.

healthchecks.defaultTimeout

Default timeout for healthchecks in seconds

healthchecks.enable

Enable the healthchecks system

healthchecks.modules

Healthchecks organized by module.

Each module can declare multiple healthchecks that verify its functionality. The UI displays a traffic light for each module based on the aggregate status of its healthchecks.

Example:

{
  go = {
    displayName = "Go";
    checks = {
      # Inline script
      go-installed = {
        script = "command -v go >/dev/null 2>&1";
        severity = "critical";
      };
    };
  };

  postgres = {
    displayName = "PostgreSQL";
    checks = {
      # TCP check
      running = {
        type = "tcp";
        tcpHost = "localhost";
        tcpPort = 5432;
        severity = "critical";
      };
      # Path to script file
      has-tables = {
        path = ./.stack/src/checks/postgres/has-tables.sh;
        severity = "warning";
      };
    };
  };

  # Extension module
  sst = {
    displayName = "SST";
    checks = {
      configured = {
        path = ./src/checks/configured.sh;
        severity = "critical";
      };
    };
  };
}

healthchecks.modules.<name>.checks

Healthchecks for this module

healthchecks.modules.<name>.checks.<name>.description

Description of what this check verifies

healthchecks.modules.<name>.checks.<name>.enable

Whether this healthcheck is enabled

healthchecks.modules.<name>.checks.<name>.httpExpectedStatus

Expected HTTP status code for a healthy response

healthchecks.modules.<name>.checks.<name>.httpMethod

HTTP method to use for http-type checks

healthchecks.modules.<name>.checks.<name>.httpUrl

URL to check for http-type checks

Example:

"http://localhost:3000/health"

healthchecks.modules.<name>.checks.<name>.interval

How often to run this check in seconds. If null, check runs only on demand.

healthchecks.modules.<name>.checks.<name>.name

Display name for the healthcheck

healthchecks.modules.<name>.checks.<name>.nixExpr

Nix expression to evaluate for nix-type checks. Should evaluate to true for healthy, false for unhealthy.

Example:

"builtins.pathExists /nix/store"

healthchecks.modules.<name>.checks.<name>.path

Path to script file for script-type checks. Content is read and used as the script body. Mutually exclusive with script and scriptRef.

Example:

./.stack/src/checks/postgres/can-connect.sh

healthchecks.modules.<name>.checks.<name>.script

Shell script content for script-type checks (inline). Should exit 0 for healthy, non-zero for unhealthy. Mutually exclusive with path and scriptRef.

Example:

"command -v go >/dev/null 2>&1"

healthchecks.modules.<name>.checks.<name>.scriptPackage

A derivation that provides the healthcheck script. The script should be at $out/bin/ or $out.

healthchecks.modules.<name>.checks.<name>.scriptRef

Reference to a stackpanel.scripts.* entry. The referenced script is used as the healthcheck command. Mutually exclusive with script and path.

Example:

"db-connect"

healthchecks.modules.<name>.checks.<name>.severity

How critical this check is:

healthchecks.modules.<name>.checks.<name>.tags

Tags for filtering/grouping checks

Example:

[
  "database"
  "critical"
]

healthchecks.modules.<name>.checks.<name>.tcpHost

Host to connect to for tcp-type checks

Example:

"localhost"

healthchecks.modules.<name>.checks.<name>.tcpPort

Port to connect to for tcp-type checks

Example:

5432

healthchecks.modules.<name>.checks.<name>.timeout

Timeout for the check in seconds

healthchecks.modules.<name>.checks.<name>.type

Type of healthcheck (script, nix, http, tcp)

healthchecks.modules.<name>.displayName

Display name for the module in the UI

healthchecks.modules.<name>.enable

Enable healthchecks for this module

healthchecksComputed

Computed healthcheck configurations (for agent API)

healthchecksList

Flat list of all healthchecks (for agent API)