infront-logger 1.1.1 → 1.1.3

package/dist/index.es.js

@@ -9,7 +9,7 @@ const colors = {
   debug: "white"
 };
 addColors(colors);
-const OPTIONS = {
+const OPTIONS$1 = {
   dirname: "logs",
   levels: {
     error: 0,
@@ -101,7 +101,7 @@ function createTransport(options) {
 }
 class Logger {
   constructor(options = {}) {
-    this.options = { ...OPTIONS, ...options };
+    this.options = { ...OPTIONS$1, ...options };
     if (!this.options.filename.includes("."))
       this.options.filename += ".log";
     if (!this.options.errorFilename.includes("."))
@@ -241,6 +241,7 @@ function stats() {
 }
 class BaseLogger {
   constructor(component, options) {
+    this.options = options;
     this.logger = new Logger(options).logger.child({ component });
     this.ctx = {};
     this.startTime = Date.now();
@@ -391,10 +392,18 @@ const ops = [
   "aggregate",
   "save"
 ];
-const MAX_RESULT_BYTES = 100 * 1024;
+const explained = [
+  "find",
+  "findOne"
+];
+const OPTIONS = {
+  maxResBytes: 100 * 1024,
+  logRes: true,
+  explain: false
+};
 class MongooseLogger extends BaseLogger {
   constructor(options = {}) {
-    super("database", options);
+    super("database", { ...OPTIONS, ...options });
   }
   operation(o) {
     this.ctx.operation = o;
@@ -416,26 +425,40 @@ class MongooseLogger extends BaseLogger {
     this.ctx.pipeline = p;
     return this;
   }
+  async explain(query) {
+    if (this.options.explain && !query.options.explain) {
+      this.ctx.explain = await query.clone().explain();
+    }
+  }
   result(res) {
     try {
       this.ctx.resultSizeBytes = JSON.stringify(res).length;
+      this.ctx.resultLength = Array.isArray(res) ? res.length : res ? 1 : 0;
     } catch (err) {
     }
+    if (!this.options.logRes)
+      return this;
     if (Array.isArray(res)) {
       this.ctx.documentCount = res.length;
-    } else if (this.ctx.resultSizeBytes < MAX_RESULT_BYTES) {
+    } else if (this.ctx.resultSizeBytes < this.options.maxResBytes) {
       this.ctx.result = res;
     } else {
-      this.ctx.result = `Result too long (more then ${MAX_RESULT_BYTES} bytes)`;
+      this.ctx.result = `Result too long (more then ${this.options.maxResBytes} bytes)`;
     }
     return this;
   }
 }
-function postHook(target, res) {
-  var _a, _b, _c, _d, _e;
+async function postHook(target, res) {
+  var _a, _b, _c, _d, _e, _f;
+  if (target.options.explain)
+    return;
   const op = target.constructor.name === "Aggregate" ? "aggregate" : target.op || target.$op;
   const collection = ((_a = target == null ? void 0 : target._collection) == null ? void 0 : _a.collectionName) || ((_b = target == null ? void 0 : target.collection) == null ? void 0 : _b.name) || ((_d = (_c = target == null ? void 0 : target._model) == null ? void 0 : _c.collection) == null ? void 0 : _d.collectionName);
-  (_e = target == null ? void 0 : target.logger) == null ? void 0 : _e.operation(op).collection(collection).query(target._conditions).update(target._update).pipeline(target._pipeline).profile().result(res).info(`DB query: ${op} - ${collection}`);
+  (_e = target == null ? void 0 : target.logger) == null ? void 0 : _e.operation(op).collection(collection).query(target._conditions).update(target._update).pipeline(target._pipeline).profile().result(res);
+  if (explained.includes(op)) {
+    await (target == null ? void 0 : target.logger.explain(target));
+  }
+  (_f = target == null ? void 0 : target.logger) == null ? void 0 : _f.info(`DB query: ${op} - ${collection}`);
 }
 function plugin(options = {}) {
   return (schema) => {

package/dist/index.umd.js

@@ -13,7 +13,7 @@
     debug: "white"
   };
   addColors(colors);
-  const OPTIONS = {
+  const OPTIONS$1 = {
     dirname: "logs",
     levels: {
       error: 0,
@@ -105,7 +105,7 @@
   }
   class Logger {
     constructor(options = {}) {
-      this.options = { ...OPTIONS, ...options };
+      this.options = { ...OPTIONS$1, ...options };
       if (!this.options.filename.includes("."))
         this.options.filename += ".log";
       if (!this.options.errorFilename.includes("."))
@@ -245,6 +245,7 @@
   }
   class BaseLogger {
     constructor(component, options) {
+      this.options = options;
       this.logger = new Logger(options).logger.child({ component });
       this.ctx = {};
       this.startTime = Date.now();
@@ -395,10 +396,18 @@
     "aggregate",
     "save"
   ];
-  const MAX_RESULT_BYTES = 100 * 1024;
+  const explained = [
+    "find",
+    "findOne"
+  ];
+  const OPTIONS = {
+    maxResBytes: 100 * 1024,
+    logRes: true,
+    explain: false
+  };
   class MongooseLogger extends BaseLogger {
     constructor(options = {}) {
-      super("database", options);
+      super("database", { ...OPTIONS, ...options });
     }
     operation(o) {
       this.ctx.operation = o;
@@ -420,26 +429,40 @@
       this.ctx.pipeline = p;
       return this;
     }
+    async explain(query) {
+      if (this.options.explain && !query.options.explain) {
+        this.ctx.explain = await query.clone().explain();
+      }
+    }
     result(res) {
       try {
         this.ctx.resultSizeBytes = JSON.stringify(res).length;
+        this.ctx.resultLength = Array.isArray(res) ? res.length : res ? 1 : 0;
       } catch (err) {
       }
+      if (!this.options.logRes)
+        return this;
       if (Array.isArray(res)) {
         this.ctx.documentCount = res.length;
-      } else if (this.ctx.resultSizeBytes < MAX_RESULT_BYTES) {
+      } else if (this.ctx.resultSizeBytes < this.options.maxResBytes) {
         this.ctx.result = res;
       } else {
-        this.ctx.result = `Result too long (more then ${MAX_RESULT_BYTES} bytes)`;
+        this.ctx.result = `Result too long (more then ${this.options.maxResBytes} bytes)`;
       }
       return this;
     }
   }
-  function postHook(target, res) {
-    var _a, _b, _c, _d, _e;
+  async function postHook(target, res) {
+    var _a, _b, _c, _d, _e, _f;
+    if (target.options.explain)
+      return;
     const op = target.constructor.name === "Aggregate" ? "aggregate" : target.op || target.$op;
     const collection = ((_a = target == null ? void 0 : target._collection) == null ? void 0 : _a.collectionName) || ((_b = target == null ? void 0 : target.collection) == null ? void 0 : _b.name) || ((_d = (_c = target == null ? void 0 : target._model) == null ? void 0 : _c.collection) == null ? void 0 : _d.collectionName);
-    (_e = target == null ? void 0 : target.logger) == null ? void 0 : _e.operation(op).collection(collection).query(target._conditions).update(target._update).pipeline(target._pipeline).profile().result(res).info(`DB query: ${op} - ${collection}`);
+    (_e = target == null ? void 0 : target.logger) == null ? void 0 : _e.operation(op).collection(collection).query(target._conditions).update(target._update).pipeline(target._pipeline).profile().result(res);
+    if (explained.includes(op)) {
+      await (target == null ? void 0 : target.logger.explain(target));
+    }
+    (_f = target == null ? void 0 : target.logger) == null ? void 0 : _f.info(`DB query: ${op} - ${collection}`);
   }
   function plugin(options = {}) {
     return (schema) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "infront-logger",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "",
   "files": [
     "dist"