share / sharedb / 914 / 3

96%

master: 97%

Build Type

push

travis-ci

Committed by Alec Gibson

Commit Message

Allow custom logger overrides

This change adds the ability to override ShareDB's logging behaviour.

By default, ShareDB will still log to `console`. However, this default
can be overridden with custom methods on both the backend and in the
client.

## Supported methods

The ShareDB logger only supports the following methods:

  - `info`
  - `warn`
  - `error`

Any method that is not overridden will default to `console`.

## Backend

The backend methods can be overridden when instantiating `Backend`:

```javascript
var share = new Backend({
  logger: {
    info: () => {},        // Silence info
    warn: alerts.warn,     // Forward warnings to alerting service
    error: alerts.critical // Map errors to critical alerts
  }
});
```

## Client

Client methods can also be overridden:

```javascript
var ShareDB = require('sharedb/lib/client');
ShareDB.logger.setMethods({
  info: () => {},
  // etc.
});
```

Run Details

1094 of 1313 branches covered (83.32%)

2316 of 2424 relevant lines covered (95.54%)

133.71 hits per line