πΈ Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Enhance logging across services for improved clarity and consistency
Bill Yang63ce728da98e
diff --git a/server/src/lib/logger/LOGGING.md b/server/src/lib/logger/LOGGING.mdindex 1e41f6ca9..75ae5d8af 100644--- a/server/src/lib/logger/LOGGING.md+++ b/server/src/lib/logger/LOGGING.md@@ -7,6 +7,7 @@ This Fastify backend uses Pino for structured JSON logging. In production, logs## ConfigurationLogging 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)@@ -14,50 +15,54 @@ Logging is configured in `src/index.ts` when creating the Fastify instance:## Usage Patterns### 1. Route Handlers+In route handlers, use `request.log`:```typescriptexport async function getUsers(request: FastifyRequest, reply: FastifyReply) {- request.log.info('Fetching users');-+ request.log.info("Fetching users");+try {const users = await fetchUsers();- request.log.debug({ userCount: users.length }, 'Users fetched successfully');+ request.log.debug({ userCount: users.length }, "Users fetched successfully");return users;} catch (error) {- request.log.error(error, 'Failed to fetch users');+ 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';+import { createServiceLogger } from "../../lib/logger/logger.js";export class MyService {- private logger = createServiceLogger('my-service');-+ private logger = createServiceLogger("my-service");+async doSomething() {- this.logger.info('Starting operation');+ 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');+server.log.info("Server started on port 3001");+server.log.error(error, "Shutdown error");```## Log LevelsUse appropriate levels for different scenarios:+- `fatal`: Application is unusable, will exit- `error`: Error conditions (exceptions, failures)- `warn`: Warning conditions (deprecations, recoverable issues)@@ -68,34 +73,39 @@ Use appropriate levels for different scenarios:## Best Practices1. **Structure your logs**: Pass objects as the first parameter for structured data+```typescript- logger.info({ userId: 123, action: 'login' }, 'User logged in');+ 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');+ 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');+ 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+ 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' });+ const logger = parentLogger.child({ service: "uptime" });```## Migration from console.logReplace console statements with appropriate logger calls:+- `console.log()` β `logger.info()`- `console.error()` β `logger.error()`- `console.warn()` β `logger.warn()`@@ -104,12 +114,14 @@ Replace console statements with appropriate logger calls:### 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@@ -122,24 +134,26 @@ Replace console statements with appropriate logger calls:## Example Service RefactoringBefore:+```typescript-console.log('Service starting...');-console.error('Failed to connect:', error);+console.log("Service starting...");+console.error("Failed to connect:", error);```After:+```typescript-import { createServiceLogger } from '../../lib/logger.js';+import { createServiceLogger } from "../../lib/logger/logger.js";class MyService {- private logger = createServiceLogger('my-service');-+ private logger = createServiceLogger("my-service");+start() {- this.logger.info('Service starting...');+ this.logger.info("Service starting...");}-+handleError(error: Error) {- this.logger.error(error, 'Failed to connect');+ this.logger.error(error, "Failed to connect");}}-```\ No newline at end of file+```diff --git a/server/src/lib/twilio.ts b/server/src/lib/twilio.tsindex 4dc078551..b4aa8f538 100644--- a/server/src/lib/twilio.ts+++ b/server/src/lib/twilio.ts@@ -1,5 +1,8 @@import twilio from "twilio";import { IS_CLOUD } from "./const.js";+import { createServiceLogger } from "./logger/logger.js";++const logger = createServiceLogger("twilio");let twilioClient: ReturnType<typeof twilio> | undefined;@@ -13,12 +16,12 @@ export const sendSMS = async (message: string): Promise<{ success: boolean; error?: string }> => {if (!twilioClient) {- console.log("[SMS] Twilio client not initialized - skipping SMS notification");+ logger.info("Twilio client not initialized - skipping SMS notification");return { success: false, error: "SMS not configured" };}if (!process.env.TWILIO_PHONE_NUMBER) {- console.error("[SMS] TWILIO_PHONE_NUMBER not configured");+ logger.error("TWILIO_PHONE_NUMBER not configured");return { success: false, error: "SMS sender not configured" };}@@ -29,10 +32,10 @@ export const sendSMS = async (to: phoneNumber,});- console.log(`[SMS] Successfully sent SMS to ${phoneNumber}, SID: ${result.sid}`);+ logger.info({ phoneNumber, sid: result.sid }, "Successfully sent SMS");return { success: true };} catch (error) {- console.error("[SMS] Failed to send SMS:", error);+ logger.error({ phoneNumber, error }, "Failed to send SMS");return {success: false,error: error instanceof Error ? error.message : "Failed to send SMS"diff --git a/server/src/services/shared/requestValidation.ts b/server/src/services/shared/requestValidation.tsindex 2c06072a1..9089c8db8 100644--- a/server/src/services/shared/requestValidation.ts+++ b/server/src/services/shared/requestValidation.ts@@ -1,8 +1,11 @@+import { createServiceLogger } from "../../lib/logger/logger.js";import { apiKeyRateLimiter } from "../../lib/rateLimiter.js";import { siteConfig } from "../../lib/siteConfig.js";import { normalizeOrigin } from "../../utils.js";import { DISABLE_ORIGIN_CHECK } from "../tracker/const.js";+const logger = createServiceLogger("request-validation");+/*** Result of API key validation*/@@ -43,13 +46,13 @@ export async function validateApiKey(}if (site.apiKey && apiKey === site.apiKey) {- console.info(`[Validation] Valid API key for site ${siteId}`);+ logger.info({ siteId }, "Valid API key for site");return { success: true };}return { success: false, error: "Invalid API key" };} catch (error) {- console.error("Error validating API key:", error);+ logger.error(error, "Error validating API key");return { success: false, error: "Failed to validate API key" };}}@@ -68,10 +71,9 @@ export async function validateOrigin(try {// If origin checking is disabled, return successif (DISABLE_ORIGIN_CHECK) {- console.info(- `[Validation] Origin check disabled. Allowing request for site ${siteId} from origin: ${- requestOrigin || "none"- }`+ logger.info(+ { siteId, origin: requestOrigin || "none" },+ "Origin check disabled, allowing request");return { success: true };}@@ -130,7 +132,7 @@ export async function validateOrigin(};}} catch (error) {- console.error("Error validating origin:", error);+ logger.error(error, "Error validating origin");return {success: false,error: "Internal error validating origin",diff --git a/server/src/services/tracker/pageviewQueue.ts b/server/src/services/tracker/pageviewQueue.tsindex 049540e10..cdf7d484a 100644--- a/server/src/services/tracker/pageviewQueue.ts+++ b/server/src/services/tracker/pageviewQueue.ts@@ -1,6 +1,7 @@import { DateTime } from "luxon";import { clickhouse } from "../../db/clickhouse/clickhouse.js";import { getLocation } from "../../db/geolocation/geolocation.js";+import { createServiceLogger } from "../../lib/logger/logger.js";import { getDeviceType } from "../../utils.js";import { getChannel } from "./getChannel.js";import { clearSelfReferrer, getAllUrlParams } from "./utils.js";@@ -37,6 +38,7 @@ class PageviewQueue {private batchSize = 5000;private interval = 10000;private processing = false;+ private logger = createServiceLogger("pageview-queue");constructor() {// Start processing interval@@ -71,7 +73,7 @@ class PageviewQueue {geoData[ip] = { data: locationData };});} catch (error) {- console.error("Error getting geo data:", error);+ this.logger.error(error, "Error getting geo data");}// Process each pageview with its geo data@@ -127,7 +129,7 @@ class PageviewQueue {};});- console.info("bulk insert: ", processedPageviews.length);+ this.logger.info({ count: processedPageviews.length }, "Bulk insert to ClickHouse");// Bulk insert into databasetry {await clickhouse.insert({@@ -136,7 +138,7 @@ class PageviewQueue {format: "JSONEachRow",});} catch (error) {- console.error("Error processing pageview queue:", error);+ this.logger.error(error, "Error processing pageview queue");} finally {this.processing = false;}diff --git a/server/src/services/tracker/trackEvent.ts b/server/src/services/tracker/trackEvent.tsindex 4fbb58539..b366277bd 100644--- a/server/src/services/tracker/trackEvent.ts+++ b/server/src/services/tracker/trackEvent.ts@@ -1,6 +1,7 @@import { FastifyReply, FastifyRequest } from "fastify";import { isbot } from "isbot";import { z, ZodError } from "zod";+import { createServiceLogger } from "../../lib/logger/logger.js";import { siteConfig } from "../../lib/siteConfig.js";import { sessionsService } from "../sessions/sessionsService.js";import { checkApiKeyRateLimit, validateApiKey, validateOrigin } from "../shared/requestValidation.js";@@ -147,6 +148,8 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [.strict(),]);+const logger = createServiceLogger("track-event");+// Unified handler for all events (pageviews and custom events)export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {try {@@ -169,7 +172,7 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {// If API key validation failed with an error, reject the requestif (apiKeyValidation.error) {- console.warn(`[Tracking] Request rejected for site ${validatedPayload.site_id}: ${apiKeyValidation.error}`);+ logger.warn({ siteId: validatedPayload.site_id, error: apiKeyValidation.error }, "Request rejected - API key validation failed");return reply.status(403).send({success: false,error: apiKeyValidation.error,@@ -179,8 +182,9 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {// Check rate limit for API key authenticated requestsif (apiKeyValidation.success && validatedPayload.api_key) {if (!checkApiKeyRateLimit(validatedPayload.api_key)) {- console.warn(- `[Tracking] Rate limit exceeded for API key ${validatedPayload.api_key} on site ${validatedPayload.site_id}`,+ logger.warn(+ { apiKey: validatedPayload.api_key, siteId: validatedPayload.site_id },+ "Rate limit exceeded for API key");return reply.status(429).send({success: false,@@ -194,7 +198,7 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {const originValidation = await validateOrigin(validatedPayload.site_id, request.headers.origin as string);if (!originValidation.success) {- console.warn(`[Tracking] Request rejected for site ${validatedPayload.site_id}: ${originValidation.error}`);+ logger.warn({ siteId: validatedPayload.site_id, error: originValidation.error }, "Request rejected - origin validation failed");return reply.status(403).send({success: false,error: originValidation.error,@@ -211,8 +215,9 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {// Use custom user agent if provided, otherwise fall back to headerconst userAgent = validatedPayload.user_agent || (request.headers["user-agent"] as string);if (userAgent && isbot(userAgent)) {- console.log(- `[Tracking] Bot request filtered for site ${validatedPayload.site_id} from User-Agent: ${userAgent}`,+ logger.info(+ { siteId: validatedPayload.site_id, userAgent },+ "Bot request filtered");return reply.status(200).send({success: true,@@ -223,7 +228,7 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {// Check if the site has exceeded its monthly limitif (usageService.isSiteOverLimit(Number(validatedPayload.site_id))) {- console.log(`[Tracking] Skipping event for site ${validatedPayload.site_id} - over monthly limit`);+ logger.info({ siteId: validatedPayload.site_id }, "Skipping event - site over monthly limit");return reply.status(200).send("Site over monthly limit, event not tracked");}@@ -246,7 +251,7 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {success: true,});} catch (error) {- console.error("Error tracking event:", error);+ logger.error(error, "Error tracking event");if (error instanceof ZodError) {return reply.status(400).send({success: false,diff --git a/server/src/services/uptime/monitorScheduler.ts b/server/src/services/uptime/monitorScheduler.tsindex 12ed00aa4..ed6837784 100644--- a/server/src/services/uptime/monitorScheduler.ts+++ b/server/src/services/uptime/monitorScheduler.ts@@ -20,7 +20,7 @@ export class MonitorScheduler {...(process.env.REDIS_PASSWORD && { password: process.env.REDIS_PASSWORD }),};- this.logger.info(`BullMQ connecting to Redis at ${this.connection.host}:${this.connection.port}`);+ this.logger.info({ host: this.connection.host, port: this.connection.port }, "BullMQ connecting to Redis");this.queue = new Queue("monitor-checks", {connection: this.connection,@@ -56,7 +56,7 @@ export class MonitorScheduler {// Load and schedule all active monitorsawait this.loadAndScheduleMonitors();- console.log("[Uptime] BullMQ monitor scheduler initialized");+ this.logger.info("BullMQ monitor scheduler initialized");}private async clearStaleJobs(): Promise<void> {@@ -64,7 +64,7 @@ export class MonitorScheduler {// For Dragonfly compatibility, we'll clear jobs more carefully// First, try to get counts to see if there are any jobsconst counts = await this.queue.getJobCounts();- console.log("[Uptime] Current job counts:", counts);+ this.logger.debug({ counts }, "Current job counts");// Only try to clear if there are actually jobsif (counts.delayed > 0 || counts.waiting > 0 || counts.active > 0) {@@ -73,26 +73,26 @@ export class MonitorScheduler {const waitingJobs = await this.queue.getJobs(["waiting"]);const activeJobs = await this.queue.getJobs(["active"]);- console.log(`[Uptime] Found ${waitingJobs.length} waiting and ${activeJobs.length} active jobs`);+ this.logger.debug({ waitingJobs: waitingJobs.length, activeJobs: activeJobs.length }, "Found stale jobs");// Remove jobs individuallyfor (const job of [...waitingJobs, ...activeJobs]) {try {await job.remove();} catch (err) {- console.warn(`Failed to remove job ${job.id}:`, err);+ this.logger.warn({ jobId: job.id, error: err }, "Failed to remove job");}}- console.log("[Uptime] Cleared stale jobs");+ this.logger.info("Cleared stale jobs");} catch (err) {- console.warn("Could not clear all job types:", err);+ this.logger.warn({ error: err }, "Could not clear all job types");}} else {- console.log("[Uptime] No stale jobs to clear");+ this.logger.debug("No stale jobs to clear");}} catch (error) {- console.error("Error clearing stale jobs:", error);+ this.logger.error(error, "Error clearing stale jobs");// Continue anyway - this is not critical for startup}}@@ -102,14 +102,14 @@ export class MonitorScheduler {// Load all enabled monitorsconst monitors = await db.select().from(uptimeMonitors).where(eq(uptimeMonitors.enabled, true));- console.log(`[Uptime] Found ${monitors.length} enabled monitors`);+ this.logger.info({ monitorCount: monitors.length }, "Found enabled monitors");// Schedule each monitorfor (const monitor of monitors) {await this.scheduleMonitor(monitor.id, monitor.intervalSeconds);}} catch (error) {- console.error("Error loading monitors:", error);+ this.logger.error(error, "Error loading monitors");}}@@ -134,9 +134,9 @@ export class MonitorScheduler {jobId: jobName, // Use monitor ID as job ID to prevent duplicates});- console.log(`[Uptime] Scheduled monitor ${monitorId} to run every ${intervalSeconds} seconds (job: ${job.id})`);+ this.logger.info({ monitorId, intervalSeconds, jobId: job.id }, "Scheduled monitor");} catch (error) {- console.error(`Error scheduling monitor ${monitorId}:`, error);+ this.logger.error({ monitorId, error }, "Error scheduling monitor");}}@@ -163,14 +163,14 @@ export class MonitorScheduler {await job.remove();} catch (err) {// Ignore errors for jobs that can't be removed (e.g., repeat jobs)- console.warn(`Could not remove job ${job.id}:`, err);+ this.logger.warn({ jobId: job.id, error: err }, "Could not remove job");}}),);- console.log(`[Uptime] Removed schedule for monitor ${monitorId}`);+ this.logger.info({ monitorId }, "Removed schedule for monitor");} catch (error) {- console.error(`Error removing monitor schedule ${monitorId}:`, error);+ this.logger.error({ monitorId, error }, "Error removing monitor schedule");}}@@ -194,14 +194,14 @@ export class MonitorScheduler {removeOnFail: false,});- console.log(`[Uptime] Triggered immediate check for monitor ${monitorId} (job: ${job.id})`);+ this.logger.info({ monitorId, jobId: job.id }, "Triggered immediate check for monitor");} catch (error) {- console.error(`Error triggering immediate check for monitor ${monitorId}:`, error);+ this.logger.error({ monitorId, error }, "Error triggering immediate check for monitor");}}async shutdown(): Promise<void> {- console.log("[Uptime] Shutting down BullMQ monitor scheduler...");+ this.logger.info("Shutting down BullMQ monitor scheduler...");this.isShuttingDown = true;try {@@ -210,16 +210,16 @@ export class MonitorScheduler {Promise.race([this.queueEvents.close(),new Promise((_, reject) => setTimeout(() => reject(new Error("Queue events close timeout")), 3000)),- ]).catch((err) => console.error("Queue events close error:", err)),+ ]).catch((err) => this.logger.error(err, "Queue events close error")),Promise.race([this.queue.close(),new Promise((_, reject) => setTimeout(() => reject(new Error("Queue close timeout")), 3000)),- ]).catch((err) => console.error("Queue close error:", err)),+ ]).catch((err) => this.logger.error(err, "Queue close error")),]);- console.log("[Uptime] BullMQ monitor scheduler shut down successfully");+ this.logger.info("BullMQ monitor scheduler shut down successfully");} catch (error) {- console.error("Error during scheduler shutdown:", error);+ this.logger.error(error, "Error during scheduler shutdown");}}diff --git a/server/src/services/uptime/notificationService.ts b/server/src/services/uptime/notificationService.tsindex 19b70deae..652514e13 100644--- a/server/src/services/uptime/notificationService.ts+++ b/server/src/services/uptime/notificationService.ts@@ -2,6 +2,7 @@ import { DateTime } from "luxon";import { and, eq, InferSelectModel } from "drizzle-orm";import { db } from "../../db/postgres/postgres.js";import { notificationChannels } from "../../db/postgres/schema.js";+import { createServiceLogger } from "../../lib/logger/logger.js";import { sendEmail } from "../../lib/resend.js";import { sendSMS } from "../../lib/twilio.js";@@ -33,6 +34,8 @@ interface Incident {}export class NotificationService {+ private logger = createServiceLogger("notification-service");+async sendTestNotification(channel: NotificationChannel, monitor: Monitor, incident: Incident, eventType: "down" | "recovery"): Promise<void> {try {if (channel.type === "email" && channel.config.email) {@@ -51,7 +54,7 @@ export class NotificationService {await this.sendSMSNotification(channel.config.phoneNumber, monitor, incident, eventType);}} catch (error) {- console.error(`Failed to send test ${channel.type} notification:`, error);+ this.logger.error({ channelType: channel.type, error }, "Failed to send test notification");throw error;}}@@ -117,11 +120,11 @@ export class NotificationService {.set({ lastNotifiedAt: now.toISOString() }).where(eq(notificationChannels.id, channel.id));} catch (error) {- console.error(`Failed to send ${channel.type} notification for channel ${channel.id}:`, error);+ this.logger.error({ channelType: channel.type, channelId: channel.id, error }, "Failed to send notification");}}} catch (error) {- console.error("Failed to send incident notifications:", error);+ this.logger.error(error, "Failed to send incident notifications");}}@@ -175,7 +178,7 @@ export class NotificationService {}await sendEmail(email, subject, html);- console.log(`[Uptime] Sent ${eventType} email notification to ${email} for monitor ${monitor.id}`);+ this.logger.info({ eventType, email, monitorId: monitor.id }, "Sent email notification");}private async sendDiscordNotification(@@ -259,7 +262,7 @@ export class NotificationService {throw new Error(`Discord webhook failed: ${response.status} ${response.statusText}`);}- console.log(`[Uptime] Sent ${eventType} Discord notification for monitor ${monitor.id}`);+ this.logger.info({ eventType, monitorId: monitor.id }, "Sent Discord notification");}private async sendSlackNotification(@@ -355,7 +358,7 @@ export class NotificationService {throw new Error(`Slack webhook failed: ${response.status} ${response.statusText}`);}- console.log(`[Uptime] Sent ${eventType} Slack notification for monitor ${monitor.id}`);+ this.logger.info({ eventType, monitorId: monitor.id }, "Sent Slack notification");}private async sendSMSNotification(@@ -398,6 +401,6 @@ export class NotificationService {throw new Error(result.error || "Failed to send SMS");}- console.log(`[Uptime] Sent ${eventType} SMS notification to ${phoneNumber} for monitor ${monitor.id}`);+ this.logger.info({ eventType, phoneNumber, monitorId: monitor.id }, "Sent SMS notification");}}diff --git a/server/src/services/uptime/regionHealthChecker.ts b/server/src/services/uptime/regionHealthChecker.tsindex bcf2c6afa..d841a05f1 100644--- a/server/src/services/uptime/regionHealthChecker.ts+++ b/server/src/services/uptime/regionHealthChecker.ts@@ -65,9 +65,9 @@ export class RegionHealthChecker {}const healthyCount = results.filter((r) => r.isHealthy).length;- console.log(`[Uptime] Region health check complete: ${healthyCount}/${remoteRegions.length} regions healthy`);+ this.logger.info({ healthyCount, totalRegions: remoteRegions.length }, "Region health check complete");} catch (error) {- console.error("Error in region health check:", error);+ this.logger.error(error, "Error in region health check");}}@@ -79,7 +79,7 @@ export class RegionHealthChecker {});if (!response.ok) {- console.warn(`Region ${region.code} returned status ${response.status}`);+ this.logger.warn({ regionCode: region.code, status: response.status }, "Region returned non-ok status");return { region, isHealthy: false };}@@ -90,10 +90,10 @@ export class RegionHealthChecker {return { region, isHealthy: true };}- console.warn(`Region ${region.code} returned unexpected response:`, data);+ this.logger.warn({ regionCode: region.code, response: data }, "Region returned unexpected response");return { region, isHealthy: false };} catch (error) {- console.error(`Health check failed for region ${region.code}:`, error);+ this.logger.error({ regionCode: region.code, error }, "Health check failed for region");return { region, isHealthy: false };}}