Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

improve logging (#525)

Bill Yang38001121ca75
diff --git a/server/package-lock.json b/server/package-lock.json
index 520672e2e..24a7392b1 100644
--- a/server/package-lock.json
+++ b/server/package-lock.json
@@ -51,6 +51,7 @@
"esbuild": "^0.25.5",
"jsdom": "^26.1.0",
"knip": "^5.60.2",
+ "pino-pretty": "^13.1.1",
"terser": "^5.40.0",
"typescript": "^5.8.3",
"vitest": "^3.2.2"
@@ -6013,18 +6014,6 @@
"typescript": ">=5.0.4"
}
},
- "node_modules/knip/node_modules/strip-json-comments": {
- "version": "5.0.2",
- "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-5.0.2.tgz",
- "integrity": "sha512-4X2FR3UwhNUE9G49aIsJW5hRRR3GXGTBTZRMfv568O60ojM8HcWjV/VxAxCDW3SUND33O6ZY66ZuRcdkj73q2g==",
- "dev": true,
- "engines": {
- "node": ">=14.16"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/kysely": {
"version": "0.28.2",
"resolved": "https://registry.npmjs.org/kysely/-/kysely-0.28.2.tgz",
@@ -6839,9 +6828,9 @@
}
},
"node_modules/pino-pretty": {
- "version": "13.0.0",
- "resolved": "https://registry.npmjs.org/pino-pretty/-/pino-pretty-13.0.0.tgz",
- "integrity": "sha512-cQBBIVG3YajgoUjo1FdKVRX6t9XPxwB9lcNJVD5GCnNM4Y6T12YYx8c6zEejxQsU0wrg9TwmDulcE9LR7qcJqA==",
+ "version": "13.1.1",
+ "resolved": "https://registry.npmjs.org/pino-pretty/-/pino-pretty-13.1.1.tgz",
+ "integrity": "sha512-TNNEOg0eA0u+/WuqH0MH0Xui7uqVk9D74ESOpjtebSQYbNWJk/dIxCXIxFsNfeN53JmtWqYHP2OrIZjT/CBEnA==",
"license": "MIT",
"dependencies": {
"colorette": "^2.0.7",
@@ -6854,20 +6843,14 @@
"on-exit-leak-free": "^2.1.0",
"pino-abstract-transport": "^2.0.0",
"pump": "^3.0.0",
- "secure-json-parse": "^2.4.0",
+ "secure-json-parse": "^4.0.0",
"sonic-boom": "^4.0.1",
- "strip-json-comments": "^3.1.1"
+ "strip-json-comments": "^5.0.2"
},
"bin": {
"pino-pretty": "bin.js"
}
},
- "node_modules/pino-pretty/node_modules/secure-json-parse": {
- "version": "2.7.0",
- "resolved": "https://registry.npmjs.org/secure-json-parse/-/secure-json-parse-2.7.0.tgz",
- "integrity": "sha512-6aU+Rwsezw7VR8/nyvKTx8QpWH9FrcYiXXlqC4z5d5XQBDRqtbfsRjnwGyqbi3gddNtWHuEk9OANUotL26qKUw==",
- "license": "BSD-3-Clause"
- },
"node_modules/pino-std-serializers": {
"version": "7.0.0",
"resolved": "https://registry.npmjs.org/pino-std-serializers/-/pino-std-serializers-7.0.0.tgz",
@@ -7887,12 +7870,12 @@
}
},
"node_modules/strip-json-comments": {
- "version": "3.1.1",
- "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz",
- "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==",
+ "version": "5.0.2",
+ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-5.0.2.tgz",
+ "integrity": "sha512-4X2FR3UwhNUE9G49aIsJW5hRRR3GXGTBTZRMfv568O60ojM8HcWjV/VxAxCDW3SUND33O6ZY66ZuRcdkj73q2g==",
"license": "MIT",
"engines": {
- "node": ">=8"
+ "node": ">=14.16"
},
"funding": {
"url": "https://github.com/sponsors/sindresorhus"
diff --git a/server/package.json b/server/package.json
index 20fc5a79c..8639834bb 100644
--- a/server/package.json
+++ b/server/package.json
@@ -64,6 +64,7 @@
"esbuild": "^0.25.5",
"jsdom": "^26.1.0",
"knip": "^5.60.2",
+ "pino-pretty": "^13.1.1",
"terser": "^5.40.0",
"typescript": "^5.8.3",
"vitest": "^3.2.2"
diff --git a/server/src/index.ts b/server/src/index.ts
index f0d62139e..494eb98f5 100644
--- a/server/src/index.ts
+++ b/server/src/index.ts
@@ -91,10 +91,39 @@ import { extractSiteId, isSitePublic } from "./utils.js";
const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);
+const isDevelopment = process.env.NODE_ENV === "development";
+const isProduction = process.env.NODE_ENV === "production";
+
const server = Fastify({
logger: {
- transport: {
- target: "@fastify/one-line-logger",
+ level: process.env.LOG_LEVEL || (isDevelopment ? "debug" : "info"),
+ transport: isProduction
+ ? {
+ target: "@fastify/one-line-logger",
+ }
+ : {
+ target: "pino-pretty",
+ options: {
+ colorize: true,
+ translateTime: "SYS:standard",
+ ignore: "pid,hostname",
+ },
+ },
+ serializers: {
+ req(request) {
+ return {
+ method: request.method,
+ url: request.url,
+ path: request.url,
+ parameters: request.params,
+ headers: request.headers,
+ };
+ },
+ res(reply) {
+ return {
+ statusCode: reply.statusCode,
+ };
+ },
},
},
maxParamLength: 1500,
@@ -353,16 +382,16 @@ const start = async () => {
// Start the server first
await server.listen({ port: 3001, host: "0.0.0.0" });
- console.info("Server is listening on http://0.0.0.0:3001");
+ server.log.info("Server is listening on http://0.0.0.0:3001");
// Initialize uptime monitoring service in the background (non-blocking)
uptimeService
.initialize()
.then(() => {
- console.info("Uptime monitoring service initialized successfully");
+ server.log.info("Uptime monitoring service initialized successfully");
})
.catch((error) => {
- console.error("Failed to initialize uptime service:", error);
+ server.log.error("Failed to initialize uptime service:", error);
// Continue running without uptime monitoring
});
} catch (err) {
@@ -378,34 +407,34 @@ let isShuttingDown = false;
const shutdown = async (signal: string) => {
if (isShuttingDown) {
- console.log(`${signal} received during shutdown, forcing exit...`);
+ server.log.warn(`${signal} received during shutdown, forcing exit...`);
process.exit(1);
}
isShuttingDown = true;
- console.log(`${signal} received, shutting down gracefully...`);
+ server.log.info(`${signal} received, shutting down gracefully...`);
// Set a timeout to force exit if shutdown takes too long
const forceExitTimeout = setTimeout(() => {
- console.error("Shutdown timeout exceeded, forcing exit...");
+ server.log.error("Shutdown timeout exceeded, forcing exit...");
process.exit(1);
}, 10000); // 10 second timeout
try {
// Stop accepting new connections
await server.close();
- console.log("Server closed");
+ server.log.info("Server closed");
// Shutdown uptime service
await uptimeService.shutdown();
- console.log("Uptime service shut down");
+ server.log.info("Uptime service shut down");
// Clear the timeout since we're done
clearTimeout(forceExitTimeout);
process.exit(0);
} catch (error) {
- console.error("Error during shutdown:", error);
+ server.log.error(error, "Error during shutdown");
clearTimeout(forceExitTimeout);
process.exit(1);
}
diff --git a/server/src/lib/logger/LOGGING.md b/server/src/lib/logger/LOGGING.md
new file mode 100644
index 000000000..1e41f6ca9
--- /dev/null
+++ b/server/src/lib/logger/LOGGING.md
@@ -0,0 +1,145 @@
+# Logging Guide for Frogstats Backend
+
+## Overview
+
+This Fastify backend uses Pino for structured JSON logging. In production, logs are formatted as single-line JSON for easy parsing. In development, logs are pretty-printed for readability.
+
+## Configuration
+
+Logging is configured in `src/index.ts` when creating the Fastify instance:
+- **Production**: Uses `@fastify/one-line-logger` for compact JSON logs
+- **Development**: Uses `pino-pretty` for colorized, human-readable output
+- **Log Level**: Set via `LOG_LEVEL` env var (defaults to "debug" in dev, "info" in prod)
+
+## Usage Patterns
+
+### 1. Route Handlers
+In route handlers, use `request.log`:
+
+```typescript
+export async function getUsers(request: FastifyRequest, reply: FastifyReply) {
+ request.log.info('Fetching users');
+
+ try {
+ const users = await fetchUsers();
+ request.log.debug({ userCount: users.length }, 'Users fetched successfully');
+ return users;
+ } catch (error) {
+ request.log.error(error, 'Failed to fetch users');
+ throw error;
+ }
+}
+```
+
+### 2. Services and Classes
+Import the logger utility and create a child logger:
+
+```typescript
+import { createServiceLogger } from '../../lib/logger.js';
+
+export class MyService {
+ private logger = createServiceLogger('my-service');
+
+ async doSomething() {
+ this.logger.info('Starting operation');
+ // ...
+ }
+}
+```
+
+### 3. Server-level Logging
+Use `server.log` for server-wide events:
+
+```typescript
+server.log.info('Server started on port 3001');
+server.log.error(error, 'Shutdown error');
+```
+
+## Log Levels
+
+Use appropriate levels for different scenarios:
+- `fatal`: Application is unusable, will exit
+- `error`: Error conditions (exceptions, failures)
+- `warn`: Warning conditions (deprecations, recoverable issues)
+- `info`: Informational messages (startup, shutdown, major operations)
+- `debug`: Debug information (detailed operation info)
+- `trace`: Very detailed trace information
+
+## Best Practices
+
+1. **Structure your logs**: Pass objects as the first parameter for structured data
+ ```typescript
+ logger.info({ userId: 123, action: 'login' }, 'User logged in');
+ ```
+
+2. **Include context**: Add relevant data to help with debugging
+ ```typescript
+ request.log.info({ monitorId, region }, 'Running health check');
+ ```
+
+3. **Log errors properly**: Pass error as first param for proper stack traces
+ ```typescript
+ logger.error(error, 'Operation failed');
+ ```
+
+4. **Avoid sensitive data**: Never log passwords, tokens, or PII
+ ```typescript
+ logger.info({ userId: user.id }, 'User authenticated'); // Good
+ logger.info({ user }, 'User authenticated'); // Bad - might contain password
+ ```
+
+5. **Use child loggers**: Create scoped loggers for services/modules
+ ```typescript
+ const logger = parentLogger.child({ service: 'uptime' });
+ ```
+
+## Migration from console.log
+
+Replace console statements with appropriate logger calls:
+- `console.log()` β†’ `logger.info()`
+- `console.error()` β†’ `logger.error()`
+- `console.warn()` β†’ `logger.warn()`
+- `console.debug()` β†’ `logger.debug()`
+
+### Migration Progress
+
+βœ… **Completed Services:**
+- All uptime monitoring services (monitorExecutor, monitorScheduler, regionHealthChecker, notificationService)
+- Core services (usageService, telemetryService, sessionsService)
+- Storage service (r2StorageService)
+- Main server file (index.ts)
+
+⏳ **Remaining:**
+- API endpoints (stripe webhook, session replay, admin routes)
+- Library files (auth, twilio, etc.)
+- Request validation services
+
+## Environment Variables
+
+- `LOG_LEVEL`: Set the minimum log level (trace, debug, info, warn, error, fatal)
+- `NODE_ENV`: Determines log format (production vs development)
+
+## Example Service Refactoring
+
+Before:
+```typescript
+console.log('Service starting...');
+console.error('Failed to connect:', error);
+```
+
+After:
+```typescript
+import { createServiceLogger } from '../../lib/logger.js';
+
+class MyService {
+ private logger = createServiceLogger('my-service');
+
+ start() {
+ this.logger.info('Service starting...');
+ }
+
+ handleError(error: Error) {
+ this.logger.error(error, 'Failed to connect');
+ }
+}
+```
\ No newline at end of file
diff --git a/server/src/lib/logger/logger.ts b/server/src/lib/logger/logger.ts
new file mode 100644
index 000000000..c42cb2758
--- /dev/null
+++ b/server/src/lib/logger/logger.ts
@@ -0,0 +1,28 @@
+import type { FastifyBaseLogger } from "fastify";
+import { pino } from "pino";
+
+const isDevelopment = process.env.NODE_ENV === "development";
+const isProduction = process.env.NODE_ENV === "production";
+
+export const createLogger = (name: string): FastifyBaseLogger => {
+ return pino({
+ name,
+ level: process.env.LOG_LEVEL || (isDevelopment ? "debug" : "info"),
+ transport: isProduction
+ ? undefined
+ : {
+ target: "pino-pretty",
+ options: {
+ colorize: true,
+ translateTime: "SYS:standard",
+ ignore: "pid,hostname",
+ },
+ },
+ }) as FastifyBaseLogger;
+};
+
+export const logger = createLogger("rybbit");
+
+export const createServiceLogger = (service: string) => {
+ return logger.child({ service });
+};
diff --git a/server/src/services/sessions/sessionsService.ts b/server/src/services/sessions/sessionsService.ts
index 55c236b5e..84b160ea9 100644
--- a/server/src/services/sessions/sessionsService.ts
+++ b/server/src/services/sessions/sessionsService.ts
@@ -2,9 +2,11 @@ import { and, eq, lt } from "drizzle-orm";
import * as cron from "node-cron";
import { db } from "../../db/postgres/postgres.js";
import { activeSessions } from "../../db/postgres/schema.js";
+import { createServiceLogger } from "../../lib/logger/logger.js";
class SessionsService {
private cleanupTask: cron.ScheduledTask | null = null;
+ private logger = createServiceLogger("sessions");
constructor() {
this.initializeCleanupCron();
@@ -15,17 +17,13 @@ class SessionsService {
try {
const deletedCount = await this.cleanupOldSessions();
// Uncomment for debugging
- console.log(
- `[SessionsService] Cleaned up ${deletedCount} expired sessions`
- );
+ this.logger.debug(`Cleaned up ${deletedCount} expired sessions`);
} catch (error) {
- console.error("[SessionsService] Error during session cleanup:", error);
+ this.logger.error(error as Error, "Error during session cleanup");
}
});
- console.log(
- "[SessionsService] Session cleanup cron initialized (runs every minute)"
- );
+ this.logger.info("Session cleanup cron initialized (runs every minute)");
}
async getExistingSession(userId: string, siteId: string) {
const siteIdNumber = parseInt(siteId, 10);
@@ -33,25 +31,14 @@ class SessionsService {
const [existingSession] = await db
.select()
.from(activeSessions)
- .where(
- and(
- eq(activeSessions.userId, userId),
- eq(activeSessions.siteId, siteIdNumber)
- )
- )
+ .where(and(eq(activeSessions.userId, userId), eq(activeSessions.siteId, siteIdNumber)))
.limit(1);
return existingSession || null;
}
- async updateSession(payload: {
- userId: string;
- site_id: string;
- }): Promise<{ sessionId: string }> {
- const existingSession = await this.getExistingSession(
- payload.userId,
- payload.site_id
- );
+ async updateSession(payload: { userId: string; site_id: string }): Promise<{ sessionId: string }> {
+ const existingSession = await this.getExistingSession(payload.userId, payload.site_id);
if (existingSession) {
await db
@@ -66,10 +53,7 @@ class SessionsService {
// Insert new session with Drizzle - only include columns that exist in schema
const insertData = {
sessionId: crypto.randomUUID(),
- siteId:
- typeof payload.site_id === "string"
- ? parseInt(payload.site_id, 10)
- : payload.site_id,
+ siteId: typeof payload.site_id === "string" ? parseInt(payload.site_id, 10) : payload.site_id,
userId: payload.userId,
startTime: new Date(),
lastActivity: new Date(),
@@ -88,7 +72,7 @@ class SessionsService {
.where(lt(activeSessions.lastActivity, thirtyMinutesAgo))
.returning();
- // console.log(`Cleaned up ${deletedSessions.length} sessions`);
+ // this.logger.debug(`Cleaned up ${deletedSessions.length} sessions`);
return deletedSessions.length;
}
@@ -96,7 +80,7 @@ class SessionsService {
stopCleanupCron() {
if (this.cleanupTask) {
this.cleanupTask.stop();
- console.log("[SessionsService] Session cleanup cron stopped");
+ this.logger.info("Session cleanup cron stopped");
}
}
}
diff --git a/server/src/services/storage/r2StorageService.ts b/server/src/services/storage/r2StorageService.ts
index ae236a696..0f99481bc 100644
--- a/server/src/services/storage/r2StorageService.ts
+++ b/server/src/services/storage/r2StorageService.ts
@@ -3,11 +3,13 @@ import { Readable } from "stream";
import { gunzipSync } from "zlib";
import { compress as zstdCompress, decompress as zstdDecompress } from "@mongodb-js/zstd";
import { IS_CLOUD } from "../../lib/const.js";
+import { createServiceLogger } from "../../lib/logger/logger.js";
class R2StorageService {
private client: S3Client | null = null;
private bucketName: string = "";
private enabled: boolean = false;
+ private logger = createServiceLogger("r2-storage");
constructor() {
// Only initialize R2 in cloud environment
@@ -24,9 +26,9 @@ class R2StorageService {
});
this.bucketName = process.env.R2_BUCKET_NAME || "rybbit";
this.enabled = true;
- console.log("[R2Storage] Initialized with bucket:", this.bucketName);
+ this.logger.info({ bucket: this.bucketName }, "R2Storage initialized");
} else {
- console.log("[R2Storage] Not enabled - missing IS_CLOUD or R2 credentials");
+ this.logger.debug("R2Storage not enabled - missing IS_CLOUD or R2 credentials");
}
}
diff --git a/server/src/services/telemetryService.ts b/server/src/services/telemetryService.ts
index f5be1bf5a..4c7ae1e70 100644
--- a/server/src/services/telemetryService.ts
+++ b/server/src/services/telemetryService.ts
@@ -6,32 +6,34 @@ import { fileURLToPath } from "url";
import { clickhouse } from "../db/clickhouse/clickhouse.js";
import { IS_CLOUD, DISABLE_TELEMETRY, SECRET } from "../lib/const.js";
import { processResults } from "../api/analytics/utils.js";
+import { createServiceLogger } from "../lib/logger/logger.js";
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
class TelemetryService {
private telemetryTask: cron.ScheduledTask | null = null;
+ private logger = createServiceLogger("telemetry");
constructor() {}
private initializeTelemetryCron() {
// Only initialize if not cloud and telemetry is not disabled
if (!IS_CLOUD && !DISABLE_TELEMETRY) {
- console.info("[TelemetryService] Initializing telemetry cron");
+ this.logger.info("Initializing telemetry cron");
// Schedule telemetry to run every 24 hours at midnight
this.telemetryTask = cron.schedule("0 0 * * *", async () => {
try {
await this.collectAndSendTelemetry();
} catch (error) {
- console.error("[TelemetryService] Error during telemetry collection:", error);
+ this.logger.error(error as Error, "Error during telemetry collection");
}
});
// Run immediately on startup
this.collectAndSendTelemetry();
- console.log("[TelemetryService] Telemetry collection initialized (runs daily at midnight)");
+ this.logger.info("Telemetry collection initialized (runs daily at midnight)");
}
}
@@ -84,7 +86,7 @@ class TelemetryService {
const data = await processResults<{ size_gb: number }>(result);
return data[0]?.size_gb || 0;
} catch (error) {
- console.error("Error getting ClickHouse size:", error);
+ this.logger.error(error as Error, "Error getting ClickHouse size");
return 0;
}
}
@@ -108,10 +110,10 @@ class TelemetryService {
});
if (!response.ok) {
- console.error("Failed to send telemetry:", response.status, response.statusText);
+ this.logger.error(`Failed to send telemetry: ${response.status} ${response.statusText}`);
}
} catch (error) {
- console.error("Error sending telemetry:", error);
+ this.logger.error(error as Error, "Error sending telemetry");
}
}
@@ -138,9 +140,9 @@ class TelemetryService {
};
await this.sendTelemetry(telemetryData);
- console.log("[TelemetryService] Telemetry sent successfully");
+ this.logger.info("Telemetry sent successfully");
} catch (error) {
- console.error("Error collecting telemetry:", error);
+ this.logger.error(error as Error, "Error collecting telemetry");
}
}
@@ -148,7 +150,7 @@ class TelemetryService {
public stopTelemetryCron() {
if (this.telemetryTask) {
this.telemetryTask.stop();
- console.log("[TelemetryService] Telemetry collection cron stopped");
+ this.logger.info("Telemetry collection cron stopped");
}
}
diff --git a/server/src/services/uptime/monitorExecutor.ts b/server/src/services/uptime/monitorExecutor.ts
index e1dd9abeb..6a1ba7d92 100644
--- a/server/src/services/uptime/monitorExecutor.ts
+++ b/server/src/services/uptime/monitorExecutor.ts
@@ -9,6 +9,7 @@ import { performHttpCheck } from "./checks/httpCheck.js";
import { performTcpCheck } from "./checks/tcpCheck.js";
import { applyValidationRules } from "./validationEngine.js";
import { NotificationService } from "./notificationService.js";
+import { createServiceLogger } from "../../lib/logger/logger.js";
interface AgentExecuteRequest {
jobId: string;
@@ -46,7 +47,8 @@ export class MonitorExecutor {
private isShuttingDown = false;
private connection: { host: string; port: number; password?: string };
private notificationService: NotificationService;
-
+ private logger = createServiceLogger("monitor-executor");
+
// Confirmation thresholds - require multiple consecutive checks before triggering incidents
private static readonly FAILURE_THRESHOLD = 2; // Consecutive failures before creating incident
private static readonly SUCCESS_THRESHOLD = 2; // Consecutive successes before resolving incident
@@ -62,7 +64,7 @@ export class MonitorExecutor {
}
async start(): Promise<void> {
- console.log(`[Uptime] Starting BullMQ monitor executor with concurrency: ${this.concurrency}`);
+ this.logger.info(`Starting BullMQ monitor executor with concurrency: ${this.concurrency}`);
// Create worker to process jobs
this.worker = new Worker(
@@ -85,23 +87,23 @@ export class MonitorExecutor {
// Set up event listeners
// this.worker.on("completed", (job) => {
- // console.log(`[Uptime] Job ${job.id} completed successfully`);
+ // this.logger.debug(`Job ${job.id} completed successfully`);
// });
this.worker.on("failed", (job, err) => {
- console.error(`Job ${job?.id} failed:`, err);
+ this.logger.error(err as Error, `Job ${job?.id} failed`);
});
this.worker.on("error", (err) => {
- console.error("Worker error:", err);
+ this.logger.error(err as Error, "Worker error");
});
this.worker.on("ready", () => {
- console.log("[Uptime] BullMQ worker is ready and listening for jobs");
+ this.logger.info("BullMQ worker is ready and listening for jobs");
});
// this.worker.on("active", (job) => {
- // console.log(`[Uptime] Job ${job.id} is now active`);
+ // this.logger.debug(`Job ${job.id} is now active`);
// });
// Wait for worker to be ready
@@ -113,14 +115,14 @@ export class MonitorExecutor {
}
});
- console.log("[Uptime] BullMQ monitor executor started successfully");
+ this.logger.info("BullMQ monitor executor started successfully");
}
private async processMonitorCheck(jobData: MonitorCheckJob): Promise<void> {
const { monitorId } = jobData;
try {
- console.log(`[Uptime] πŸ” Starting to process monitor check for monitor ID: ${monitorId}`);
+ this.logger.debug(`πŸ” Starting to process monitor check for monitor ID: ${monitorId}`);
// Fetch monitor configuration
const monitor = await db.query.uptimeMonitors.findFirst({
@@ -128,7 +130,7 @@ export class MonitorExecutor {
});
if (!monitor || !monitor.enabled) {
- console.log(`[Uptime] Monitor ${monitorId} not found or disabled`);
+ this.logger.debug(`Monitor ${monitorId} not found or disabled`);
return;
}
@@ -191,9 +193,9 @@ export class MonitorExecutor {
// Update monitor status in PostgreSQL
await this.updateMonitorStatus(monitor.id, result);
- console.log(`[Uptime] βœ… Monitor check completed: ${monitorId} - ${result.status} (${result.responseTimeMs}ms)`);
+ this.logger.info(`βœ… Monitor check completed: ${monitorId} - ${result.status} (${result.responseTimeMs}ms`);
} catch (error) {
- console.error(`Error processing monitor check ${monitorId}:`, error);
+ this.logger.error(error as Error, `Error processing monitor check ${monitorId}`);
// Try to store the error event
try {
@@ -219,7 +221,7 @@ export class MonitorExecutor {
await this.updateMonitorStatus(monitor.id, errorResult);
}
} catch (innerError) {
- console.error("Failed to store error event:", innerError);
+ this.logger.error(innerError as Error, "Failed to store error event");
}
}
}
@@ -230,7 +232,7 @@ export class MonitorExecutor {
const globalRegions = monitor.selectedRegions.filter((r: string) => r !== "local");
if (globalRegions.length === 0) {
- console.log(`[Uptime] Monitor ${monitor.id} has no global regions selected`);
+ this.logger.debug(`Monitor ${monitor.id} has no global regions selected`);
return;
}
@@ -244,14 +246,14 @@ export class MonitorExecutor {
});
if (regions.length === 0) {
- console.log(`[Uptime] No healthy regions found for monitor ${monitor.id}`);
+ this.logger.warn(`No healthy regions found for monitor ${monitor.id}`);
return;
}
// Execute checks in parallel across all regions
const regionPromises = regions.map((region) =>
this.executeAgentCheck(monitor, region).catch((error) => {
- console.error(`Error executing check in region ${region.code}:`, error);
+ this.logger.error(error as Error, `Error executing check in region ${region.code}`);
return {
region: region.code,
result: {
@@ -304,11 +306,11 @@ export class MonitorExecutor {
await this.updateMonitorStatus(monitor.id, aggregatedResult);
- console.log(
- `[Uptime] βœ… Global monitor check completed: ${monitor.id} - ${overallStatus} (${regionResults.length} regions)`,
+ this.logger.info(
+ `βœ… Global monitor check completed: ${monitor.id} - ${overallStatus} (${regionResults.length} regions)`,
);
} catch (error) {
- console.error(`Error processing global monitor check ${monitor.id}:`, error);
+ this.logger.error(error as Error, `Error processing global monitor check ${monitor.id}`);
}
}
@@ -364,7 +366,7 @@ export class MonitorExecutor {
return { region: region.code, result };
} catch (error) {
- console.error(`Failed to execute check via agent ${region.code}:`, error);
+ this.logger.error(error as Error, `Failed to execute check via agent ${region.code}`);
throw error;
}
}
@@ -411,7 +413,7 @@ export class MonitorExecutor {
format: "JSONEachRow",
});
} catch (error) {
- console.error("Failed to store monitor event in ClickHouse:", error);
+ this.logger.error(error as Error, "Failed to store monitor event in ClickHouse");
}
}
@@ -462,15 +464,15 @@ export class MonitorExecutor {
// Handle incident creation/resolution based on consecutive failures/successes
await this.handleIncidentManagement(
- monitorId,
- previousStatus || undefined,
- currentStatus,
+ monitorId,
+ previousStatus || undefined,
+ currentStatus,
result,
consecutiveFailures,
- consecutiveSuccesses
+ consecutiveSuccesses,
);
} catch (error) {
- console.error("Failed to update monitor status:", error);
+ this.logger.error(error as Error, "Failed to update monitor status");
}
}
@@ -489,7 +491,7 @@ export class MonitorExecutor {
});
if (!monitor) {
- console.error(`Monitor ${monitorId} not found for incident management`);
+ this.logger.error(`Monitor ${monitorId} not found for incident management`);
return;
}
@@ -504,23 +506,23 @@ export class MonitorExecutor {
// Create incident when failures reach threshold
if (currentStatus === "down" && consecutiveFailures === MonitorExecutor.FAILURE_THRESHOLD && !activeIncident) {
- const [newIncident] = await db
- .insert(uptimeIncidents)
- .values({
- organizationId: monitor.organizationId as string,
- monitorId: monitorId,
- region: "local",
- startTime: new Date().toISOString(),
- status: "active",
- lastError: result.error?.message || null,
- lastErrorType: result.error?.type || null,
- failureCount: 1,
- })
- .returning();
- console.log(`[Uptime] Created new incident for monitor ${monitorId} (${monitor.name})`);
-
- // Send notifications for new incident
- await this.notificationService.sendIncidentNotifications(monitor, newIncident, "down");
+ const [newIncident] = await db
+ .insert(uptimeIncidents)
+ .values({
+ organizationId: monitor.organizationId as string,
+ monitorId: monitorId,
+ region: "local",
+ startTime: new Date().toISOString(),
+ status: "active",
+ lastError: result.error?.message || null,
+ lastErrorType: result.error?.type || null,
+ failureCount: 1,
+ })
+ .returning();
+ this.logger.info(`Created new incident for monitor ${monitorId} (${monitor.name})`);
+
+ // Send notifications for new incident
+ await this.notificationService.sendIncidentNotifications(monitor, newIncident, "down");
}
// Resolve incident when successes reach threshold after being down
else if (currentStatus === "up" && consecutiveSuccesses === MonitorExecutor.SUCCESS_THRESHOLD && activeIncident) {
@@ -533,7 +535,7 @@ export class MonitorExecutor {
resolvedAt: now,
})
.where(eq(uptimeIncidents.id, activeIncident.id));
- console.log(`[Uptime] Resolved incident ${activeIncident.id} for monitor ${monitorId} (${monitor.name})`);
+ this.logger.info(`Resolved incident ${activeIncident.id} for monitor ${monitorId} (${monitor.name})`);
// Send recovery notifications
await this.notificationService.sendIncidentNotifications(
@@ -554,7 +556,7 @@ export class MonitorExecutor {
.where(eq(uptimeIncidents.id, activeIncident.id));
}
} catch (error) {
- console.error("Failed to manage incident:", error);
+ this.logger.error(error as Error, "Failed to manage incident");
}
}
@@ -565,7 +567,7 @@ export class MonitorExecutor {
): Promise<void> {
try {
const currentStatus = result.status === "success" ? "up" : "down";
-
+
// Get recent events from ClickHouse to determine consecutive counts
const recentEvents = await clickhouse.query({
query: `
@@ -579,23 +581,23 @@ export class MonitorExecutor {
query_params: {
monitorId: monitor.id,
region: region,
- limit: MonitorExecutor.FAILURE_THRESHOLD + 1 // Get enough events to check threshold
- }
+ limit: MonitorExecutor.FAILURE_THRESHOLD + 1, // Get enough events to check threshold
+ },
});
-
+
const events = await recentEvents.json<{ status: string; timestamp: string }>();
-
+
// Count consecutive failures/successes from most recent events
let consecutiveFailures = 0;
let consecutiveSuccesses = 0;
-
+
// Start with current result
if (currentStatus === "down") {
consecutiveFailures = 1;
} else {
consecutiveSuccesses = 1;
}
-
+
// Check previous events
for (const event of events.data) {
if (currentStatus === "down" && event.status === "failure") {
@@ -631,7 +633,7 @@ export class MonitorExecutor {
failureCount: 1,
})
.returning();
- console.log(`[Uptime] Created new incident for monitor ${monitor.id} (${monitor.name}) in region ${region}`);
+ this.logger.info(`Created new incident for monitor ${monitor.id} (${monitor.name}) in region ${region}`);
// Send notifications for new regional incident
await this.notificationService.sendIncidentNotifications(monitor, newIncident, "down");
@@ -648,8 +650,8 @@ export class MonitorExecutor {
updatedAt: now,
})
.where(eq(uptimeIncidents.id, activeIncident.id));
- console.log(
- `[Uptime] Resolved incident ${activeIncident.id} for monitor ${monitor.id} (${monitor.name}) in region ${region}`,
+ this.logger.info(
+ `Resolved incident ${activeIncident.id} for monitor ${monitor.id} (${monitor.name}) in region ${region}`,
);
// Send recovery notifications for regional incident
@@ -671,12 +673,12 @@ export class MonitorExecutor {
.where(eq(uptimeIncidents.id, activeIncident.id));
}
} catch (error) {
- console.error(`Failed to manage regional incident for region ${region}:`, error);
+ this.logger.error(error as Error, `Failed to manage regional incident for region ${region}`);
}
}
async shutdown(): Promise<void> {
- console.log("[Uptime] Shutting down BullMQ monitor executor...");
+ this.logger.info("Shutting down BullMQ monitor executor...");
this.isShuttingDown = true;
if (this.worker) {
@@ -686,9 +688,9 @@ export class MonitorExecutor {
this.worker.close(),
new Promise((_, reject) => setTimeout(() => reject(new Error("Worker close timeout")), 5000)),
]);
- console.log("[Uptime] BullMQ monitor executor shut down successfully");
+ this.logger.info("BullMQ monitor executor shut down successfully");
} catch (error) {
- console.error("Error closing worker:", error);
+ this.logger.error(error as Error, "Error closing worker");
// Force close if needed
this.worker = null;
}
diff --git a/server/src/services/uptime/monitorScheduler.ts b/server/src/services/uptime/monitorScheduler.ts
index 639668f59..12ed00aa4 100644
--- a/server/src/services/uptime/monitorScheduler.ts
+++ b/server/src/services/uptime/monitorScheduler.ts
@@ -1,7 +1,8 @@
-import { Queue, QueueEvents, JobsOptions } from "bullmq";
+import { Queue, QueueEvents } from "bullmq";
import { eq } from "drizzle-orm";
import { db } from "../../db/postgres/postgres.js";
import { uptimeMonitors } from "../../db/postgres/schema.js";
+import { createServiceLogger } from "../../lib/logger/logger.js";
import { MonitorCheckJob } from "./types.js";
export class MonitorScheduler {
@@ -9,6 +10,7 @@ export class MonitorScheduler {
private queueEvents: QueueEvents;
private isShuttingDown = false;
private connection: { host: string; port: number; password?: string };
+ private logger = createServiceLogger("monitor-scheduler");
constructor() {
// Get Redis connection from environment
@@ -18,7 +20,7 @@ export class MonitorScheduler {
...(process.env.REDIS_PASSWORD && { password: process.env.REDIS_PASSWORD }),
};
- console.log(`[Uptime] BullMQ connecting to Redis at ${this.connection.host}:${this.connection.port}`);
+ this.logger.info(`BullMQ connecting to Redis at ${this.connection.host}:${this.connection.port}`);
this.queue = new Queue("monitor-checks", {
connection: this.connection,
@@ -40,13 +42,13 @@ export class MonitorScheduler {
}
async initialize(): Promise<void> {
- console.log("[Uptime] Initializing BullMQ monitor scheduler...");
+ this.logger.info("Initializing BullMQ monitor scheduler...");
// Wait for queue to be ready
await this.queue.waitUntilReady();
await this.queueEvents.waitUntilReady();
- console.log("[Uptime] BullMQ queue ready");
+ this.logger.info("BullMQ queue ready");
// Clear any stale jobs from previous runs
await this.clearStaleJobs();
diff --git a/server/src/services/uptime/regionHealthChecker.ts b/server/src/services/uptime/regionHealthChecker.ts
index 025a81fe3..bcf2c6afa 100644
--- a/server/src/services/uptime/regionHealthChecker.ts
+++ b/server/src/services/uptime/regionHealthChecker.ts
@@ -1,10 +1,12 @@
import { eq } from "drizzle-orm";
import { db } from "../../db/postgres/postgres.js";
import { agentRegions } from "../../db/postgres/schema.js";
+import { createServiceLogger } from "../../lib/logger/logger.js";
export class RegionHealthChecker {
private intervalMs: number;
private intervalId: NodeJS.Timeout | null = null;
+ private logger = createServiceLogger("region-health-checker");
constructor(intervalMs: number = 60000) {
// Default: 1 minute
@@ -12,7 +14,7 @@ export class RegionHealthChecker {
}
async start(): Promise<void> {
- console.log(`[Uptime] Starting region health checker with interval: ${this.intervalMs}ms`);
+ this.logger.info(`Starting region health checker with interval: ${this.intervalMs}ms`);
// Run initial check
await this.checkAllRegions();
@@ -27,7 +29,7 @@ export class RegionHealthChecker {
if (this.intervalId) {
clearInterval(this.intervalId);
this.intervalId = null;
- console.log("[Uptime] Region health checker stopped");
+ this.logger.info("Region health checker stopped");
}
}
@@ -40,11 +42,11 @@ export class RegionHealthChecker {
// Filter out local region
const remoteRegions = regions.filter((r) => r.code !== "local");
- console.log(`[Uptime] Checking health of ${remoteRegions.length} remote regions`);
+ this.logger.debug(`Checking health of ${remoteRegions.length} remote regions`);
const healthPromises = remoteRegions.map((region) =>
this.checkRegionHealth(region).catch((error) => {
- console.error(`Error checking health of region ${region.code}:`, error);
+ this.logger.error(error, `Error checking health of region ${region.code}`);
return { region, isHealthy: false };
}),
);
diff --git a/server/src/services/uptime/uptimeService.ts b/server/src/services/uptime/uptimeService.ts
index c4f7aef64..0255147b8 100644
--- a/server/src/services/uptime/uptimeService.ts
+++ b/server/src/services/uptime/uptimeService.ts
@@ -1,6 +1,7 @@
import { MonitorScheduler } from "./monitorScheduler.js";
import { MonitorExecutor } from "./monitorExecutor.js";
import { RegionHealthChecker } from "./regionHealthChecker.js";
+import { createServiceLogger } from "../../lib/logger/logger.js";
export class UptimeService {
private scheduler: MonitorScheduler;
@@ -8,6 +9,7 @@ export class UptimeService {
private regionHealthChecker: RegionHealthChecker;
private initialized = false;
private initializationPromise: Promise<void> | null = null;
+ private logger = createServiceLogger("uptime");
constructor() {
this.scheduler = new MonitorScheduler();
@@ -17,7 +19,7 @@ export class UptimeService {
async initialize(): Promise<void> {
if (this.initialized) {
- console.log("Uptime service already initialized");
+ this.logger.debug("Uptime service already initialized");
return;
}
@@ -33,7 +35,7 @@ export class UptimeService {
private async performInitialization(): Promise<void> {
try {
- console.log("Initializing BullMQ uptime monitoring service...");
+ this.logger.info("Initializing BullMQ uptime monitoring service...");
// Initialize scheduler (creates queue, loads and schedules all monitors)
await this.scheduler.initialize();
@@ -45,16 +47,16 @@ export class UptimeService {
await this.regionHealthChecker.start();
this.initialized = true;
- console.log("BullMQ uptime monitoring service initialized successfully");
+ this.logger.info("BullMQ uptime monitoring service initialized successfully");
} catch (error) {
- console.error("Failed to initialize uptime service:", error);
+ this.logger.error(error, "Failed to initialize uptime service");
this.initializationPromise = null; // Reset on failure
throw error;
}
}
async shutdown(): Promise<void> {
- console.log("Shutting down BullMQ uptime monitoring service...");
+ this.logger.info("Shutting down BullMQ uptime monitoring service...");
try {
// Stop region health checker
@@ -67,9 +69,9 @@ export class UptimeService {
await this.scheduler.shutdown();
this.initialized = false;
- console.log("BullMQ uptime monitoring service shut down successfully");
+ this.logger.info("BullMQ uptime monitoring service shut down successfully");
} catch (error) {
- console.error("Error during uptime service shutdown:", error);
+ this.logger.error(error, "Error during uptime service shutdown");
}
}
@@ -81,7 +83,7 @@ export class UptimeService {
}
if (!this.initialized) {
- console.warn("Uptime service not initialized, cannot schedule monitor");
+ this.logger.warn("Uptime service not initialized, cannot schedule monitor");
return;
}
@@ -99,7 +101,7 @@ export class UptimeService {
}
if (!this.initialized) {
- console.warn("Uptime service not initialized, cannot update monitor");
+ this.logger.warn("Uptime service not initialized, cannot update monitor");
return;
}
@@ -119,7 +121,7 @@ export class UptimeService {
}
if (!this.initialized) {
- console.warn("Uptime service not initialized, cannot delete monitor");
+ this.logger.warn("Uptime service not initialized, cannot delete monitor");
return;
}
diff --git a/server/src/services/usageService.ts b/server/src/services/usageService.ts
index ce37737b5..0a8746309 100644
--- a/server/src/services/usageService.ts
+++ b/server/src/services/usageService.ts
@@ -8,10 +8,12 @@ import { db } from "../db/postgres/postgres.js";
import { organization, sites } from "../db/postgres/schema.js";
import { getStripePrices, StripePlan, DEFAULT_EVENT_LIMIT, IS_CLOUD } from "../lib/const.js";
import { stripe } from "../lib/stripe.js";
+import { createServiceLogger } from "../lib/logger/logger.js";
class UsageService {
private sitesOverLimit = new Set<number>();
private usageCheckTask: cron.ScheduledTask | null = null;
+ private logger = createServiceLogger("usage-checker");
constructor() {
this.initializeUsageCheckCron();
@@ -27,14 +29,14 @@ class UsageService {
try {
await this.updateOrganizationsMonthlyUsage();
} catch (error) {
- console.error("[UsageCheckerService] Error during usage check:", error);
+ this.logger.error(error as Error, "Error during usage check");
}
});
// Run immediately on startup
this.updateOrganizationsMonthlyUsage();
- console.log("[UsageCheckerService] Monthly usage check cron initialized (runs every 30 minutes)");
+ this.logger.info("Monthly usage check cron initialized (runs every 30 minutes)");
}
}
@@ -71,7 +73,7 @@ class UsageService {
return siteRecords.map((record) => record.siteId);
} catch (error) {
- console.error(`Error getting sites for organization ${organizationId}:`, error);
+ this.logger.error(error as Error, `Error getting sites for organization ${organizationId}`);
return [];
}
}
@@ -113,7 +115,9 @@ class UsageService {
const priceId = subscriptionItem.price.id;
if (!priceId) {
- console.error(`Subscription item price ID not found for organization ${orgData.id}, sub ${subscription.id}`);
+ this.logger.error(
+ `Subscription item price ID not found for organization ${orgData.id}, sub ${subscription.id}`,
+ );
return [DEFAULT_EVENT_LIMIT, this.getStartOfMonth()];
}
@@ -141,23 +145,23 @@ class UsageService {
// This ensures we don't count events from before they subscribed (e.g., during their free trial)
if (subscriptionStartDate >= currentMonth) {
periodStart = subscriptionStartDate.toISODate() as string;
- console.log(
- `[Monthly Usage Checker] Organization ${orgData.name} subscribed during current month on ${periodStart}. Using subscription start date for counting.`,
+ this.logger.info(
+ `Organization ${orgData.name} subscribed during current month on ${periodStart}. Using subscription start date for counting.`,
);
} else {
- console.log(
- `[Monthly Usage Checker] Organization ${orgData.name} subscription started before current month. Using month start for counting.`,
+ this.logger.info(
+ `Organization ${orgData.name} subscription started before current month. Using month start for counting.`,
);
}
}
// Include subscription info for logging purposes
const interval = subscriptionItem.price.recurring?.interval || "unknown";
- console.log(`[Monthly Usage Checker] Organization ${orgData.name} has a ${interval} subscription.`);
+ this.logger.info(`Organization ${orgData.name} has a ${interval} subscription.`);
return [eventLimit, periodStart];
} catch (error: any) {
- console.error(`Error fetching Stripe subscription info for organization ${orgData.name}:`, error);
+ this.logger.error(error as Error, `Error fetching Stripe subscription info for organization ${orgData.name}`);
// Fallback to default limit and current month start on Stripe API error
return [DEFAULT_EVENT_LIMIT, this.getStartOfMonth()];
}
@@ -187,7 +191,7 @@ class UsageService {
const rows = await processResults<{ count: string }>(result);
return parseInt(rows[0].count, 10);
} catch (error) {
- console.error(`Error querying ClickHouse for pageviews for sites ${siteIds}:`, error);
+ this.logger.error(error as Error, `Error querying ClickHouse for pageviews for sites ${siteIds}`);
return 0;
}
}
@@ -196,7 +200,7 @@ class UsageService {
* Updates monthly event usage for all organizations
*/
public async updateOrganizationsMonthlyUsage(): Promise<void> {
- console.log("[Monthly Usage Checker] Starting check of monthly event usage for organizations...");
+ this.logger.info("Starting check of monthly event usage for organizations...");
try {
// Get all organizations (both with and without Stripe customer IDs)
@@ -242,8 +246,8 @@ class UsageService {
for (const siteId of siteIds) {
this.sitesOverLimit.add(siteId);
}
- console.log(
- `[Monthly Usage Checker] Organization ${orgData.name} is over limit. Added ${siteIds.length} sites to blocked list.`,
+ this.logger.info(
+ `Organization ${orgData.name} is over limit. Added ${siteIds.length} sites to blocked list.`,
);
} else {
for (const siteId of siteIds) {
@@ -254,21 +258,19 @@ class UsageService {
// Format additional date info for logging if available
const periodInfo = periodStart ? `period started ${periodStart}` : "this month";
- console.log(
- `[Monthly Usage Checker] Updated organization ${
+ this.logger.info(
+ `Updated organization ${
orgData.name
}: ${pageviewCount.toLocaleString()} events, limit ${eventLimit.toLocaleString()}, ${periodInfo}`,
);
} catch (error) {
- console.error(`[Monthly Usage Checker] Error processing organization ${orgData.id}:`, error);
+ this.logger.error(error as Error, `Error processing organization ${orgData.id}`);
}
}
- console.log(
- `[Monthly Usage Checker] Completed monthly event usage check. ${this.sitesOverLimit.size} sites are over their limit.`,
- );
+ this.logger.info(`Completed monthly event usage check. ${this.sitesOverLimit.size} sites are over their limit.`);
} catch (error) {
- console.error("[Monthly Usage Checker] Error updating monthly usage:", error);
+ this.logger.error(error as Error, "Error updating monthly usage");
}
}
@@ -278,7 +280,7 @@ class UsageService {
public stopUsageCheckCron() {
if (this.usageCheckTask) {
this.usageCheckTask.stop();
- console.log("[UsageCheckerService] Monthly usage check cron stopped");
+ this.logger.info("Monthly usage check cron stopped");
}
}
}