Development build — sample configuration

Check platform health

See at a glance whether the service is running well for every water utility, which utilities need attention and what the platform metrics mean.

The platform team checks the health of the service in two places: the platform Home, which shows the state of the system, the utilities and the services behind them, and the Metrics screen, which lists the current indicators and what each one measures.

Before you start#

  • You need access to the platform dashboard. The Metrics screen only appears if your role can read metrics.
  • Health figures only mean something once at least one utility is registered and using the service.

Step 1: Read the system state on Home#

  1. In the platform menu, open Home.
  2. In the System card, read Status. It shows Operational, Service degraded, Under maintenance, Implementation in progress or Unknown. The card also shows Version, Currency and Time zone.
  3. Unknown means the status could not be read. It does not mean everything is fine.

Step 2: Check the services behind the platform#

  1. On Home, find Fleet and services.
  2. Look at Jobs queued and Failed jobs. These are tasks the system runs on its own, such as billing cycles.
  3. Look at Registered collectors, Collectors online and Collectors needing attention. Collectors bring in readings from smart meters.
  4. Look at Connectors online, Connectors not responding and Active messaging channels. Connectors are what the platform uses to send messages and take payments.
  5. Click a figure that needs attention to open the matching list.

Step 3: Find utilities that need attention#

  1. On Home, the utilities table has a Health column.
  2. Each utility shows Healthy, Needs attention, At risk, Onboarding or Cancelled.
  3. Open a utility marked Needs attention or At risk to see its subscription, invoices and activity.

Step 4: Read the metrics#

  1. In the platform menu, open Metrics.
  2. Current indicators shows figures such as Active utilities.
  3. Metric definitions lists every metric with its Code, Metric name and Category. Click one to read its Description and Dataset.
  4. Click Export to download the list.

What happens next#

When a service shows a problem, follow it to its own screen: failed jobs in Background jobs, collectors in Collectors, connectors in Message connectors. Fix the cause there, then come back to Home to confirm the figure has gone back to normal.

Common problems#

  • Could not load platform metrics. The metrics could not be read. Reload the page. If it keeps failing, check Background jobs and the system status.
  • No metric definitions yet. No metrics have been registered on the platform yet. They appear here once they are.
  • Everything shows zero. No utility is active yet. Register one first.

Start today. Set up your utility in minutes.