logdis - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

index.js

 // --------------------------------------------------------------------------------------------------------------------
 
-// core
-var events = require('events')
+"use strict"
 
-// npm
-var split = require('split')
-
 // --------------------------------------------------------------------------------------------------------------------
 
-function logdisInputStdIn() {
-  var ee = new events.EventEmitter()
+const logdis = require('logdis-core')
 
-  process.stdin.setEncoding('utf8')
+// inputs
+logdis.input = {
+  stdin            : require('logdis-input-stdin'),
+}
 
-  process.stdin.pipe(split())
-    .on('data', (data) => {
-      ee.emit('data', data.toString('utf8'))
-    })
+// filters
+logdis.filter = {
+  toJson           : require('logdis-filter-to-json'),
+  timestamp        : require('logdis-filter-timestamp'),
+  scrub            : require('logdis-filter-scrub'),
+  ignoreBlankLines : require('logdis-filter-ignore-blank-lines'),
+}
 
-  process.stdin.on('close', () => {
-    // console.log('stdin closed')
-  })
-
-  return ee
+// outputs
+logdis.output = {
+  stdout           : require('logdis-output-stdout'),
 }
 
-// ---------------------------------------------------------------------------------------------------------------------
+// --------------------------------------------------------------------------------------------------------------------
 
-module.exports = logdisInputStdIn
+module.exports = logdis
 
-// ---------------------------------------------------------------------------------------------------------------------
+// --------------------------------------------------------------------------------------------------------------------

package.json

 {
   "name": "logdis",
-  "description": "Input plugin to read from stdin. http://logdis.io/",
-  "version": "0.1.0",
+  "description": "Modular log processing framework - starter module ⇒ http://logdis.io/",
+  "version": "0.2.0",
   "homepage": "http://logdis.io/",
   "scripts": {
-    "test": "cat stdin.log | tape test.js"
+    "test": "tape test.js"
   },
   "dependencies": {
-    "split": "^1.0.0"
+    "logdis-core": "^0.1.0",
+    "logdis-filter-ignore-blank-lines": "^0.1.0",
+    "logdis-filter-scrub": "^0.1.0",
+    "logdis-filter-timestamp": "^0.1.0",
+    "logdis-filter-to-json": "^0.1.0",
+    "logdis-input-stdin": "^0.1.1",
+    "logdis-output-stdout": "^0.1.0"
   },
@@ -17,15 +23,15 @@ "devDependencies": {
     "type": "git",
-    "url": "https://github.com/logdis/logdis-plugins.git"
+    "url": "https://github.com/logdis/logdis.git"
   },
   "bugs": {
-    "url": "https://github.com/logdis/logdis-plugins/issues",
-    "email": "[e-mail]"
+    "url": "https://github.com/logdis/logdis/issues",
+    "email": "[e-mail]"
   },
   "author": {
     "name": "Andrew Chilton",
-    "email": "[e-mail]",
+    "email": "[e-mail]",
     "url": "http://chilts.org/"
   },
-  "keywords": [ "logdis", "logdis-plugin", "logdis-input", "logdis-input-stdin" ],
+  "keywords": [ "logdis" ],
   "license": "ISC"
 }

ReadMe.md

@@ -1,34 +0,45 @@
-# logdis-input-stdin #
+# LogDis #
 
-**This is an officially supported http://logdis.io/ plugin.**
+**LogDis is a modular log processing framework.**
 
-Reads `stdin` and passes each line to the filters.
+[![NPM](https://nodei.co/npm/logdis.png?compact=true)](https://nodei.co/npm/logdis/)
 
-## Synopsis ##
+Note: it is not a logger. For that, you should use `bole`, `bunyan`, `winston` or something simiar.
 
-Require `logdis-core` and whatever other filters and outputs you need:
+LogDis allows you to do whatever the hell you want with your logs. It's kinda like logstash, but easier to configure
+and use. It can process, filter, change, and manipulate your logs, then it can save them, send them somewhere, or stash
+them anywhere you like.
 
-```js
-var logdisCore = require('logdis-core')
-var inputStdin = require('logdis-input-stdin')
+## Convenience Package ##
 
-var logdis = logdisCore()
-logdis.input(inputStdin())
-// filters ...
-// outputs ...
-```
+This is a convenience package that bundles the current release of 'logdis-core' and all of the official plugins.
 
-## Author ##
+Use this package so you can get started quickly. Use the individual plugins if you want to be specific about what to
+install.
 
-Andrew Chilton:
+Please see the documentation at http://logdis.io/ for more information.
 
-* [Blog    : chilts.org](https://chilts.org/)
-* [Twitter : @andychilton](https://twitter.com/andychilton)
-* [GitHub  : @chilts](https://github.com/chilts)
-* [npm     L @chilts](https://www.npmjs.com/~chilts)
+## Synopsis ##
 
-## License ##
+```js
+const logdis = require('logdis')
 
-ISC.
+const fromStdIn        = logdis.input.stdin()
+const ignoreBlankLines = logdis.filter.ignoreBlankLines()
+const convertToJson    = logdis.filter.toJson()
+const scrub            = logdis.filter.scrub({ scrub : { 'username' : true } })
+const timestamp        = logdis.filter.timestamp({ fieldname : 'timestamp', format : 'epoch' })
+const toStdOut         = logdis.output.stdout()
 
-(Ends)
+logdis()
+  .input(fromStdIn)
+  .filter(ignoreBlankLines)
+  .filter(convertToJson)
+  .filter(scrub)
+  .filter(timestamp)
+  .output(toStdOut)
+```
+
+## Author ##
+
+Andrew Chilton. [@andychilton](https://twitter.com/andychilton)

No alert changes

Improved metrics

Total package byte prevSize

4974

increased by54.52%

Lines of code

54

increased by14.89%

Number of lines in readme file

46

increased by31.43%

Worsened metrics

Dependency count

7

increased by600%

Dependency changes

• + Addedlogdis-core@^0.1.0

• + Addedlogdis-filter-ignore-blank-lines@^0.1.0

• + Addedlogdis-filter-scrub@^0.1.0

• + Addedlogdis-filter-timestamp@^0.1.0

• + Addedlogdis-filter-to-json@^0.1.0

• + Addedlogdis-input-stdin@^0.1.1

• + Addedlogdis-output-stdout@^0.1.0

• + Addedlogdis-core@0.1.0(transitive)

• + Addedlogdis-filter-ignore-blank-lines@0.1.0(transitive)

• + Addedlogdis-filter-scrub@0.1.0(transitive)

• + Addedlogdis-filter-timestamp@0.1.0(transitive)

• + Addedlogdis-filter-to-json@0.1.0(transitive)

• + Addedlogdis-input-stdin@0.1.1(transitive)

• + Addedlogdis-output-stdout@0.1.0(transitive)

• - Removedsplit@^1.0.0