Skip to content

io7m-com/zugorum

Repository files navigation

zugorum

Maven Central Maven Central (snapshot) Codecov Java Version

com.io7m.zugorum

JVM Platform Status
OpenJDK (Temurin) Current Linux Build (OpenJDK (Temurin) Current, Linux)
OpenJDK (Temurin) LTS Linux Build (OpenJDK (Temurin) LTS, Linux)
OpenJDK (Temurin) Current Windows Build (OpenJDK (Temurin) Current, Windows)
OpenJDK (Temurin) LTS Windows Build (OpenJDK (Temurin) LTS, Windows)

zugorum

The zugorum package provides a server for making requests to external sites in order to test liveness, and publishing the results as Prometheus metrics.

Features

  • Check the liveness of external sites and publish Prometheus metrics.
  • A small, easily auditable codebase.
  • Platform independence. No platform-dependent code is included in any form, and installations can largely be carried between platforms without changes.
  • OCI-ready: Ready to run as an immutable, stateless, read-only, unprivileged container for maximum security and reliability.
  • OSGi-ready.
  • JPMS-ready.
  • ISC license.

Usage

{
  "ListenAddress": "0.0.0.0",
  "ListenPort": 8190,
  "Checks": [
    {
      "Type": "HTTP2xx",
      "URI": "https://example.invalid",
      "PauseMinimum": "PT1S",
      "PauseMaximum": "PT10S"
    },
    {
      "Type": "HTTP2xx",
      "URI": "https://www.io7m.com",
      "PauseMinimum": "PT1S",
      "PauseMaximum": "PT10S"
    },
    {
      "Type": "HTTP2xx",
      "URI": "http://www.io7m.com",
      "PauseMinimum": "PT1S",
      "PauseMaximum": "PT10S"
    },
    ...
}
$ zugorum server --configuration config.json

Prometheus metrics will be available on port 8190.

About

Liveness checker

Resources

License

Stars

Watchers

Forks

Contributors

Languages