Monitoring & Alerts
Configure alerts and monitoring for API usage, budget thresholds, Apify runs, and data quality.
Endpoints
Get Monitoring Dashboard
GET /api/monitoring/dashboard
Get Active Alerts
GET /api/monitoring/alerts
Create Alert Rule
POST /api/monitoring/alerts/rules
Resolve Alert
PATCH /api/monitoring/alerts/{alertId}/resolve
Get Apify Usage
GET /api/monitoring/apify/usage
Monitoring Dashboard
Response
Indicates if the request was successful
Average response time (ms)
Usage breakdown by platform
Current usage metrics (compute units, storage, etc.)
Monthly, daily, and projected costs
Budgets at >80% utilization
Database, cache, and service health metrics
Active Alerts
Request
Filter by alert type: BUDGET, API, APIFY, DATA_QUALITY, PERFORMANCE
Filter by severity: LOW, MEDIUM, HIGH, CRITICAL
Response
Array of alert objects
ISO 8601 timestamp (if resolved)
Alert summary counts by type and severity
Create Alert Rule
Request
Alert type: BUDGET, API, APIFY, DATA_QUALITY, PERFORMANCE
Alert trigger conditions
// Budget threshold
{
"budgetId": "budget_123",
"threshold": 80,
"metric": "spentPercentage"
}
// API error rate
{
"platform": "OpenAI",
"threshold": 5,
"metric": "errorRate"
}
// Apify compute units
{
"threshold": 90,
"metric": "computeUtilization"
}
Notification configuration
Email addresses to notify
Webhook URL for notifications
Whether the rule is enabled
Apify Usage
Monitor Apify account usage and costs.
Response
Implemented by ApifyMonitoringService in /lib/services/apify-monitoring-service.ts:109-310:
Compute units: current, limit, utilization
Storage: current, limit, utilization
Dataset operations: current, limit, utilization
Proxy requests: current, limit, utilization
Examples
Get Monitoring Dashboard
TypeScript
JavaScript
cURL
async function getMonitoringDashboard() {
const response = await fetch(
'https://your-domain.com/api/monitoring/dashboard',
{
headers: {
'Authorization': `Bearer ${process.env.API_KEY}`
}
}
);
const { data } = await response.json();
return data;
}
const dashboard = await getMonitoringDashboard();
console.log('API Usage:');
console.log(` Requests: ${dashboard.apiUsage.totalRequests}`);
console.log(` Cost: $${dashboard.apiUsage.totalCost.toFixed(2)}`);
console.log(` Error Rate: ${dashboard.apiUsage.errorRate.toFixed(2)}%`);
console.log('\nApify Usage:');
console.log(` Compute Units: ${dashboard.apifyUsage.usage.computeUnits.utilization.toFixed(1)}%`);
console.log(` Monthly Cost: $${dashboard.apifyUsage.costs.monthly.toFixed(2)}`);
console.log('\nBudgets:');
console.log(` Active: ${dashboard.budgets.activeBudgets}`);
console.log(` Spent: $${dashboard.budgets.totalSpent.toFixed(2)} / $${dashboard.budgets.totalAllocated.toFixed(2)}`);
console.log(` Near Limit: ${dashboard.budgets.budgetsNearLimit}`);
// Check for critical alerts
const response = await fetch(
'https://your-domain.com/api/monitoring/alerts?severity=CRITICAL',
{
headers: {
'Authorization': `Bearer ${process.env.API_KEY}`
}
}
);
const { data } = await response.json();
if (data.alerts.length > 0) {
console.warn(`⚠️ ${data.alerts.length} critical alerts!`);
data.alerts.forEach(alert => {
console.log(` - ${alert.message}`);
});
}
curl https://your-domain.com/api/monitoring/dashboard \
-H "Authorization: Bearer YOUR_API_KEY"
Create Budget Alert
// Create alert when budget reaches 80%
const response = await fetch(
'https://your-domain.com/api/monitoring/alerts/rules',
{
method: 'POST',
headers: {
'Authorization': `Bearer ${apiKey}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Budget 80% Alert',
type: 'BUDGET',
conditions: {
budgetId: 'budget_123',
threshold: 80,
metric: 'spentPercentage'
},
severity: 'MEDIUM',
notifications: {
email: ['[email protected]'],
slack: {
webhookUrl: 'https://hooks.slack.com/services/YOUR/WEBHOOK',
channel: '#alerts'
}
},
enabled: true
})
}
);
Monitor Apify Usage
import { ApifyMonitoringService } from '@/lib/services/apify-monitoring-service';
const monitor = new ApifyMonitoringService(process.env.APIFY_API_KEY);
const usage = await monitor.getFullMonitoringData();
// Check for high utilization
if (usage.usage.computeUnits.utilization > 90) {
console.error('🚨 Compute units at 90%!');
// Get platform spending to identify culprit
const spending = await monitor.getPlatformSpending();
const topPlatform = Object.entries(spending.platformBreakdown)
.sort(([,a], [,b]) => b.estimatedCost - a.estimatedCost)[0];
console.log(`Top spender: ${topPlatform[0]} ($${topPlatform[1].estimatedCost.toFixed(2)})`);
}
// Check for active alerts
if (usage.alerts.length > 0) {
console.warn(`Active alerts: ${usage.alerts.length}`);
usage.alerts.forEach(alert => {
console.log(` ${alert.type}: ${alert.message}`);
});
}
Response Example
Monitoring Dashboard
{
"success": true,
"data": {
"apiUsage": {
"totalRequests": 12543,
"totalCost": 67.89,
"avgResponseTime": 324,
"errorRate": 1.2,
"byPlatform": {
"OpenAI": {
"requests": 8234,
"cost": 45.67,
"avgResponseTime": 412
},
"Anthropic": {
"requests": 4309,
"cost": 22.22,
"avgResponseTime": 198
}
}
},
"apifyUsage": {
"account": {
"username": "your-account",
"plan": "STARTER",
"isVerified": true
},
"stats": {
"actors": 8,
"datasets": 156,
"runs": 423,
"builds": 12
},
"usage": {
"computeUnits": {
"current": 1750,
"limit": 2000,
"utilization": 87.5
},
"storage": {
"current": 4294967296,
"limit": 10737418240,
"utilization": 40.0
}
},
"costs": {
"monthly": 39.00,
"daily": 1.30,
"projected": 40.30
},
"alerts": [
{
"type": "warning",
"resource": "Compute Units",
"message": "Warning: 87.5% of compute units used",
"utilization": 87.5
}
]
},
"budgets": {
"activeBudgets": 3,
"totalAllocated": 5000.00,
"totalSpent": 2145.67,
"budgetsNearLimit": 1
},
"systemHealth": {
"database": "healthy",
"cache": "healthy",
"apify": "healthy"
}
}
}
Alert Types
Budget Alerts
Defined in Prisma schema at /prisma/schema.prisma:614-636:
THRESHOLD_80: Budget at 80%THRESHOLD_90: Budget at 90%THRESHOLD_100: Budget at 100%BUDGET_EXCEEDED: Budget exceededSPENDING_SPIKE: Unusual spending patternLOW_BUDGET: Low remaining balanceALLOCATION_DEPLETED: Allocation exhausted
API Alerts
Defined in /prisma/schema.prisma:305-327:
RATE_LIMIT_WARNING: Approaching rate limit (80%)RATE_LIMIT_CRITICAL: At rate limit (95%)COST_WARNING: Unexpected cost increaseCOST_CRITICAL: Cost threshold exceededERROR_RATE_HIGH: High error rate (>5%)
Apify Alerts
Defined in /prisma/schema.prisma:504-520:
FAILURE_RATE: High failure rateCOST_SPIKE: Unexpected cost increaseDATA_QUALITY: Data quality issuesNO_RUNS: No recent runs (stale data)
Next Steps
Budget Management
Manage your budgets
API Reference
Explore all endpoints