Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wework/we-js-logger
Universal logger with transports to Rollbar and Logentries. Uses bunyan under the hood.
https://github.com/wework/we-js-logger
bunyan logentries logging rollbar universal wework
Last synced: 3 months ago
JSON representation
Universal logger with transports to Rollbar and Logentries. Uses bunyan under the hood.
- Host: GitHub
- URL: https://github.com/wework/we-js-logger
- Owner: wework
- License: mit
- Created: 2016-10-18T16:15:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-30T12:19:18.000Z (almost 3 years ago)
- Last Synced: 2024-10-07T05:09:28.412Z (4 months ago)
- Topics: bunyan, logentries, logging, rollbar, universal, wework
- Language: JavaScript
- Homepage:
- Size: 5.66 MB
- Stars: 14
- Watchers: 8
- Forks: 3
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
we-js-logger
====================
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-url]
[![MIT License][license-image]][license-url]
[![Sauce Test Status][saucelabs-image]][saucelabs-url]
>Logger for node processes and browser applications with transports to Rollbar and Logentries
# Introduction
This is an opinionated logger for JS applications:
- Uses [bunyan](https://github.com/trentm/node-bunyan), a JSON logger, under the hood
- Transports logs to Logentries and/or Rollbar
- Universal. Can be used in the browser and Node.js processes
# Usage
```js
import Logger from 'we-js-logger';
const log = new Logger({
name: 'my-logger',
environment: 'production',
level: 'debug',
codeVersion: process.env.SHA_VERSION,
logentriesToken: process.env.LOGENTRIES_TOKEN,
rollbarToken: process.env.ROLLBAR_TOKEN,
scrubFields: ['password'], // blacklist field keys being sent through logger
});
```
## Node.js usage
This package can be used via `npm` and `node` with no special considerations.
## Browser usage
This package exposes a `client` build for browser usage. It is referenced in the `browser` field of `package.json`, so module loaders that follow this spec will load it easily.
For example, we commonly use `webpack` to load this module.
### Webpack Considerations
*TODO document webpack setup*
## Configuration
See https://github.com/wework/we-js-logger/blob/master/API.md#we-js-loggerutillogger for API documentation
## Examples
```js
log.fatal({ err }, 'Application crashing because something terrible happened.');
log.error({ err, req }, 'API request failed');
log.info({ action }, 'Something relevant happened')
log.debug({ event, action }, 'Something useful for developers happened');
```
See https://github.com/trentm/node-bunyan#log-method-api for more detail.
# Logentries Integration
*More docs coming soon.*
Providing the `Logger` constructor a `logentriesToken` option enables this transport.
# Rollbar Integration
## Node
This library will initialize Rollbar
See https://rollbar.com/docs/notifier/rollbar.js/#quick-start-server for documentation on setting up Rollbar for node processes.
## Browser
For browser usage, this library expects Rollbar to be loaded via their quick-start script tag. This also allows Rollbar to capture any errors before the logger's initialization code, if that's important to you.
See https://rollbar.com/docs/notifier/rollbar.js/#quick-start-browser for documentation on setting up Rollbar for browser applications
# Development
In lieu of a formal style guide, please ensure PRs follow the conventions present, and have been properly linted and tested. Feel free to open issues to discuss.
Be aware this module is tested in both browser and node runtimes.
## Available tasks
### Build and test
Runs all tests, static analysis, and bundle for distribution
```shell
$ npm start
```
### Test
Runs browser and node tests
```shell
$ npm test
```
Runs browser tests via PhantomJS only
```shell
$ npm run test:browser
```
Runs browser tests via SauceLabs only
```shell
$ SAUCELABS=true npm run test:browser
```
Runs node tests only
```shell
$ npm run test:node
```
### TDD
Runs browser and node tests in watch mode, re-bundles on src file change
```shell
$ npm run tdd
```
### Docs
Regenerate `API.md` docs from JSDoc comments
```shell
$ npm run docs
```
### Bundle
Packages client and node bundles for distribution, output to `/dist`
```shell
$ npm run bundle
```
### Distribute
Lints, cleans, bundles, and generates docs for distribution, output to `/dist`
```shell
$ npm run dist
```
### Release
We're using `np` to simplify publishing to git + npm. A changelog and docs are generated as part of this script.
```shell
$ npm run release
$ npm run release patch # patch release
$ npm run release 100.10.1 # release specific version
```
[npm-url]: https://npmjs.org/package/we-js-logger
[npm-version-image]: http://img.shields.io/npm/v/we-js-logger.svg?style=flat-square
[npm-downloads-image]: http://img.shields.io/npm/dm/we-js-logger.svg?style=flat-square
[coveralls-image]:https://coveralls.io/repos/github/wework/we-js-logger/badge.svg?branch=master
[coveralls-url]:https://coveralls.io/github/wework/we-js-logger?branch=master
[travis-url]:https://travis-ci.org/wework/we-js-logger
[travis-image]: https://travis-ci.org/wework/we-js-logger.svg?branch=master
[saucelabs-image]:https://saucelabs.com/browser-matrix/wework-we-js-logger.svg
[saucelabs-url]:https://saucelabs.com/u/wework-we-js-logger
[license-url]: LICENSE
[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square