Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

cnn-logger

cnnlabs326Apache-2.02.1.0

CNN Logger

cnn, cnnlabs, logger, logstash, logz.io, winston

readme

CNN Logger

Replaces console.log() with log.[log-level]() and sends logs to Logz.io.

dependency-status build-status-master build-status-develop npm npm-downloads

Requirements

Read these "requirements" as "only tested with".

Usage

This is intended to be used as a dependency in a larger application. Refer to the example.js that you can run with $ node example/example.js.

ESDoc Documentation

You can generate and view the docs locally with the commands below. The open command will only work on macOS.

$ npm run generate-docs
$ open docs/index.html

NPM scripts

  • generate-authors - Generates AUTHORS.md.
  • generate-changelog - Generates output to put in CHANGELOG.md.
  • generate-docs - Generates ESDoc documentation in /docs.
  • test - Runs all tests.
  • update-apply - Updates package.json with dependency updates.
  • update-check - Outputs if any dependency updates are needed.

Developer notes

  • Always develop on the node version specified in the .nvmrc file. If nvm is used typing nvm install in the terminal will insure the correct version is used.

  • Contributors should be familiar with the Contributors Guide

  • Collaborators should be familiar with the Collaborator Guide

  • The current Project Owner (PO) of this project is Jamie Young (@jamsyoung).

Environment variables

  • LOGZIO_TOKEN - REQUIRED - The token to authenticate to the Logz.io account that the logs should be sent to.

Licensing

See LICENSE.md for details.

changelog

CNN Logger ChangeLog

2018-11-13, Version 2.0.0, @drenter

Notable changes

  • Update to support Winston 3.x.
  • Update Node and other dependencies.

Commits

  • [4c16177fb8] - Update to support Winston 3.x. Update minimum Node version and other dependencies. (James Drenter)

2017-04-05, Version 1.5.0, @drenter

Notable changes

  • Add do_<level> booleans, like do_debug and do_warn, to tell you if that level is logging.

Commits

  • [601f38ec7a] - Add do_<level> booleans, like do_debug and do_warn, to tell you if that level is logging. Do a better job with setting the log levels. (#11) (James Drenter) #11

2017-02-23, Version 1.4.0, @jamsyoung

Notable changes

  • pass in log level via options

🐭 - What happened to 1.3.0? 😳 - Well, @jamsyoung did the tag wrong on 1.2.1. We are just not gonna talk about 1.3.0 anymore...

Commits

  • [23db0bb766] - add support for passing log level via options (#10) (Matthew Crutchfield) #10

2017-02-01, Version 1.2.1, @jamsyoung

Notable changes

  • Update dependencies

Commits

  • [38fe0c3eda] - deps: update winston-logzio dep from 1.0.0 to 1.0.3 (Matthew Crutchfield) #9

2017-01-19, Version 1.1.0, @jamsyoung

Notable changes

  • Made logging to file optional and removed the one that was created no matter what.

Commits

  • [4eb56b7483] - example: add example (James Young)
  • [5bc95bc543] - (SEMVER-MINOR) logger: fix issue with local file being generated and add support for array of tags (DrEnter) #7

2016-07-01, Version 1.0.0, @jamsyoung

Notable changes

  • Rewritten, sends logs to logz.io

Known issues

See https://github.com/cnnlabs/cnn-logger/labels/defect for complete and current list of known issues.

Commits

2016-02-20, Version 0.2.0, @jamsyoung

Notable changes

  • Removed loggly, added logstash

Known issues

See https://github.com/cnnlabs/cnn-logger/labels/defect for complete and current list of known issues.

Commits

  • [4b3cca8734] - (SEMVER-MINOR) base: bring base files up to date (James Young) #3

0.1.x - Initial versions - changes too numerous to list