Skip to content

Commit b1da984

Browse files
author
Mike Nason
committed
v2.0.0-2
1 parent 825a941 commit b1da984

File tree

3 files changed

+112
-109
lines changed

3 files changed

+112
-109
lines changed

‎API.md‎

Lines changed: 106 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,6 @@
33
### Table of Contents
44

55
- [ClientLogger](#clientlogger)
6-
- [logForLevel](#logforlevel)
7-
- [logIt](#logit)
8-
- [BUNYAN_CONFIG_FIELDS](#bunyan_config_fields)
9-
- [DEFAULT_ROOT_FIELDS](#default_root_fields)
10-
- [BUNYAN_LOGGER_LEVELS](#bunyan_logger_levels)
11-
- [DEFAULT_CONFIG](#default_config)
12-
- [assembleConfig](#assembleconfig)
13-
- [toBunyanConfig](#tobunyanconfig)
146
- [ClientConsoleLogger](#clientconsolelogger)
157
- [write](#write)
168
- [ClientLogentriesLogger](#clientlogentrieslogger)
@@ -20,6 +12,14 @@
2012
- [bunyanToRollbarLevelMap](#bunyantorollbarlevelmap)
2113
- [bunyanLevelToRollbarLevelName](#bunyanleveltorollbarlevelname)
2214
- [NodeLogger](#nodelogger)
15+
- [BUNYAN_CONFIG_FIELDS](#bunyan_config_fields)
16+
- [DEFAULT_ROOT_FIELDS](#default_root_fields)
17+
- [BUNYAN_LOGGER_LEVELS](#bunyan_logger_levels)
18+
- [DEFAULT_CONFIG](#default_config)
19+
- [assembleConfig](#assembleconfig)
20+
- [toBunyanConfig](#tobunyanconfig)
21+
- [logForLevel](#logforlevel)
22+
- [logIt](#logit)
2323
- [ServerRollbarLogger](#serverrollbarlogger)
2424
- [write](#write-3)
2525
- [ServerLogentriesLogger](#serverlogentrieslogger)
@@ -28,7 +28,7 @@
2828

2929
## ClientLogger
3030

31-
[src/client.js:80-86](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/client.js#L80-L86 "Source code on GitHub")
31+
[src/client.js:80-86](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/client.js#L80-L86 "Source code on GitHub")
3232

3333
A logger than can be used in browsers
3434

@@ -38,98 +38,15 @@ A logger than can be used in browsers
3838
- `logger` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** an instance of a `bunyan` logger to use internally.
3939
this is meant to be used by the `child` method.
4040

41-
## logForLevel
42-
43-
[src/util/common/logForLevel.js:10-22](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/logForLevel.js#L10-L22 "Source code on GitHub")
44-
45-
Creates a log method for a particular level
46-
47-
**Parameters**
48-
49-
- `level` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
50-
51-
Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)**
52-
53-
## logIt
54-
55-
[src/util/common/logForLevel.js:19-21](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/logForLevel.js#L19-L21 "Source code on GitHub")
56-
57-
Log at a level.
58-
Must be bound to a logger instance.
59-
60-
**Parameters**
61-
62-
- `args` **any**
63-
64-
Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)**
65-
66-
## BUNYAN_CONFIG_FIELDS
67-
68-
[src/util/common/config.js:9-14](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/config.js#L9-L14 "Source code on GitHub")
69-
70-
Config keys that should always be passed to
71-
`bunyan.createLogger`
72-
73-
## DEFAULT_ROOT_FIELDS
74-
75-
[src/util/common/config.js:22-25](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/config.js#L22-L25 "Source code on GitHub")
76-
77-
Whitelist of extra config keys that should be
78-
passed to `bunyan.createLogger` to form
79-
root logger fields.
80-
81-
## BUNYAN_LOGGER_LEVELS
82-
83-
[src/util/common/config.js:32-32](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/config.js#L32-L32 "Source code on GitHub")
84-
85-
Array of bunyan's different log levels.
86-
<https://github.com/trentm/node-bunyan#levels>
87-
88-
## DEFAULT_CONFIG
89-
90-
[src/util/common/config.js:35-47](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/config.js#L35-L47 "Source code on GitHub")
91-
92-
## assembleConfig
93-
94-
[src/util/common/config.js:60-67](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/config.js#L60-L67 "Source code on GitHub")
95-
96-
Merges config with DEFAULT_CONFIG, and appends passed in streams
97-
with pre-configured streams for the runtime.
98-
99-
This is used to configure this library, not bunyan as it has a lot of
100-
extra information. See `toBunyanConfig` below.
101-
102-
**Parameters**
103-
104-
- `config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
105-
- `getStreamsForRuntime` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** returns appended config.streams
106-
107-
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** runtimeConfig
108-
109-
## toBunyanConfig
110-
111-
[src/util/common/config.js:78-80](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/config.js#L78-L80 "Source code on GitHub")
112-
113-
Create a config objct for bunyan from a full `we-js-logger` config object.
114-
Extra keys passed to `bunyan.createLogger` become root logger fields, pass
115-
a custom `config.rootFields` to control this behavior
116-
117-
**Parameters**
118-
119-
- `config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
120-
- `config.rootFields` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra fields to pass to bunyan
121-
122-
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** config for bunyan.createLogger
123-
12441
## ClientConsoleLogger
12542

126-
[src/util/client/consoleLogger.js:9-9](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/client/consoleLogger.js#L9-L9 "Source code on GitHub")
43+
[src/util/client/consoleLogger.js:9-9](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/client/consoleLogger.js#L9-L9 "Source code on GitHub")
12744

12845
Pretty logging to `console` for client applications
12946

13047
### write
13148

132-
[src/util/client/consoleLogger.js:16-48](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/client/consoleLogger.js#L16-L48 "Source code on GitHub")
49+
[src/util/client/consoleLogger.js:16-48](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/client/consoleLogger.js#L16-L48 "Source code on GitHub")
13350

13451
Transport to `console`
13552

@@ -141,7 +58,7 @@ Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Re
14158

14259
## ClientLogentriesLogger
14360

144-
[src/util/client/logentriesLogger.js:10-23](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/client/logentriesLogger.js#L10-L23 "Source code on GitHub")
61+
[src/util/client/logentriesLogger.js:10-23](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/client/logentriesLogger.js#L10-L23 "Source code on GitHub")
14562

14663
Custom bunyan stream that transports to Logentries from client applications
14764

@@ -153,7 +70,7 @@ Custom bunyan stream that transports to Logentries from client applications
15370

15471
### write
15572

156-
[src/util/client/logentriesLogger.js:30-37](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/client/logentriesLogger.js#L30-L37 "Source code on GitHub")
73+
[src/util/client/logentriesLogger.js:30-37](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/client/logentriesLogger.js#L30-L37 "Source code on GitHub")
15774

15875
Transport logs to Logentries
15976

@@ -165,7 +82,7 @@ Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Re
16582

16683
## ClientRollbarLogger
16784

168-
[src/util/client/rollbarLogger.js:21-37](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/client/rollbarLogger.js#L21-L37 "Source code on GitHub")
85+
[src/util/client/rollbarLogger.js:21-37](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/client/rollbarLogger.js#L21-L37 "Source code on GitHub")
16986

17087
Custom rollbar stream that transports to logentries from a browser
17188
Wortks with a global Rollbar instance that is already initialized.
@@ -182,7 +99,7 @@ integrating Rollbar in client apps
18299

183100
### write
184101

185-
[src/util/client/rollbarLogger.js:44-55](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/client/rollbarLogger.js#L44-L55 "Source code on GitHub")
102+
[src/util/client/rollbarLogger.js:44-55](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/client/rollbarLogger.js#L44-L55 "Source code on GitHub")
186103

187104
Transport logs to Rollbar
188105

@@ -194,15 +111,15 @@ Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Re
194111

195112
## bunyanToRollbarLevelMap
196113

197-
[src/util/common/rollbar.js:11-18](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/rollbar.js#L11-L18 "Source code on GitHub")
114+
[src/util/common/rollbar.js:11-18](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/rollbar.js#L11-L18 "Source code on GitHub")
198115

199116
Map of bunyan log levels to Rollbar levels
200117
<https://github.com/trentm/node-bunyan#levels>
201118
<https://rollbar.com/docs/notifier/rollbar.js/api/#rollbardebuginfowarnwarningerrorcritical>
202119

203120
## bunyanLevelToRollbarLevelName
204121

205-
[src/util/common/rollbar.js:25-28](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/common/rollbar.js#L25-L28 "Source code on GitHub")
122+
[src/util/common/rollbar.js:25-28](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/rollbar.js#L25-L28 "Source code on GitHub")
206123

207124
Convert bunyan log level to rollbar level. Defaults to 'error'.
208125

@@ -214,7 +131,7 @@ Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refer
214131

215132
## NodeLogger
216133

217-
[src/node.js:68-82](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/node.js#L68-L82 "Source code on GitHub")
134+
[src/node.js:68-82](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/node.js#L68-L82 "Source code on GitHub")
218135

219136
A logger than can be used in node processes
220137

@@ -224,9 +141,92 @@ A logger than can be used in node processes
224141
- `logger` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** an instance of a `bunyan` logger to use internally.
225142
this is meant to be used by the `child` method.
226143

144+
## BUNYAN_CONFIG_FIELDS
145+
146+
[src/util/common/config.js:9-14](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/config.js#L9-L14 "Source code on GitHub")
147+
148+
Config keys that should always be passed to
149+
`bunyan.createLogger`
150+
151+
## DEFAULT_ROOT_FIELDS
152+
153+
[src/util/common/config.js:22-25](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/config.js#L22-L25 "Source code on GitHub")
154+
155+
Whitelist of extra config keys that should be
156+
passed to `bunyan.createLogger` to form
157+
root logger fields.
158+
159+
## BUNYAN_LOGGER_LEVELS
160+
161+
[src/util/common/config.js:32-32](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/config.js#L32-L32 "Source code on GitHub")
162+
163+
Array of bunyan's different log levels.
164+
<https://github.com/trentm/node-bunyan#levels>
165+
166+
## DEFAULT_CONFIG
167+
168+
[src/util/common/config.js:35-47](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/config.js#L35-L47 "Source code on GitHub")
169+
170+
## assembleConfig
171+
172+
[src/util/common/config.js:60-67](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/config.js#L60-L67 "Source code on GitHub")
173+
174+
Merges config with DEFAULT_CONFIG, and appends passed in streams
175+
with pre-configured streams for the runtime.
176+
177+
This is used to configure this library, not bunyan as it has a lot of
178+
extra information. See `toBunyanConfig` below.
179+
180+
**Parameters**
181+
182+
- `config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
183+
- `getStreamsForRuntime` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** returns appended config.streams
184+
185+
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** runtimeConfig
186+
187+
## toBunyanConfig
188+
189+
[src/util/common/config.js:78-80](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/config.js#L78-L80 "Source code on GitHub")
190+
191+
Create a config objct for bunyan from a full `we-js-logger` config object.
192+
Extra keys passed to `bunyan.createLogger` become root logger fields, pass
193+
a custom `config.rootFields` to control this behavior
194+
195+
**Parameters**
196+
197+
- `config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
198+
- `config.rootFields` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra fields to pass to bunyan
199+
200+
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** config for bunyan.createLogger
201+
202+
## logForLevel
203+
204+
[src/util/common/logForLevel.js:10-22](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/logForLevel.js#L10-L22 "Source code on GitHub")
205+
206+
Creates a log method for a particular level
207+
208+
**Parameters**
209+
210+
- `level` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
211+
212+
Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)**
213+
214+
## logIt
215+
216+
[src/util/common/logForLevel.js:19-21](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/common/logForLevel.js#L19-L21 "Source code on GitHub")
217+
218+
Log at a level.
219+
Must be bound to a logger instance.
220+
221+
**Parameters**
222+
223+
- `args` **any**
224+
225+
Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)**
226+
227227
## ServerRollbarLogger
228228

229-
[src/util/server/rollbarLogger.js:13-24](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/server/rollbarLogger.js#L13-L24 "Source code on GitHub")
229+
[src/util/server/rollbarLogger.js:12-21](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/server/rollbarLogger.js#L12-L21 "Source code on GitHub")
230230

231231
Custom bunyan stream that transports to Rollbar from a node process.
232232
See <https://rollbar.com/docs/notifier/node_rollbar/> for integration details
@@ -238,11 +238,9 @@ See <https://rollbar.com/docs/notifier/node_rollbar/> for integration details
238238
- `token.codeVersion`
239239
- `token.environment`
240240

241-
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** new Rollbar instance
242-
243241
### write
244242

245-
[src/util/server/rollbarLogger.js:34-47](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/server/rollbarLogger.js#L34-L47 "Source code on GitHub")
243+
[src/util/server/rollbarLogger.js:31-44](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/server/rollbarLogger.js#L31-L44 "Source code on GitHub")
246244

247245
handles `err` and `req` properties, attaches any custom data,
248246
and calls the appropriate Rollbar method.
@@ -255,7 +253,7 @@ Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Re
255253

256254
## ServerLogentriesLogger
257255

258-
[src/util/server/logentriesLogger.js:10-20](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/server/logentriesLogger.js#L10-L20 "Source code on GitHub")
256+
[src/util/server/logentriesLogger.js:10-20](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/server/logentriesLogger.js#L10-L20 "Source code on GitHub")
259257

260258
Custom bunyan stream that transports to logentries from a node process
261259

@@ -270,7 +268,7 @@ Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refer
270268

271269
## createRequestLogger
272270

273-
[src/util/server/requestLogger.js:12-48](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/server/requestLogger.js#L12-L48 "Source code on GitHub")
271+
[src/util/server/requestLogger.js:12-48](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/server/requestLogger.js#L12-L48 "Source code on GitHub")
274272

275273
Create a request loging express middleware
276274

@@ -284,7 +282,7 @@ Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Ref
284282

285283
## requestLoggerMiddleware
286284

287-
[src/util/server/requestLogger.js:24-47](https://github.com/wework/we-js-logger/blob/dd44c1cb09909776bb364ba85478b28b17ff522c/src/util/server/requestLogger.js#L24-L47 "Source code on GitHub")
285+
[src/util/server/requestLogger.js:24-47](https://github.com/wework/we-js-logger/blob/825a941ba2da4238063e804b86266b3894f44b88/src/util/server/requestLogger.js#L24-L47 "Source code on GitHub")
288286

289287
Request Logger Middleware
290288
Adds base logging to every request

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
33

44
Generated by [auto-changelog](https://github.com/CookPete/auto-changelog).
55

6+
#### [v2.0.0-2](https://github.com/wework/we-js-logger/compare/v2.0.0-1...v2.0.0-2)
7+
> 7 November 2017
8+
- Fixup server rollbar logger [`7fe98f9`](https://github.com/wework/we-js-logger/commit/7fe98f9603cf28394d9fed4d8aeaa92aaef7e9e1)
9+
- Fixup server rollbar logger [`825a941`](https://github.com/wework/we-js-logger/commit/825a941ba2da4238063e804b86266b3894f44b88)
10+
611
#### [v2.0.0-1](https://github.com/wework/we-js-logger/compare/v2.0.0-0...v2.0.0-1)
712
> 6 November 2017
813
- Refactor [Client|Server]RollbarLogger to work with notifier API changes [`dd44c1c`](https://github.com/wework/we-js-logger/commit/dd44c1cb09909776bb364ba85478b28b17ff522c)

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "we-js-logger",
3-
"version": "2.0.0-1",
3+
"version": "2.0.0-2",
44
"description": "A logger for Node and Browser JS with Rollbar and Logentries transports",
55
"author": "WeWork Digital <dev-team@wework.com>",
66
"contributors": [

0 commit comments

Comments
 (0)