w-syslog 1.0.0

package/docs/styles/prettify.css

@@ -0,0 +1,80 @@
+.pln {
+  color: #ddd;
+}
+
+/* string content */
+.str {
+  color: #61ce3c;
+}
+
+/* a keyword */
+.kwd {
+  color: #fbde2d;
+}
+
+/* a comment */
+.com {
+  color: #aeaeae;
+}
+
+/* a type name */
+.typ {
+  color: #8da6ce;
+}
+
+/* a literal value */
+.lit {
+  color: #fbde2d;
+}
+
+/* punctuation */
+.pun {
+  color: #ddd;
+}
+
+/* lisp open bracket */
+.opn {
+  color: #000000;
+}
+
+/* lisp close bracket */
+.clo {
+  color: #000000;
+}
+
+/* a markup tag name */
+.tag {
+  color: #8da6ce;
+}
+
+/* a markup attribute name */
+.atn {
+  color: #fbde2d;
+}
+
+/* a markup attribute value */
+.atv {
+  color: #ddd;
+}
+
+/* a declaration */
+.dec {
+  color: #EF5050;
+}
+
+/* a variable name */
+.var {
+  color: #c82829;
+}
+
+/* a function name */
+.fun {
+  color: #4271ae;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin-top: 0;
+  margin-bottom: 0;
+  padding-bottom: 2px;
+}

package/g.mjs

@@ -0,0 +1,27 @@
+import fs from 'fs'
+import _ from 'lodash-es'
+import w from 'wsemi'
+import WSyslog from './src/WSyslog.mjs'
+
+
+w.fsCleanFolder('./logs')
+
+let log = await WSyslog()
+log.info({ event: 'runner', msg: 'start' })
+log.warn({ event: 'monitor-memory', msg: 'usage-high' })
+log.error({ event: 'crash', msg: 'db connection', code: 500 })
+
+await w.delay(2000) //等待2秒讓pino能flush數據
+
+let vpfs = w.fsTreeFolder('./logs')
+// console.log('vpfs', vpfs)
+
+let fp = _.get(vpfs, `0.path`, '')
+
+let jj = fs.readFileSync(fp, 'utf8')
+console.log(jj)
+// {"level":30,"time":1751780174415,"pid":24144,"hostname":"DESKTOP-6R7USAO","event":"runner","msg":"start"}
+// {"level":40,"time":1751780174415,"pid":24144,"hostname":"DESKTOP-6R7USAO","event":"monitor-memory","msg":"usage-high"}
+// {"level":50,"time":1751780174415,"pid":24144,"hostname":"DESKTOP-6R7USAO","event":"crash","msg":"db connection","code":500}
+
+//node g.mjs

package/logs/2025-07-06.log

@@ -0,0 +1,4 @@
+{"level":30,"time":1751780174415,"pid":24144,"hostname":"DESKTOP-6R7USAO","event":"runner","msg":"start"}
+{"level":40,"time":1751780174415,"pid":24144,"hostname":"DESKTOP-6R7USAO","event":"monitor-memory","msg":"usage-high"}
+{"level":50,"time":1751780174415,"pid":24144,"hostname":"DESKTOP-6R7USAO","event":"crash","msg":"db connection","code":500}
+

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "w-syslog",
+  "version": "1.0.0",
+  "main": "dist/w-syslog.umd.js",
+  "dependencies": {
+    "lodash-es": "^4.17.21",
+    "node-disk-info": "^1.3.0",
+    "node-os-utils": "^1.3.7",
+    "pino": "^9.7.0",
+    "wsemi": "^1.8.11"
+  },
+  "devDependencies": {
+    "w-package-tools": "^1.1.2"
+  },
+  "scripts": {
+    "test": "mocha --parallel --timeout 60000",
+    "deploy": "gh-pages -d docs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yuda-lyu/w-syslog.git"
+  },
+  "keywords": [
+    "package",
+    "tool",
+    "log",
+    "pino",
+    "node"
+  ],
+  "author": "yuda-lyu(semisphere)",
+  "license": "MIT"
+}

package/script.txt

@@ -0,0 +1,18 @@
+#node toolg/addVersion.mjs
+node toolg/modifyReadme.mjs
+
+node toolg/cleanFolder.mjs
+./node_modules/.bin/jsdoc -c .jsdoc
+
+node toolg/gDistRollup.mjs
+
+git add .  -A
+git commit -m 'modify: '
+git push origin master:master
+
+npm run deploy
+
+#npm test
+
+#npm publish
+

package/src/WSyslog.mjs

@@ -0,0 +1,93 @@
+import path from 'path'
+import { fileURLToPath } from 'url'
+import get from 'lodash-es/get.js'
+import isestr from 'wsemi/src/isestr.mjs'
+import pino from 'pino'
+
+
+// __dirname
+let __filename = fileURLToPath(import.meta.url)
+let __dirname = path.dirname(__filename)
+
+
+/**
+ * 輸出log
+ *
+ * @class
+ * @param {Object} [opt={}] 輸入設定物件，預設{}
+ * @param {String} [opt.timeCpuUsage=200] 輸入偵測CPU使用率時取樣時間數字，單位ms，預設200
+ * @returns {Object} 回傳事件物件
+ * @example
+ * import fs from 'fs'
+ * import _ from 'lodash-es'
+ * import w from 'wsemi'
+ * import WSyslog from './src/WSyslog.mjs'
+ *
+ * w.fsCleanFolder('./logs')
+ *
+ * let log = await WSyslog()
+ * log.info({ event: 'runner', msg: 'start' })
+ * log.warn({ event: 'monitor-memory', msg: 'usage-high' })
+ * log.error({ event: 'crash', msg: 'db connection', code: 500 })
+ *
+ * await w.delay(2000) //等待2秒讓pino能flush數據
+ *
+ * let vpfs = w.fsTreeFolder('./logs')
+ * // console.log('vpfs', vpfs)
+ *
+ * let fp = _.get(vpfs, `0.path`, '')
+ *
+ * let jj = fs.readFileSync(fp, 'utf8')
+ * console.log(jj)
+ * // {"level":30,"time":1751780174415,"pid":24144,"hostname":"DESKTOP-6R7USAO","event":"runner","msg":"start"}
+ * // {"level":40,"time":1751780174415,"pid":24144,"hostname":"DESKTOP-6R7USAO","event":"monitor-memory","msg":"usage-high"}
+ * // {"level":50,"time":1751780174415,"pid":24144,"hostname":"DESKTOP-6R7USAO","event":"crash","msg":"db connection","code":500}
+ *
+ */
+async function WSyslog(opt = {}) {
+
+    //fdLog
+    let fdLog = get(opt, 'fdLog')
+    if (!isestr(fdLog)) {
+        fdLog = './logs'
+    }
+
+    //interval
+    let interval = get(opt, 'interval')
+    if (interval !== 'day' && interval !== 'hr') {
+        interval = 'day'
+    }
+
+    // 建立 logger，使用自訂 transport
+    let transport = pino.transport({
+        targets: [
+            {
+
+                // fatal: 60
+                // error: 50
+                // warn: 40
+                // info: 30
+                // debug: 20
+                // trace: 10
+                level: 'info', //僅紀錄info(30)以上
+
+                target: path.resolve(__dirname, './formatter.mjs'),
+
+                options: {
+                    interval,
+                    logDir: fdLog,
+                },
+
+            },
+        ]
+    })
+
+    //log
+    let log = pino(transport)
+    // console.log('log', log)
+
+    return log
+}
+
+
+export default WSyslog

package/src/formatter.mjs

@@ -0,0 +1,77 @@
+import fs from 'fs'
+import path from 'path'
+import { Writable } from 'stream'
+import get from 'lodash-es/get.js'
+import isestr from 'wsemi/src/isestr.mjs'
+
+
+async function formatter(opt) {
+    //opt為各targets的options
+
+    //fdLog
+    let fdLog = get(opt, 'fdLog')
+    if (!isestr(fdLog)) {
+        fdLog = './logs'
+    }
+
+    //interval
+    let interval = get(opt, 'interval')
+    if (interval !== 'day' && interval !== 'hr') {
+        interval = 'day'
+    }
+
+    // 建立 logs 資料夾
+    if (!fs.existsSync(fdLog)) {
+        fs.mkdirSync(fdLog, { recursive: true })
+    }
+
+    let currentFileStream = null
+    let currentTimeKey = ''
+
+    let getTimeKey = () => {
+        let d = new Date()
+        if (interval === 'hr') {
+            return d.toISOString().slice(0, 13).replace(/:/g, '-') // e.g., 2025-07-06T14
+        }
+        return d.toISOString().slice(0, 10) // e.g., 2025-07-06
+    }
+
+    let getFilePath = (timeKey) => {
+        let fn = `${timeKey}.log`
+        return path.join(fdLog, fn)
+    }
+
+    let switchFileIfNeeded = () => {
+        let newKey = getTimeKey()
+        if (newKey !== currentTimeKey) {
+            currentTimeKey = newKey
+            let filePath = getFilePath(newKey)
+            if (currentFileStream) currentFileStream.end()
+            currentFileStream = fs.createWriteStream(filePath, { flags: 'a' })
+        }
+    }
+
+    // 初始建立檔案
+    switchFileIfNeeded()
+
+    let stream = new Writable({
+        write(chunk, encoding, callback) {
+            try {
+                switchFileIfNeeded()
+
+                // 將 Buffer 轉為字串，確保正確處理換行
+                const str = Buffer.isBuffer(chunk) ? chunk.toString('utf8') : String(chunk)
+
+                currentFileStream.write(str + '\n', callback)
+            }
+            catch (err) {
+                callback(err)
+            }
+        }
+    })
+
+    return stream
+}
+
+
+export default formatter

package/test/WSyslog.test.mjs

@@ -0,0 +1,50 @@
+import fs from 'fs'
+import assert from 'assert'
+import _ from 'lodash-es'
+import w from 'wsemi'
+import WSyslog from '../src/WSyslog.mjs'
+
+
+describe('WSyslog', function() {
+
+    it('test', async function() {
+
+        w.fsCleanFolder('./logs')
+
+        let log = await WSyslog()
+        log.info({ event: 'runner', msg: 'start' })
+        log.warn({ event: 'monitor-memory', msg: 'usage-high' })
+        log.error({ event: 'crash', msg: 'db connection', code: 500 })
+
+        await w.delay(2000) //等待2秒讓pino能flush數據
+
+        let vpfs = w.fsTreeFolder('./logs')
+        // console.log('vpfs', vpfs)
+
+        let fp = _.get(vpfs, `0.path`, '')
+
+        let jj = fs.readFileSync(fp, 'utf8')
+
+        let ss = w.sep(jj, '\n')
+
+        let r = _.map(ss, (j) => {
+            let v = JSON.parse(j)
+            let event = _.get(v, 'event')
+            let msg = _.get(v, 'msg')
+            return {
+                event,
+                msg,
+            }
+        })
+        // console.log('r', r)
+
+        let rr = [
+            { event: 'runner', msg: 'start' },
+            { event: 'monitor-memory', msg: 'usage-high' },
+            { event: 'crash', msg: 'db connection' },
+        ]
+
+        assert.strict.deepEqual(r, rr)
+    })
+
+})

package/toolg/addVersion.mjs

@@ -0,0 +1,4 @@
+import addVersion from 'w-package-tools/src/addVersion.mjs'
+
+
+addVersion()

package/toolg/cleanFolder.mjs

@@ -0,0 +1,4 @@
+import cleanFolder from 'w-package-tools/src/cleanFolder.mjs'
+
+
+cleanFolder('docs')

package/toolg/gDistRollup.mjs

@@ -0,0 +1,23 @@
+import rollupFiles from 'w-package-tools/src/rollupFiles.mjs'
+import getFiles from 'w-package-tools/src/getFiles.mjs'
+
+
+let fdSrc = './src'
+let fdTar = './dist'
+
+
+rollupFiles({
+    fns: getFiles(fdSrc),
+    fdSrc,
+    fdTar,
+    nameDistType: 'kebabCase',
+    globals: {
+        'node-disk-info': 'node-disk-info',
+        'node-os-utils': 'node-os-utils',
+    },
+    external: [
+        'node-disk-info',
+        'node-os-utils',
+    ],
+})
+

package/toolg/modifyReadme.mjs

@@ -0,0 +1,4 @@
+import modifyReadme from 'w-package-tools/src/modifyReadme.mjs'
+
+
+modifyReadme()