obzervo-agent

Lightweight CLI monitoring agent for Obzervo API Observability Platform. Monitors private, local, or VPC endpoints and pushes health metrics to your Obzervo dashboard using API keys.

Install

npm install -g obzervo-agent

Usage

Option 1: CLI flags

obzervo monitor \
  --endpointId "YOUR_24_CHAR_ENDPOINT_ID" \
  --targetUrl "http://localhost:3000/health" \
  --key "obz_live_YOUR_API_KEY" \
  --method GET \
  --expectedStatus 200 \
  --interval 10000

Option 2: Config file

Create an obzervo.json in your project root:

{
  "endpointId": "YOUR_ENDPOINT_ID",
  "targetUrl": "http://localhost:3000/health",
  "apiKey": "obz_live_YOUR_API_KEY",
  "serverUrl": "http://localhost:5000",
  "interval": 10000
}

Then run:

obzervo monitor

How it works

1. The agent sends an HTTP request to your targetUrl at the configured interval.
2. It records the response status code, latency (ms), and payload size.
3. It pushes that data to your Obzervo server via POST /api/v1/telemetry/push using the x-api-key header.
4. Your Obzervo dashboard updates in real time over WebSockets.

CLI Options

| Flag | Default | Description | |---|---|---| | --endpointId | (required) | The Obzervo endpoint ID to report against | | --targetUrl | (required) | The URL to monitor | | --key | (required) | Your Obzervo API key (obz_live_...) | | --method | GET | HTTP method for the health check | | --expectedStatus | 200 | Expected healthy status code | | --interval | 10000 | Polling interval in milliseconds | | --serverUrl | http://localhost:5000 | Obzervo server base URL |

Security

• API keys are sent via the x-api-key HTTP header, never in query strings or URLs.
• The Obzervo server validates keys by comparing SHA-256 hashes and verifies endpoint ownership before accepting data.