https://github.com/clinical-meteor/winston-browser-logging

Winston library to provide isomorphic client-side logging.
https://github.com/clinical-meteor/winston-browser-logging

Last synced: about 1 month ago
JSON representation

Winston library to provide isomorphic client-side logging.

• Host: GitHub
• URL: https://github.com/clinical-meteor/winston-browser-logging
• Owner: clinical-meteor
• Created: 2017-05-19T18:03:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-07T04:43:00.000Z (about 7 years ago)
• Last Synced: 2024-10-29T21:06:28.757Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# winston-browser-logging

> "Because even the client deserves a great logger"

#### Installation

```

meteor add clinical:winston-browser-logging

meteor add infinitedg:winston

```

#### Usage

winston-client pushes a simplified `winston` object down to the client that logs messages to the console and sends them up to the server as well. winston-client supports the default `Winston.config.cli` levels:

    Winston.silly("Silly!");

    Winston.input("Very verbose");

    Winston.verbose("Just a little wordy");

    Winston.prompt("Not as many words");

    Winston.debug("Good for a coder");

    Winston.info("The standard logging level in winston");

    Winston.data("More important than info")

    Winston.help("Something needs help");

    Winston.warn("Something might be broken");

    Winston.error("Something is broken!!");

In addition to these methods, the raw `Winston.log` method is meant to behave similarly to `Winston.log` on the server:

    // Basic logging

    Winston.log('info', 'Hello distributed log files!');

    Winston.info('Hello again distributed logs');

    

    // Logging with metadata

    Winston.log('info', 'Test Log Message', { anything: 'This is metadata' });

    

    // String interpolation

    Winston.log('info', 'test message', 'first', 'second', {number: 123});

    // info:    info test message first second

    // meta = {"number":123} 

Log messages are sent back to the server via `Meteor.call('winston-log)` for processing via `winston.log()`. Use [winston-airbrake](https://atmosphere.meteor.com/package/winston-airbrake) or [winston-loggly](https://atmosphere.meteor.com/package/winston-airbrake) to make the most of winston on your client!

To limit the messages that are logged to the user's console:

    Winston.transports.MeteorClient.level = 'info'; // Or any other transport level you like.

#### Acknowledgements  

Kudos to @brentjanderson for the initial concept of this package.  Forking to make it more specific for clinical/healthcare needs.  

https://github.com/farpoint/meteor-winston-client  

#### License

The MIT License (MIT)

Copyright (c) 2013 The Space EdVentures Foundation, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.