node-bunyan-lite/TODO.md

71 lines
3.4 KiB
Markdown
Raw Normal View History

2013-03-19 17:32:57 +00:00
- need .npmignore? tools dir, etc.
- man page for the bunyan CLI (refer to it in the readme)
- `tail -f`-like support
- 1.0 with `v: 1` in log records. Fwd/bwd compat in `bunyan` CLI
2014-08-25 07:37:07 +00:00
# docs
- document log.addStream() and log.addSerializers()
# someday/maybe
2013-01-19 00:27:53 +00:00
- full-on docs
- better examples/
- better coloring
- "template" support for 'rotating-file' stream to get dated rolled files
2012-08-08 03:35:16 +00:00
- "all" or "off" levels? log4j? logging.py?
2012-08-14 03:11:20 +00:00
logging.py has NOTSET === 0. I think that is only needed/used for
multi-level hierarchical effective level.
- buffered writes to increase speed:
2012-02-08 18:36:20 +00:00
- I'd start with a tools/timeoutput.js for some numbers to compare
before/after. Sustained high output to a file.
2012-02-06 23:27:30 +00:00
- perhaps this would be a "buffered: true" option on the stream object
- then wrap the "stream" with a local class that handles the buffering
2012-02-08 18:36:20 +00:00
- to finish this, need the 'log.close' and `process.on('exit', ...)`
work that Trent has started.
- "canWrite" handling for full streams. Need to buffer a la log4js
- test file log with logadm rotation: does it handle that?
2012-01-31 01:17:39 +00:00
- test suite:
- test for a cloned logger double-`stream.end()` causing problems.
Perhaps the "closeOnExit" for existing streams should be false for
clones.
- test that a `log.clone(...)` adding a new field matching a serializer
works *and* that an existing field in the parent is not *re-serialized*.
2012-02-08 18:36:20 +00:00
- split out `bunyan` cli to a "bunyan" or "bunyan-reader" or "node-bunyan-reader"
as the basis for tools to consume bunyan logs. It can grow indep of node-bunyan
for generating the logs.
It would take a Bunyan log record object and be expected to emit it.
node-bunyan-reader
.createReadStream(path, [options]) ?
2013-01-29 07:40:18 +00:00
- coloring bug: in less the indented extra info lines only have the first
line colored. Do we need the ANSI char on *each* line? That'll be
slower.
- document "well-known" keys from bunyan CLI p.o.v.. Add "client_req".
2012-06-20 23:04:23 +00:00
- More `bunyan` output formats and filtering features.
- Think about a bunyan dashboard that supports organizing and viewing logs
from multiple hosts and services.
2012-11-13 08:12:57 +00:00
- doc the restify RequestCaptureStream usage of RingBuffer. Great example.
2012-08-08 03:35:16 +00:00
- A vim plugin (a la http://vim.cybermirror.org/runtime/autoload/zip.vim ?) to
allow browsing (read-only) a bunyan log in rendered form.
2012-06-20 23:04:23 +00:00
- Some speed comparisons with others to get a feel for Bunyan's speed.
2012-02-08 18:36:20 +00:00
- what about promoting 'latency' field and making that easier?
2012-02-06 23:29:22 +00:00
- `log.close` to close streams and shutdown and `this.closed`
process.on('exit', log.close)
-> 'end' for the name
2012-02-06 23:27:30 +00:00
- bunyan cli: more layouts (http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/EnhancedPatternLayout.html)
Custom log formats (in config file? in '-f' arg) using printf or hogan.js
or whatever. Dap wants field width control for lining up. Hogan.js is
probably overkill for this.
- loggly example using raw streams, hook.io?, whatever.
- serializer support:
- restify-server.js example -> restifyReq ? or have `req` detect that.
That is nicer for the "use all standard ones". *Does* restify req
have anything special?
- differential HTTP *client* req/res with *server* req/res.
- statsd stream? http://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/
Think about it.
2014-04-10 03:07:51 +00:00
- web ui. Ideas: http://googlecloudplatform.blogspot.ca/2014/04/a-new-logs-viewer-for-google-cloud.html