feat(json-logger-js): initial commit

BREAKING CHANGE: first deploy

Author: vborszeki

.gitignore

@@ -0,0 +1,175 @@
+
+# Created by https://www.gitignore.io/api/osx,node,linux,intellij+all,visualstudiocode
+
+### Intellij+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### Intellij+all Patch ###
+# Ignores the whole idea folder
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
+
+.idea/
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history
+
+# End of https://www.gitignore.io/api/osx,node,linux,intellij+all,visualstudiocode
+
+### Project ###
+/tmp/

.npmignore

@@ -0,0 +1,4 @@
+*.spec.js
+node_modules
+.idea
+tmp

.nvmrc

@@ -0,0 +1 @@
+8.4.0

README.md

@@ -1 +1,46 @@
-# json-logger-js
+# json-logger-js
+
+Simple JSON logger middleware that combines the namespaces of [debug] and the
+ machine readable JSON format of [bunyan].
+
+It has the same logging levels as [bunyan].
+
+## Example
+
+```javascript
+process.env.DEBUG = 'redis';
+let mongoLogger = require('bunyan-debug')('mongo');
+let redisLogger = require('bunyan-debug')('redis');
+
+// simple info logging with enabled namespace
+redisLogger.info('connected', { domain: 'yahoo' });
+
+// not enabled
+mongoLogger.info('connected', { domain: 'google' });
+
+// error objects
+redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch' });
+```
+
+will output
+
+```
+{"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
+{"name":"redis","action":"query","level":50,"time":"2016-08-15T08:50:23.569Z","error_name":"Error","error_stack":"Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3","error_message":"Unauthorized","problem":"missmatch"}
+```
+
+Examples can be found in ```example.js```.
+
+## Development
+
+While developing JSON is not the most readable format. To solve this a little
+ command line formatter is also included which is very familiar to [debug]'s
+ output format.
+
+```
+redis INFO +0ms action="connected" domain="yahoo"
+redis ERROR +2ms action="query" error_message="Unauthorized" error_name="Error" error_stack="Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3" problem="missmatch"
+```
+
+[debug]: https://github.com/visionmedia/debug
+[bunyan]: https://github.com/trentm/node-bunyan

bin/json-logger.js

@@ -0,0 +1,10 @@
+#! /usr/bin/env node
+'use strict';
+let eventStream = require('event-stream');
+let transformLine = require('../src/output/transform/transform');
+
+process.stdin.setEncoding('utf8');
+process.stdin
+  .pipe(eventStream.split())
+  .pipe(eventStream.mapSync(transformLine))
+  .pipe(process.stdout);

example.js

@@ -0,0 +1,18 @@
+'use strict';
+process.env.DEBUG = 'redis';
+let logger = require('./index');
+
+let mongoLogger = logger('mongo');
+let redisLogger = logger('redis');
+
+// simple info logging with enabled namespace
+redisLogger.info('connected', { domain: 'yahoo' });
+
+// not enabled
+mongoLogger.info('connected', { domain: 'google' });
+
+// error objects
+redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch' });
+
+// displays as is
+console.log(JSON.stringify({ example: 'output' }));

index.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const Logger = require('./src/logger/logger');
+const Timer = require('./src/timer/timer');
+const isNamespaceEnabled = require('./src/enabled/enabled');
+const contextMiddlewareFactory = require('./src/context-middleware-factory/context-middleware-factory');
+
+/**
+ * @param namespace
+ * @param options
+ * @returns {Logger}
+ */
+function logFactory(namespace, options) {
+  return new Logger(namespace, isNamespaceEnabled(
+    logFactory.getNamespaces(), namespace
+  ), options);
+}
+
+logFactory.Logger = Logger;
+logFactory.Timer = Timer;
+logFactory.getNamespaces = function() {
+  return process.env.DEBUG || '';
+};
+logFactory.getMiddleware = contextMiddlewareFactory.getMiddleware;
+
+module.exports = logFactory;

koaexample.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const Koa = require('koa');
+const logFactory = require('./index');
+const logger = logFactory('example');
+const port = 3000;
+
+const app = new Koa();
+
+app.use(async (ctx, next) => {
+  ctx.request.header['x-request-id'] = 'uuid';
+  await next();
+});
+app.use(logFactory.getMiddleware());
+app.use(async () => {
+  logger.info('works');
+});
+
+app.listen(port);
+console.log('listening on port: ' + port);