Skip to content

[Web service] program health report

Howard edited this page Jan 28, 2020 · 4 revisions

Introduction

Hosted by laitos web server, the text report is generated on-demand to show:

  • System status:
    • Clock time, uptime.
    • Load and memory usage.
  • Program status:
    • Public IP address, uptime.
    • Daemon usage statistics.
  • Latest log entries and stack traces.

Configuration

Under JSON key HTTPHandlers, write a string property called InformationEndpoint, value being the URL location that will serve the report. Keep the location a secret to yourself and make it difficult to guess.

Here is an example setup:

{
    ...

    "HTTPHandlers": {
        ...

        "InformationEndpoint": "/very-secret-program-health-report",

        ...
    },

    ...
}

Run

The report is hosted by web server, therefore remember to run web server.

Usage

In a web browser, navigate to InformationEndpoint of laitos web server, and inspect the produced health report.

Tips

Make the URL location secure and hard to guess, it is the only way to secure this web service!

Clone this wiki locally