https://github.com/segment-boneyard/yal

Yet Another Logger — send logs to dedicated logging servers.
https://github.com/segment-boneyard/yal

Last synced: about 5 hours ago
JSON representation

Yet Another Logger — send logs to dedicated logging servers.

• Host: GitHub
• URL: https://github.com/segment-boneyard/yal
• Owner: segment-boneyard
• Created: 2014-01-18T20:42:06.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-04-09T21:16:13.000Z (over 1 year ago)
• Last Synced: 2024-11-10T03:59:29.432Z (6 days ago)
• Language: JavaScript
• Homepage:
• Size: 24.4 KB
• Stars: 169
• Watchers: 41
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md

Awesome Lists containing this project

README

        
  

  [![Build Status](https://travis-ci.org/segmentio/yal.png?branch=master)](https://travis-ci.org/segmentio/yal)

  

  __Yet Another Logger__ that pushes logs to log servers with axon/tcp to delegate network overhead.

  If you're like us and you distribute logs to several remote services,

  you may be using a tool like Winston to do so, and while this is helpful

  it's also brittle to use in mission-critical applications.

  YAL's solution is to simply distribute messages over TCP (via axon) to one or more log servers, delegating the task of processing or shipping messages off to these services. This is especially problematic when logging services are enabled __only__ in production, and thus may not be tested properly locally or in staging environment. This can and likely will bite you.

  Check out the [YAL server](https://github.com/segmentio/yal-server).

## Installation

```

$ npm install yal

```

## About

 - through [axon](https://github.com/visionmedia/axon) re-connection and failover is supported

 - when __NODE_ENV__ is "development" the log level defaults to "debug"

 - when __NODE_ENV__ is not "development" the log level defaults to "info"

 - when __NODE_ENV__ is "test" the logger will not write to stdio

 - the log level may be altered via the __LOG_LEVEL__ environment variable

 - standard syslog levels are supported: debug, info, warn, error, critical, alert, emergency

 - you may distribute messages to one or more axon log servers

 - YAL writes to stdio for local logging / debuggin

 - YAL sends a creation `.timestamp`

 - YAL sends the `.hostname`

## Example

  The following example shows two servers,

  with the logger doing round-robin requests

  between the two.

```js

var Logger = require('yal');

var log = new Logger([

  'tcp://localhost:5000',

  'tcp://localhost:5001'

]);

setInterval(function(){

  log.info('viewed page', { user: 'tobi' });

}, 300);

setInterval(function(){

  log.info('signed in', { user: 'jane' });

}, 1000);

setInterval(function(){

  log.error('oh no boom', { something: 'here' });

}, 3000);

```

## API

### Logger(addresses)

  Pass a string or array of addresses.

### .LEVEL(type, msg)

  Send a log message.

### .silent()

  Disable stdio.

## License

 MIT