Monitor business flows (metrics, server keys and health)
Reference for Monitoring in Releaseo. What the health card and metrics mean, how server keys work and rotate, and how flow alerts are routed.
Monitoring lets you follow multi-step processes that your own backend reports on, such as signup, checkout or onboarding. Your server sends one event per step, and Releaseo shows how many runs start, how many finish, and where they fail. In the dashboard, open Monitoring in the sidebar. Each process you track is called a monitor.
This article is a reference for reading the numbers and managing the credentials. To create your first monitor, select New monitor on the Monitoring page, then pick a template in Create a monitor or start blank. Templates include Signup, Checkout & payment, Onboarding provisioning, Password reset, Subscription change and Data import. A monitor can have up to 20 steps.
How events reach Releaseo
Each event your backend sends has a few parts:
flow: the monitor's ID, shown in the examples on the monitor page.
ref: your own ID for one run, for example an order or request ID. Reuse the same ref for every step of that run.
step: the step key.
status:
success,failureorpending.
Use pending when a step has been reached but its final result is not known yet. It counts as reached, not completed or failed, and it sends no alert. Send the same ref and step again with success or failure when it resolves.
Events go from your server, never from a browser or mobile app, because they are authenticated with a server key.
Server keys
Monitoring uses the Server project key, which is separate from the key your widget uses.
To create or replace it:
Open Settings > Environment.
Find the Server project key group.
Select Generate server key if none exists. Select Rotate key to replace the current one.
The key is masked on screen. Use the copy button to copy the full value, and keep it out of browser and mobile code. You need permission to update the project to generate or rotate it.
Rotating disables the previous key immediately. Every backend integration using the old key stops until you deploy the new one. Releaseo asks you to confirm with "Rotate the server key?" before it goes ahead.
On a monitor's page, the Connect your backend card shows ready-to-copy examples. Choose a language in Language & client: cURL, Node.js with Fetch, Node.js with Axios, Elixir with Req, .NET with HttpClient, or PHP with cURL. It also has a Manage in Environment settings button. Generating and rotating happen only in Settings > Environment.
Read the health card
The top of the Overview tab shows an operational status for the last 7 days, with these totals: Runs, Completion and Failed steps.
Status | What it means |
|---|---|
Healthy | Runs were reported with no failed step events in the last 7 days. |
Needs attention | One or more failed step events were reported. Select Review failed runs. |
Setup required | No server key is ready. Select Manage server key. |
No activity | No runs were reported in the last 7 days, and your server key is ready. |
Data delayed | Totals are temporarily unavailable. Retry the step metrics. |
Archived | Events, failures and alerts are paused until you unarchive the monitor. |
"No activity" only describes the last 7 days. It does not mean the monitor never received events.
Metric definitions
On the Analytics tab, choose 24h, 7d or 30d, then switch between four metrics:
Started: runs that had at least one event in the period.
Completed: runs where the final step succeeded.
Completion rate: completed divided by started. It shows a dash when nothing started.
Failures: failed step events, including retries.
A run can appear on several days, so daily counts do not add up to the period total. The Overview tab always shows the last 7 days and does not follow the Analytics period.
The Runs tab lists individual runs. Filter by All runs, Success only or Failures only, and search by ref. Select a run to see its timeline, error text and any metadata you attached.
Alerts
The Alert routing card on the Overview tab sends production events to Slack or Discord:
Monitor step failed is on for every step by default. It sends at most one message every 15 minutes per step. You can mute a step with its Alert on failure switch when you edit the monitor.
Monitor run completed is off until you turn on Send an alert when a run completes. It fires for every completed run, so use it only on monitors you want that detail for.
Each row shows a status such as Set up or Off. Select a row to choose destinations and customize the message. Metadata you attach to events is shown in Releaseo but is not sent to Slack or Discord.
Event data is kept for 90 days.
Troubleshooting
The monitor shows Setup required. Generate a server key under Settings > Environment.
Events stopped arriving after a rotation. Your backend is still using the old key. Update it with the new one.
Totals show a dash. Stats are temporarily unavailable. Retry from the Overview tab.
Was this article helpful?
Still stuck? Contact us and mention this article.