Preview only. This is on the preview channel and is not in the stable release. It can change or be dropped before it lands there.
Set it up
1
Create a heartbeat monitor in Sentivel
Sign in to Sentivel (it’s free to start), open Monitors, click Add a monitor, and choose Heartbeat.
2
Pick an interval
Expected interval is how often Sentivel expects a ping, and Grace period is the extra time it allows before counting the script as down. Rayfield pings every five minutes, so keep the defaults of Every 5 minutes and 1 minute, or go longer. See Quiet scripts before you settle on it.
3
Copy the ping URL
Sentivel gives the monitor a ping URL of the form
https://www.sentivel.com/api/heartbeat/<token>. Copy the whole URL. Rayfield needs this link, not the monitor’s ID.4
Add it to your window
Pass the URL as
heartbeat when you create the window.Quiet scripts
A heartbeat can’t tell the difference between a script that broke and a script that nobody has open. When no one is running your script, the pings stop just as they would after a failure. Set the interval to match your traffic:- Someone almost always has it open: Every 5 minutes. You find out about problems within minutes.
- It has quiet stretches: set the interval to the longest you would expect to go with nobody running it, such as Every 6 hours for a quiet night. You’ll hear about a problem more slowly, but a quiet night won’t show as an outage.
What to expect
- Pings last as long as the window. You get one ping when the window opens, then one every five minutes. They stop when you call
window:Unload()or the window is destroyed. - Studio is skipped. Playtests aren’t real runs, so no ping is sent there. The link is still checked, so a typo shows up while you are building.
- A bad link warns. If the link isn’t a Sentivel ping URL, Rayfield prints a warning saying what to paste instead and sends nothing. The full URL and the bare token both work, and stray spaces from a paste are fine.
- An unknown heartbeat stops. If Sentivel keeps saying the heartbeat doesn’t exist, for example because you deleted the monitor or regenerated its URL, Rayfield prints a warning and stops pinging.
- Only Sentivel.
heartbeatrefuses any other host, so it can’t be used to make other requests. - No HTTP, no pings. If the executor has no way to send requests, Rayfield warns once and sends nothing.
Secure mode silences Rayfield’s console output, including these warnings. Before you ship, run the script once without secure mode and check that the monitor’s page says First ping received.
Can someone fake my pings?
Can someone fake my pings?
The ping URL ships inside your script, so anyone who reads the script can use it. Treat the monitor as a signal that people are running your script, not as proof. If the URL is being misused, click Regenerate next to it on the monitor’s page and ship the new one.
Reference
string
A window property. The monitor’s ping URL, or just its token. Optional.
Sentivel monitors
Monitor types, thresholds, and maintenance.