Monitoring an Offen instance

Instance health

If you want to make sure your Offen instance is always up and running by monitoring it - either yourself, or using a service such as Pingdom or similar - you can use the /healthz/ endpoint that should always respond with a 200 status code:

$ curl -I https://offen.yoursite.org/healthz
HTTP/2 200 
cache-control: no-store
content-type: application/json; charset=utf-8
vary: Accept-Encoding
content-length: 11
date: Tue, 30 Jun 2020 06:33:59 GMT

and a payload like this:

$ curl -X GET https://offen.yoursite.org/healthz
{"ok":true}

Log output

Offen logs all HTTP requests to stdout using the Common Log Format. Fields that contain privacy sensitive data (IPs, User-Agent Strings, Referrers) are left blank intentionally.

Heads Up

Also, all successful status codes (i.e. 200-399) will appear as 200 as caching behavior could also leak information about users. This also means the body size is stripped.


All non-access log lines will be printed to stderr.