Welcome

A type-safe TypeScript library for application monitoring with automatic heartbeat functionality. Part of the UptimeBeacon.cloud  monitoring platform.

Overview

Sentinel Guard provides a simple yet powerful way to monitor your applications and services. With just a few lines of code, you can set up automatic heartbeat monitoring, performance tracking, and error detection that integrates seamlessly with UptimeBeacon.cloud.

Key Features

• Automatic Heartbeats: Regular status updates with configurable intervals
• Type Safety: Fully typed API with comprehensive TypeScript support
• Performance Monitoring: Database latency tracking for Prisma and Redis
• Error Handling: Intelligent error tracking and retry logic
• Graceful Shutdown: Clean resource management and proper cleanup
• Simple Integration: Get started in minutes with minimal configuration

Why Sentinel Guard?

Modern applications require reliable monitoring to ensure uptime and performance. Sentinel Guard eliminates the complexity of setting up monitoring infrastructure by providing:

• Zero Configuration Monitoring: Start monitoring with just your API credentials
• Real-time Insights: Live data streaming to your UptimeBeacon dashboard
• Intelligent Alerting: Automatic detection of issues and performance degradation
• Scalable Architecture: Built to handle applications of any size

Quick Example

import { SentinelGuard } from "@uptimebeacon/sentinel-guard";
 
const sentinel = new SentinelGuard({
	apiKey: process.env.SENTINEL_API_KEY!,
	baseUrl: process.env.SENTINEL_API_URL!,
	monitorApiKey: process.env.SENTINEL_MONITOR_API_KEY!,
});
 
// Start automatic monitoring
sentinel.startMonitoring({
	interval: 30000, // Every 30 seconds
	maxConsecutiveErrors: 5,
});
 
console.log("Monitoring started");