@alertsamurai/worker
v0.0.6
Published
AlertSamurai Worker - Distributed monitoring worker for AlertSamurai
Maintainers
Readme
@alertsamurai/worker
AlertSamurai Worker - Distributed monitoring worker for AlertSamurai.
AlertSamurai is a distributed uptime monitoring service that allows you to monitor your websites and APIs from multiple geographic locations. The service is managed through a Telegram bot @AlertSamuraiBot.
This worker package is a Node.js application that runs on your infrastructure and performs monitoring checks on behalf of the AlertSamurai service. Workers can be deployed in different regions and countries to provide global monitoring coverage.
Features
- Distributed Monitoring: Run workers in multiple locations for comprehensive coverage
- Multiple Check Strategies: HTTP status, response time, content validation(soon), SSL certificate checks
- Easy Deployment: Run via
npxwithout installation, or install globally - Automatic Registration: Workers automatically register with the AlertSamurai service
- Shared Worker Economy: Contribute your workers to earn monitoring balance
Installation
npm install -g @alertsamurai/workerOr use with npx (no installation needed):
npx @alertsamurai/worker --token <your-registration-token>Usage
With npx (recommended)
npx @alertsamurai/worker --token <registration-token> [options]With global installation
alertsamurai-worker --token <registration-token> [options]Options
--token, -t- Worker registration token (required, contains API URL)--help, -h- Show help message
Environment Variables
WORKER_REGISTRATION_TOKEN- Worker registration token (alternative to --token)
Examples
# Basic usage
npx @alertsamurai/worker --token <your-registration-token>
# Using environment variables
WORKER_REGISTRATION_TOKEN=<token> npx @alertsamurai/workerGetting a Registration Token
Get your worker registration token from the AlertSamurai Telegram bot @AlertSamuraiBot using the /worker command.
Learn More
- Telegram Bot: @AlertSamuraiBot
- Start monitoring: Open @AlertSamuraiBot in Telegram and use
/startcommand
License
MIT
