Skip to content

cnnlabs/cnn-logger

Repository files navigation

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.

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

Yarn 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.

About

CNN Logger

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •