Run Your First Monitoring Check

This guide helps you run your first monitoring cycle. Before you start, complete the Installation steps. For detailed configuration options, see the Configuration guide.

1. Create Your First Project

Initialize a monitoring project:

php artisan uplinkr:project:init --project=my-project

This creates a project named my-project where you can organize related probes.

2. Add a Probe

Add a URL probe:

php artisan uplinkr:project:add:probe \
  --project=my-project \
  --url=https://example.com

This adds a basic GET probe for https://example.com.

3. Configure Alerts (Optional)

Set alert rules for your project:

php artisan uplinkr:project:alerts \
  --project=my-project \
  --failures=3 \
  --cooldown=30 \
  --threshold=2000 \
  --slow=5 \
  --channels=mail,log

This triggers alerts after 3 consecutive failures or 5 slow responses (>2000ms), with a 30-minute cooldown.

4. Run Your First Probe

Run all probes for your project:

php artisan uplinkr:project:run-probes --force

The --force flag skips the confirmation prompt. Uplinkr checks the URLs and stores results as JSON files.

What’s Next?

Configure Alerts: Set up email, webhook, or log notifications when probes fail
Schedule Automatic Probes: Enable scheduler integration in the Installation guide
Explore Commands: See all available commands in the Commands Overview
Customize Configuration: Fine-tune storage, latency thresholds, and notification settings

You’re all set! Uplinkr is now monitoring your URLs and storing the results.