docs(3.0): create benchmark with v2, winston and pino

benchmarks/README.md

@@ -0,0 +1,13 @@
+# BENCHMARKS
+
+- Tested on Nodejs 22.8.0
+```bash
+┌─────────┬──────────────────────┬───────────┐
+│ (index) │       library        │  ops/sec  │
+├─────────┼──────────────────────┼───────────┤
+│    0    │        'Pino'        │ '181,851' │
+│    1    │ '@ekino/logger v3.x' │ '160,179' │
+│    2    │ '@ekino/logger v2.x' │ '136,705' │
+│    3    │      'Winston'       │ '86,693'  │
+└─────────┴──────────────────────┴───────────┘
+```

benchmarks/basic.js

@@ -0,0 +1,83 @@
+#!/usr/bin/env node
+
+import * as logger2 from '@ekino/logger'
+import { Suite } from '@jonahsnider/benchmark'
+import pino from 'pino'
+import * as winston from 'winston'
+import * as logger3 from '../lib/esm/index.js'
+
+const suite = new Suite('Logger Benchmark', {
+    warmup: { trials: 3000 }, // Run benchmark for 3000ms
+    run: { trials: 10_000 }, // Run 1000 warmup trials
+})
+
+// Initialize loggers
+logger2.setLevel('info')
+logger3.setLevel('info')
+
+const ekinoLoggerV2 = logger2.createLogger('benchmark')
+const ekinoLoggerV3 = logger3.createLogger('benchmark')
+const pinoLogger = pino({
+    level: 'info',
+    prettyPrint: false,
+    destination: pino.destination({ sync: true }), // Synced JSON output
+})
+const winstonLogger = winston.createLogger({
+    level: 'info',
+    format: winston.format.json(),
+    transports: [new winston.transports.Console()],
+})
+
+const message = 'This is a benchmark log message'
+const logObject = {
+    user: 'John Doe',
+    action: 'Test Action',
+    timestamp: new Date(),
+    details: {
+        ipAddress: '192.168.1.1',
+        location: 'New York',
+        permissions: ['read', 'write', 'admin'],
+        metadata: { session: 'abcdef12345', retries: 2 },
+    },
+}
+const contextId = 'a037df3b-dbee-448e-9abb-8024d867ccc8'
+
+async function runBenchmarks() {
+    suite
+        .addTest('@ekino/logger v2.x', () => {
+            ekinoLoggerV2.info(contextId, message, logObject)
+        })
+        .addTest('@ekino/logger v3.x', () => {
+            ekinoLoggerV3.info(contextId, message, logObject)
+        })
+        .addTest('Winston', () => {
+            winstonLogger.info(message, logObject)
+        })
+        .addTest('Pino', () => {
+            pinoLogger.info({
+                ctxId: contextId,
+                ...logObject,
+                message,
+            })
+        })
+
+    const results = await suite.run()
+    return results
+}
+
+const results = await runBenchmarks()
+
+const table = [...results]
+    .map(([library, histogram]) => [
+        library,
+        Math.round(1e9 / histogram.percentile(50)), // Median to ops/sec
+    ])
+    .sort(([, a], [, b]) => b - a)
+    .map(([library, opsPerSec]) => ({
+        library,
+        'ops/sec': opsPerSec.toLocaleString(),
+    }))
+
+setTimeout(() => {
+    console.table(table)
+}, 5000)

package.json

@@ -50,13 +50,17 @@
     },
     "devDependencies": {
         "@biomejs/biome": "1.9.4",
+        "@ekino/logger": "2.1.1",
+        "@jonahsnider/benchmark": "^5.1.1",
         "@types/node": "22.7.7",
         "@vitest/coverage-v8": "2.1.3",
         "commitlint": "19.5.0",
         "conventional-changelog-cli": "5.0.0",
+        "pino": "^9.5.0",
         "tsx": "^4.19.1",
         "typescript": "5.6.3",
-        "vitest": "^2.1.3"
+        "vitest": "^2.1.3",
+        "winston": "^3.15.0"
     },
     "scripts": {
         "lint": "biome check --write",