Skip to content

Commit

Permalink
0.0.2-0
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Nason committed Oct 18, 2016
1 parent 27676a6 commit 89007c0
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 16 deletions.
30 changes: 15 additions & 15 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,54 +2,48 @@

# we-js-logger/client

[src/client.js:5-5](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/client.js#L5-L5 "Source code on GitHub")
[src/client.js:5-5](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/client.js#L5-L5 "Source code on GitHub")

A logger than can be used in browsers

# we-js-logger/util/client/consoleLogger

[src/util/client/consoleLogger.js:6-6](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/util/client/consoleLogger.js#L6-L6 "Source code on GitHub")
[src/util/client/consoleLogger.js:6-6](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/util/client/consoleLogger.js#L6-L6 "Source code on GitHub")

Custom bunyan stream that writes to browser console with nice formatting

# we-js-logger/util/client/logentriesLogger

[src/util/client/logentriesLogger.js:6-6](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/util/client/logentriesLogger.js#L6-L6 "Source code on GitHub")
[src/util/client/logentriesLogger.js:6-6](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/util/client/logentriesLogger.js#L6-L6 "Source code on GitHub")

Custom bunyan stream that transports to logentries from a browser

# we-js-logger/util/client/rollbarLogger

[src/util/client/rollbarLogger.js:9-9](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/util/client/rollbarLogger.js#L9-L9 "Source code on GitHub")
[src/util/client/rollbarLogger.js:9-9](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/util/client/rollbarLogger.js#L9-L9 "Source code on GitHub")

Custom rollbar stream that transports to logentries from a browser
Note: Rollbar init is _not_ currently handled here, see
<https://rollbar.com/docs/notifier/rollbar.js/#quick-start>
for details on setting up Rollbar for a client app

# we-js-logger/util/common/rollbar

[src/util/common/rollbar.js:9-16](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/util/common/rollbar.js#L9-L16 "Source code on GitHub")

Shared rollbar helpers

# we-js-logger/node

[src/node.js:5-5](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/node.js#L5-L5 "Source code on GitHub")
[src/node.js:5-5](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/node.js#L5-L5 "Source code on GitHub")

A logger than can be used in node processes

# we-js-logger/util/logger

[src/util/common/logger.js:7-7](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/util/common/logger.js#L7-L7 "Source code on GitHub")
[src/util/common/logger.js:7-7](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/util/common/logger.js#L7-L7 "Source code on GitHub")

Base logger class, used for both node and client loggers

Uses (bunyan)[https://github.com/trentm/node-bunyan/] under the hood, which has a few quirks

# constructor

[src/util/common/logger.js:23-57](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/util/common/logger.js#L23-L57 "Source code on GitHub")
[src/util/common/logger.js:23-57](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/util/common/logger.js#L23-L57 "Source code on GitHub")

**Parameters**

Expand Down Expand Up @@ -78,13 +72,19 @@ Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refer

# we-js-logger/util/server/rollbarLogger

[src/util/server/rollbarLogger.js:7-7](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/util/server/rollbarLogger.js#L7-L7 "Source code on GitHub")
[src/util/server/rollbarLogger.js:7-7](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/util/server/rollbarLogger.js#L7-L7 "Source code on GitHub")

Custom bunyan stream that transports to Rollbar from a node process.
Note: Rollbar initialization is handled here.

# we-js-logger/util/common/rollbar

[src/util/common/rollbar.js:9-16](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/util/common/rollbar.js#L9-L16 "Source code on GitHub")

Shared rollbar helpers

# we-js-logger/util/server/logentriesLogger

[src/util/server/logentriesLogger.js:6-6](https://github.com/wework/we-js-logger/blob/3a23034cfa419603ca14ab2e472d2a348d3bee06/src/util/server/logentriesLogger.js#L6-L6 "Source code on GitHub")
[src/util/server/logentriesLogger.js:6-6](https://github.com/wework/we-js-logger/blob/27676a6f42a997acea25c318bf6dd775bab6b68e/src/util/server/logentriesLogger.js#L6-L6 "Source code on GitHub")

Custom bunyan stream that transports to logentries from a node process
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. This projec
Generated by [auto-changelog](https://github.com/CookPete/auto-changelog)


## [v0.0.2-0](https://github.com/wework/we-js-logger/compare/v0.0.1...v0.0.2-0) - 2016-10-18

### Merged
* Use node v6.9.0 LTS for development and CI [`#4`](https://github.com/wework/we-js-logger/pull/4)
* Add before_script to travis build [`#1`](https://github.com/wework/we-js-logger/pull/1)


## v0.0.1 - 2016-10-18

### Commits
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "we-js-logger",
"version": "0.0.1",
"version": "0.0.2-0",
"description": "A logger for Node and Browser JS with Rollbar and Logentries transports",
"author": "WeWork Digital <dev-team@wework.com>",
"contributors": [
Expand Down

0 comments on commit 89007c0

Please sign in to comment.