← Back to Plugins
Monitoring

healthcheck

Vince Ultari By Vince Ultari 👁 4 views ▲ 0 votes

Uptime monitoring and health check plugin for OpenClaw. Monitor websites, APIs, and services with configurable intervals and get alerts through any connected channel when services go down or recover.

Homepage GitHub

Install

openclaw plugins install @vinceultari-ctrl/openclaw-plugin-healthcheck

Configuration Example

{
  "plugins": {
    "healthcheck": {
      "defaultInterval": 300,
      "defaultTimeout": 10000,
      "maxTargets": 50,
      "alertOnRecovery": true,
      "consecutiveFailures": 2,
      "dataDir": ".healthcheck"
    }
  }
}

README

# openclaw-plugin-healthcheck

Uptime monitoring and health check plugin for [OpenClaw](https://openclaw.ai). Monitor websites, APIs, and services with configurable intervals and get alerts through any connected channel when services go down or recover.

## Features

- **Add/remove targets** — monitor any URL with custom HTTP methods, expected status codes, and response body validation
- **Automatic scheduling** — configurable check intervals per target (minimum 30s)
- **Alerting** — automatic notifications when services go down or recover, delivered through your connected OpenClaw channels (WhatsApp, Telegram, Slack, Discord, etc.)
- **Dashboard view** — see all targets at a glance with status, uptime percentage, and response times
- **Check history** — rolling history of the last 100 checks per target with uptime calculation
- **On-demand checks** — instantly check any URL or monitored target without waiting for the scheduler
- **Pause/resume** — temporarily disable monitoring without losing configuration
- **Tags** — organize and filter targets by custom tags
- **Persistent state** — monitor state survives restarts via local JSON storage

## Installation

```bash
openclaw plugins install clawhub:@vinceultari/openclaw-plugin-healthcheck
```

## Configuration

Add to your OpenClaw config:

```json
{
  "plugins": {
    "healthcheck": {
      "defaultInterval": 300,
      "defaultTimeout": 10000,
      "maxTargets": 50,
      "alertOnRecovery": true,
      "consecutiveFailures": 2,
      "dataDir": ".healthcheck"
    }
  }
}
```

| Option | Default | Description |
|--------|---------|-------------|
| `defaultInterval` | `300` | Default check interval in seconds (min 30) |
| `defaultTimeout` | `10000` | Default HTTP request timeout in ms |
| `maxTargets` | `50` | Maximum monitored targets |
| `alertOnRecovery` | `true` | Alert when a service comes back up |
| `consecutiveFailures` | `2` | Failures before triggering a down alert |
| `dataDir` | `.healthcheck` | Directory for persistent state |

## Tools

### `healthcheck_add`
Add a new URL to monitor.

**Parameters:**
- `url` (required) — URL to monitor
- `name` — Human-readable name (defaults to hostname)
- `method` — HTTP method: GET, POST, HEAD, OPTIONS (default: GET)
- `interval` — Check interval in seconds (min 30)
- `timeout` — Request timeout in ms
- `expectedStatus` — Expected HTTP status code (default: 200)
- `expectedBody` — String that must appear in response body
- `tags` — Array of tags for filtering

### `healthcheck_remove`
Remove a target by ID.

### `healthcheck_check`
Run an immediate check on a monitored target (by ID) or any arbitrary URL.

### `healthcheck_list`
Display a dashboard of all monitored targets with status, uptime, and response times. Optionally filter by tag.

### `healthcheck_pause` / `healthcheck_resume`
Pause or resume monitoring for a target without removing it.

### `healthcheck_history`
View recent check history for a target (default: last 10 checks).

## Usage Examples

**"Monitor my API"**
> "Add https://api.myapp.com/health to health monitoring with 60 second intervals"

**"Check if a site is up"**
> "Check if https://example.com is responding"

**"Show me the dashboard"**
> "Show me the health check dashboard"

**"See what went wrong"**
> "Show me the check history for my API target"

## Development

```bash
git clone https://github.com/VinceUltari/openclaw-plugin-healthcheck.git
cd openclaw-plugin-healthcheck
npm install
npm run build
```

## License

MIT
monitoring uptime . healthcheck alerts status

Comments

Sign in to leave a comment

Loading comments...