@naturalcycles/nodejs-lib 12.37.0 → 12.38.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [12.38.0](https://github.com/NaturalCycles/nodejs-lib/compare/v12.37.0...v12.38.0) (2021-10-06)
+
+
+### Features
+
+* TransformLogOptions.peakRSS to log peak rss ([4602565](https://github.com/NaturalCycles/nodejs-lib/commit/4602565c8e52d17d8bd975f73e0f2bd6df03cf8b))
+
 # [12.37.0](https://github.com/NaturalCycles/nodejs-lib/compare/v12.36.0...v12.37.0) (2021-10-04)
 
 

package/dist/stream/transform/transformLogProgress.d.ts

@@ -24,6 +24,12 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
      * @default true
      */
     rss?: boolean;
+    /**
+     * Incude Peak RSS in log.
+     *
+     * @default false
+     */
+    peakRSS?: boolean;
     /**
      * Include `external` in log.
      *
@@ -50,15 +56,16 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
      */
     logRPS?: boolean;
     /**
-     * @default true
      * Set to false to disable logging progress
+     *
+     * @default true
      */
     logProgress?: boolean;
     /**
      * Log progress event Nth record that is _processed_ (went through mapper).
+     * Set to 0 to disable logging.
      *
      * @default 1000
-     * Set to 0 to disable logging.
      */
     logEvery?: number;
     /**

package/dist/stream/transform/transformLogProgress.js

@@ -8,13 +8,13 @@ const time_lib_1 = require("@naturalcycles/time-lib");
 const colors_1 = require("../../colors");
 const inspectOpt = {
     colors: true,
-    breakLength: 200,
+    breakLength: 300,
 };
 /**
  * Pass-through transform that optionally logs progress.
  */
 function transformLogProgress(opt = {}) {
-    const { metric = 'progress', heapTotal: logHeapTotal = false, heapUsed: logHeapUsed = true, rss: logRss = true, logRPS = true, logEvery = 1000, extra, } = opt;
+    const { metric = 'progress', heapTotal: logHeapTotal = false, heapUsed: logHeapUsed = true, rss: logRss = true, peakRSS: logPeakRSS = false, logRPS = true, logEvery = 1000, extra, } = opt;
     const logProgress = opt.logProgress !== false && logEvery !== 0; // true by default
     const logEvery10 = logEvery * 10;
     const started = Date.now();
@@ -22,6 +22,7 @@ function transformLogProgress(opt = {}) {
     const sma = new js_lib_1.SimpleMovingAverage(10); // over last 10 seconds
     let processedLastSecond = 0;
     let progress = 0;
+    let peakRSS = 0;
     logStats(); // initial
     return new stream_1.Transform({
         objectMode: true,
@@ -49,12 +50,15 @@ function transformLogProgress(opt = {}) {
         lastSecondStarted = now;
         processedLastSecond = 0;
         const rps10 = Math.round(sma.push(lastRPS));
+        if (mem.rss > peakRSS)
+            peakRSS = mem.rss;
         console.log((0, util_1.inspect)({
             [final ? `${metric}_final` : metric]: progress,
             ...(extra ? extra(chunk, progress) : {}),
             ...(logHeapUsed ? { heapUsed: (0, js_lib_1._mb)(mem.heapUsed) } : {}),
             ...(logHeapTotal ? { heapTotal: (0, js_lib_1._mb)(mem.heapTotal) } : {}),
             ...(logRss ? { rss: (0, js_lib_1._mb)(mem.rss) } : {}),
+            ...(logPeakRSS ? { peakRSS: (0, js_lib_1._mb)(peakRSS) } : {}),
             ...(opt.rssMinusHeap ? { rssMinusHeap: (0, js_lib_1._mb)(mem.rss - mem.heapTotal) } : {}),
             ...(opt.external ? { external: (0, js_lib_1._mb)(mem.external) } : {}),
             ...(opt.arrayBuffers ? { arrayBuffers: (0, js_lib_1._mb)(mem.arrayBuffers || 0) } : {}),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "12.37.0",
+  "version": "12.38.0",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",

package/src/stream/transform/transformLogProgress.ts

@@ -34,6 +34,13 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
    */
   rss?: boolean
 
+  /**
+   * Incude Peak RSS in log.
+   *
+   * @default false
+   */
+  peakRSS?: boolean
+
   /**
    * Include `external` in log.
    *
@@ -64,16 +71,17 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
   logRPS?: boolean
 
   /**
-   * @default true
    * Set to false to disable logging progress
+   *
+   * @default true
    */
   logProgress?: boolean
 
   /**
    * Log progress event Nth record that is _processed_ (went through mapper).
+   * Set to 0 to disable logging.
    *
    * @default 1000
-   * Set to 0 to disable logging.
    */
   logEvery?: number
 
@@ -87,7 +95,7 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
 
 const inspectOpt: InspectOptions = {
   colors: true,
-  breakLength: 200,
+  breakLength: 300,
 }
 
 /**
@@ -101,6 +109,7 @@ export function transformLogProgress<IN = any>(
     heapTotal: logHeapTotal = false,
     heapUsed: logHeapUsed = true,
     rss: logRss = true,
+    peakRSS: logPeakRSS = false,
     logRPS = true,
     logEvery = 1000,
     extra,
@@ -113,6 +122,7 @@ export function transformLogProgress<IN = any>(
   const sma = new SimpleMovingAverage(10) // over last 10 seconds
   let processedLastSecond = 0
   let progress = 0
+  let peakRSS = 0
 
   logStats() // initial
 
@@ -138,6 +148,7 @@ export function transformLogProgress<IN = any>(
 
   function logStats(chunk?: IN, final = false, tenx = false): void {
     if (!logProgress) return
+
     const mem = process.memoryUsage()
 
     const now = Date.now()
@@ -147,6 +158,7 @@ export function transformLogProgress<IN = any>(
     processedLastSecond = 0
 
     const rps10 = Math.round(sma.push(lastRPS))
+    if (mem.rss > peakRSS) peakRSS = mem.rss
 
     console.log(
       inspect(
@@ -156,6 +168,7 @@ export function transformLogProgress<IN = any>(
           ...(logHeapUsed ? { heapUsed: _mb(mem.heapUsed) } : {}),
           ...(logHeapTotal ? { heapTotal: _mb(mem.heapTotal) } : {}),
           ...(logRss ? { rss: _mb(mem.rss) } : {}),
+          ...(logPeakRSS ? { peakRSS: _mb(peakRSS) } : {}),
           ...(opt.rssMinusHeap ? { rssMinusHeap: _mb(mem.rss - mem.heapTotal) } : {}),
           ...(opt.external ? { external: _mb(mem.external) } : {}),
           ...(opt.arrayBuffers ? { arrayBuffers: _mb(mem.arrayBuffers || 0) } : {}),