Monitoring

Healthchecks

Liveness check

The liveness check is available on the /alive route of the pekko management port (7626 by default).

It checks that the pekko cluster is operational and performs a ping on the mongo database.

Readiness check

The readiness check is available on the /ready route of the pekko management port (7626 by default).

It checks that the pekko cluster is operational and verifies that the instance has been bootstrapped.

For RPM configuration, this check is proxied by the default NGINX configuration, and available on /ready

Metrics

Basic

To enable basic prometheus metrics on port 9095, the following configuration must be applied.

kamon {
  modules {
    prometheus-reporter.enabled = yes
    apm-reporter.enabled = no
    host-metrics.enabled = no
    jvm-metrics.enabled = no
  }

  prometheus {
    include-environment-tags = true
    embedded-server {
      hostname = 0.0.0.0
      port = 9095
    }
  }
}

Horizon

Horizon specific metrics can also be exposed on the prometheus endpoint using this configuration parameter:

horizon.metrics.enabled = true

These metrics include:

License expiration information
License usage information
Horizon version
Scala version
PKI Queue size
PKI Connector status
Credentials expiration
Last user activity

Additional metrics configuration such as refresh intervals can be found on the configuration reference page.