perf(Benchmarks): Add benchmarking script

benchmark.js

@@ -0,0 +1,100 @@
+/**
+ * Benchmarks comparing the speed of Logga to other Node.js logging frameworks
+ *
+ * All frameworks configured to log errors to `stderr`.
+ * Build Logga if necessary before running benchmarks.
+ * Best run by redireting `stderr` to `/dev/null` e.g.
+ *
+ * ```sh
+ * npm run benchmark
+ * ```
+ */
+
+const Benchmark = require('benchmark')
+
+// Import each of the libraries used
+
+const bole = require('bole')
+const bunyan = require('bunyan')
+const log4js = require('log4js')
+const logga = require('.')
+const loglevel = require('loglevel')
+const pino = require('pino')
+const winston = require('winston')
+
+// Instantiate loggers for each library
+
+const boleLogger = bole('bench')
+bole
+  .output({
+    level: 'error',
+    stream: process.stderr,
+  })
+  .setFastTime(true)
+
+const bunyanLogger = bunyan.createLogger({
+  name: 'bench',
+  streams: [
+    {
+      level: 'error',
+      stream: process.stderr,
+    },
+  ],
+})
+
+var log4jsLogger = log4js.getLogger()
+log4jsLogger.level = 'error'
+log4js.configure({
+  appenders: { err: { type: 'stderr' } },
+  categories: { default: { appenders: ['err'], level: 'ERROR' } },
+})
+
+const loggaLogger = logga.getLogger('bench')
+logga.replaceHandlers((entry) => {
+  logga.defaultHandler(entry, { exitOnError: false })
+})
+
+const loglevelLogger = loglevel.getLogger('bench')
+loglevelLogger.setLevel('error')
+
+const pinoLogger = pino(process.stderr, { name: 'bench' })
+
+const winstonLogger = winston.createLogger({
+  transports: [
+    new winston.transports.Stream({
+      stream: process.stderr,
+    }),
+  ],
+})
+
+// Run the benchmark suite!
+
+new Benchmark.Suite()
+  .add('bole', function () {
+    boleLogger.error({ msg: 'hello' })
+  })
+  .add('bunyan', function () {
+    bunyanLogger.error({ msg: 'hello' })
+  })
+  .add('logga', function () {
+    loggaLogger.error({ msg: 'hello' })
+  })
+  .add('log4js', function () {
+    log4jsLogger.error({ msg: 'hello' })
+  })
+  .add('loglevel', function () {
+    loglevelLogger.error({ msg: 'hello' })
+  })
+  .add('pino', function () {
+    pinoLogger.error({ msg: 'hello' })
+  })
+  .add('winston', function () {
+    winstonLogger.error({ msg: 'hello' })
+  })
+  .on('cycle', function (event) {
+    console.log(String(event.target))
+  })
+  .on('complete', function () {
+    console.log('Fastest is ' + this.filter('fastest').map('name'))
+  })
+  .run()