Healthcheck for binary agent

[Rumpick]

Description

I have the agent binary running on a raspberry pi and I want to add a check into Uptime Kuma. If I curl raspi:45876, I get "Received HTTP/0.9 when not allowed", so the agent seems to have an open port, but how do I do any sort of health check on that?

OS / Architecture

Linux/Received HTTP/0.9 when not allowed

Beszel version

0.17.0

Installation method

Binary

Configuration

No response

Hub Logs

No response

Agent Logs

No response

[kuya1284]

I was looking for a solution to handle this as well. I thought that Heartbeat Monitoring was the answer, but unfortunately after painstaking hours of testing, I discovered the feature was only limited to the Beszel Hub and cannot be used with Agents. I was going to leverage Uptime Kuma's Push monitoring type, but that unfortunately won't work with Agents.

So the solution I came up with was to leverage the PocketBase Rest API. Here are the steps to get this to work:

1. Navigate to Admin > Users, then log in to PocketBase
2. In PocketBase, navigate to Collections > System > _superusers
3. Click your admin user, then click the kabob menu, then Impersonate.
4. Click Generate Token and save the token in a safe place. If you don't want to token to expire, I believe you can set the Token Duration to 0, but I have yet to confirm. Be sure to read about the security implications.
5. Navigate to Collections > Systems, then copy the ID of your Binary Agent
6. Create a new monitor in Uptime Kuma, then fill in the following fields:

• Monitor Type: HTTP(s) - Keyword
• Friendly Name: [Agent Name]
• URL: [http|https]://[IP]:8090//api/collections/systems/records/[Binary Agent ID]?fields=status
• Keyword: up
• Headers:

{
    "Authorization": "[Generated Token]"
}

Do not use the Authentication field because the header must not be prefixed with a specific type, like Bearer. You must set the custom header instead of using Uptime Kuma's Authentication method.

Feel free to customize the header as needed, but the fields mentioned above should be all you need for each of your Binary Agents.

For the URL, if you're using a reverse proxy, you can/should omit the port (8090), and replace [IP] with your FQDN.

I hope this helps.

EDIT: I'll report back if setting the Token Duration to 0 doesn't work by causing the token to expire after a specific time. According to the docs, it states:

If not set or 0, it fallbacks to the default collection auth token duration option.

But in the doc's API keys section it also states this, which makes things a little confusing:

While PocketBase doesn't have "API keys" in the traditional sense, as a side effect of the support for users impersonation, for such cases you can use instead the generated nonrenewable _superusers impersonate auth token.

[kuya1284]

It looks like the impersonate token expires after 24 hours when setting the Token Duration to 0. The only workaround would be to set the duration to a high value. For example:

• 2 months: 5256000
• 6 months: 15768000
• 1 year: 31536000
• 2 years: 63072000

If you save the token to a password manager, you could add two fields:

• A creation date field
• An expiration date field