chore(logs): improve mongo and graphql logs

Author: neSpecc

src/index.ts

@@ -26,8 +26,8 @@ import PlansFactory from './models/plansFactory';
 import BusinessOperationsFactory from './models/businessOperationsFactory';
 import schema from './schema';
 import { graphqlUploadExpress } from 'graphql-upload';
-import morgan from 'morgan';
 import { metricsMiddleware, createMetricsServer, graphqlMetricsPlugin } from './metrics';
+import { requestLogger } from './utils/logger';
 
 /**
  * Option to enable playground
@@ -85,19 +85,17 @@ class HawkAPI {
       next();
     });
 
-    /**
-     * Setup request logger.
-     * Uses 'combined' format in production for Apache-style logging,
-     * and 'dev' format in development for colored, concise output.
-     */
-    this.app.use(morgan(process.env.NODE_ENV === 'production' ? 'combined' : 'dev'));
-
     /**
      * Add metrics middleware to track HTTP requests
      */
     this.app.use(metricsMiddleware);
 
     this.app.use(express.json());
+
+    /**
+     * Setup request logger with custom formatters (GraphQL operation name support)
+     */
+    this.app.use(requestLogger);
     this.app.use(bodyParser.urlencoded({ extended: false }));
     this.app.use('/static', express.static(`./static`));
 

src/metrics/mongodb.ts

@@ -113,12 +113,70 @@ export function withMongoMetrics(options: MongoClientOptions = {}): MongoClientO
   };
 }
 
+/**
+ * Format filter/update parameters for logging
+ * @param params - Parameters to format
+ * @returns Formatted string
+ */
+function formatParams(params: any): string {
+  if (!params || Object.keys(params).length === 0) {
+    return '';
+  }
+
+  try {
+    return JSON.stringify(params);
+  } catch (e) {
+    return String(params);
+  }
+}
+
+/**
+ * Log MongoDB command details to console
+ * Format: [requestId] db.collection.command(params)
+ * @param event - MongoDB command event
+ */
+function logCommandStarted(event: any): void {
+  const collectionRaw = extractCollectionFromCommand(event.command, event.commandName);
+  const collection = normalizeCollectionName(collectionRaw);
+  const db = event.databaseName || 'unknown db';
+  const filter = event.command.filter;
+  const update = event.command.update;
+  const pipeline = event.command.pipeline;
+  const projection = event.command.projection;
+  const params = filter || update || pipeline;
+  const paramsStr = formatParams(params);
+
+  console.log(`[${event.requestId}] ${db}.${collection}.${event.commandName}(${paramsStr}) ${projection ? `projection: ${formatParams(projection)}` : ''}`);
+}
+
+/**
+ * Log MongoDB command success to console
+ * Format: [requestId] commandName ✓ duration
+ * @param event - MongoDB command event
+ */
+function logCommandSucceeded(event: any): void {
+  console.log(`[${event.requestId}] ${event.commandName} ✓ ${event.duration}ms`);
+}
+
+/**
+ * Log MongoDB command failure to console
+ * Format: [requestId] ✗ error
+ * @param event - MongoDB command event
+ */
+function logCommandFailed(event: any): void {
+  const errorMsg = event.failure?.message || event.failure?.errmsg || 'Unknown error';
+
+  console.error(`[${event.requestId}] ${event.commandName} ✗ ${errorMsg} (${event.duration}ms)`);
+}
+
 /**
  * Setup MongoDB metrics monitoring on a MongoClient
  * @param client - MongoDB client to monitor
  */
 export function setupMongoMetrics(client: MongoClient): void {
   client.on('commandStarted', (event) => {
+    logCommandStarted(event);
+
     // Store start time and metadata for this command
     const metadataKey = `${event.requestId}`;
 
@@ -139,6 +197,8 @@ export function setupMongoMetrics(client: MongoClient): void {
   });
 
   client.on('commandSucceeded', (event) => {
+    logCommandSucceeded(event);
+
     const metadataKey = `${event.requestId}`;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const metadata = (client as any)[metadataKey];
@@ -157,6 +217,8 @@ export function setupMongoMetrics(client: MongoClient): void {
   });
 
   client.on('commandFailed', (event) => {
+    logCommandFailed(event);
+
     const metadataKey = `${event.requestId}`;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const metadata = (client as any)[metadataKey];

src/models/eventsFactory.js

@@ -665,7 +665,7 @@ class EventsFactory extends Factory {
   async getEventRelease(eventId) {
     const eventOriginal = await this.findById(eventId);
 
-    if (!eventOriginal) {
+    if (!eventOriginal || !eventOriginal.payload.release) {
       return null;
     }
 

src/mongo.ts

@@ -75,7 +75,9 @@ export async function setupConnections(): Promise<void> {
     databases.hawk = hawkMongoClient.db();
     databases.events = eventsMongoClient.db();
 
-    // Setup metrics monitoring for both clients
+    /**
+     * Log and and measure MongoDB metrics
+     */
     setupMongoMetrics(hawkMongoClient);
     setupMongoMetrics(eventsMongoClient);
   } catch (e) {

src/utils/logger.ts

@@ -0,0 +1,37 @@
+import morgan from 'morgan';
+import express from 'express';
+
+/**
+ * Setup custom GraphQL-aware morgan token.
+ * Extracts operation name from GraphQL requests to show query/mutation names in logs.
+ */
+morgan.token('graphql-operation', (req: express.Request) => {
+  if (req.body && req.body.operationName) {
+    return req.body.operationName;
+  }
+  if (req.body && req.body.query) {
+    /* Try to extract operation name from query string if operationName is not provided */
+    const match = req.body.query.match(/(?:query|mutation)\s+(\w+)/);
+
+    if (match && match[1]) {
+      return match[1];
+    }
+  }
+
+  return '-';
+});
+
+/**
+ * Custom morgan format for GraphQL-aware logging.
+ * Development: shows method, url, operation name, status, response time, content length
+ * Production: Apache-style format with operation name included
+ */
+const customFormat = process.env.NODE_ENV === 'production'
+  ? ':remote-addr - :remote-user [:date[clf]] ":method :url :graphql-operation" :status :res[content-length] - :response-time ms'
+  : ':method :url :graphql-operation :status :response-time ms - :res[content-length]';
+
+/**
+ * Configured morgan middleware with GraphQL operation name logging
+ */
+export const requestLogger = morgan(customFormat);
+