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/DEB configuration, this check is proxied by the default NGINX configuration, and available on /ready

Metrics

Stream can expose Prometheus metrics to monitor key KPIs and health infos about the instance.

Enabling metrics

  • RPM

  • Debian

  • Kubernetes

To enable basic Prometheus metrics on port 9095, the following configuration must be applied (following this guide):

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
    }
  }
}

stream {
  metrics.enabled = true
}

To enable basic Prometheus metrics on port 9095, the following configuration must be applied (following this guide):

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
    }
  }
}

stream {
  metrics.enabled = true
}

To enable metrics on port 9095, add the following to your values.yaml file:

metrics:
  enabled: true
  port: 9095

Exposed metrics

Exposed metrics are basic clustering metrics, and Stream-specific metrics such as:

  • License expiration information

  • Stream version

  • Scala version

  • CRL expiration

  • CRL generation

  • Signer (CA/TSA/OCSP) expiration

  • Keystore status

  • Credentials expiration

  • Last user activity

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