Skip to content

Commit 292bce2

Browse files
author
Mike Nason
committed
v2.0.0-4
1 parent 1ea3b8f commit 292bce2

File tree

3 files changed

+48
-44
lines changed

3 files changed

+48
-44
lines changed

‎API.md‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
- [write](#write-1)
1010
- [ClientRollbarLogger](#clientrollbarlogger)
1111
- [write](#write-2)
12-
- [bunyanToRollbarLevelMap](#bunyantorollbarlevelmap)
13-
- [bunyanLevelToRollbarLevelName](#bunyanleveltorollbarlevelname)
1412
- [NodeLogger](#nodelogger)
1513
- [BUNYAN_CONFIG_FIELDS](#bunyan_config_fields)
1614
- [DEFAULT_ROOT_FIELDS](#default_root_fields)
@@ -22,13 +20,15 @@
2220
- [logIt](#logit)
2321
- [ServerRollbarLogger](#serverrollbarlogger)
2422
- [write](#write-3)
23+
- [bunyanToRollbarLevelMap](#bunyantorollbarlevelmap)
24+
- [bunyanLevelToRollbarLevelName](#bunyanleveltorollbarlevelname)
2525
- [ServerLogentriesLogger](#serverlogentrieslogger)
2626
- [createRequestLogger](#createrequestlogger)
2727
- [requestLoggerMiddleware](#requestloggermiddleware)
2828

2929
## ClientLogger
3030

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

3333
A logger than can be used in browsers
3434

@@ -40,13 +40,13 @@ A logger than can be used in browsers
4040

4141
## ClientConsoleLogger
4242

43-
[src/util/client/consoleLogger.js:9-9](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/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/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/client/consoleLogger.js#L9-L9 "Source code on GitHub")
4444

4545
Pretty logging to `console` for client applications
4646

4747
### write
4848

49-
[src/util/client/consoleLogger.js:16-48](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/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/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/client/consoleLogger.js#L16-L48 "Source code on GitHub")
5050

5151
Transport to `console`
5252

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

5959
## ClientLogentriesLogger
6060

61-
[src/util/client/logentriesLogger.js:10-23](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/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/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/client/logentriesLogger.js#L10-L23 "Source code on GitHub")
6262

6363
Custom bunyan stream that transports to Logentries from client applications
6464

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

7171
### write
7272

73-
[src/util/client/logentriesLogger.js:30-37](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/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/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/client/logentriesLogger.js#L30-L37 "Source code on GitHub")
7474

7575
Transport logs to Logentries
7676

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

8383
## ClientRollbarLogger
8484

85-
[src/util/client/rollbarLogger.js:21-37](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/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/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/client/rollbarLogger.js#L21-L37 "Source code on GitHub")
8686

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

100100
### write
101101

102-
[src/util/client/rollbarLogger.js:44-55](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/client/rollbarLogger.js#L44-L55 "Source code on GitHub")
102+
[src/util/client/rollbarLogger.js:44-56](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/client/rollbarLogger.js#L44-L56 "Source code on GitHub")
103103

104104
Transport logs to Rollbar
105105

@@ -109,29 +109,9 @@ Transport logs to Rollbar
109109

110110
Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)**
111111

112-
## bunyanToRollbarLevelMap
113-
114-
[src/util/common/rollbar.js:11-18](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/rollbar.js#L11-L18 "Source code on GitHub")
115-
116-
Map of bunyan log levels to Rollbar levels
117-
<https://github.com/trentm/node-bunyan#levels>
118-
<https://rollbar.com/docs/notifier/rollbar.js/api/#rollbardebuginfowarnwarningerrorcritical>
119-
120-
## bunyanLevelToRollbarLevelName
121-
122-
[src/util/common/rollbar.js:25-28](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/rollbar.js#L25-L28 "Source code on GitHub")
123-
124-
Convert bunyan log level to rollbar level. Defaults to 'error'.
125-
126-
**Parameters**
127-
128-
- `level` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** bunyan log level (optional, default `bunyan.ERROR`)
129-
130-
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Rollbar log level
131-
132112
## NodeLogger
133113

134-
[src/node.js:68-82](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/node.js#L68-L82 "Source code on GitHub")
114+
[src/node.js:68-82](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/node.js#L68-L82 "Source code on GitHub")
135115

136116
A logger than can be used in node processes
137117

@@ -143,33 +123,33 @@ A logger than can be used in node processes
143123

144124
## BUNYAN_CONFIG_FIELDS
145125

146-
[src/util/common/config.js:9-14](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/config.js#L9-L14 "Source code on GitHub")
126+
[src/util/common/config.js:9-14](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/config.js#L9-L14 "Source code on GitHub")
147127

148128
Config keys that should always be passed to
149129
`bunyan.createLogger`
150130

151131
## DEFAULT_ROOT_FIELDS
152132

153-
[src/util/common/config.js:22-25](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/config.js#L22-L25 "Source code on GitHub")
133+
[src/util/common/config.js:22-25](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/config.js#L22-L25 "Source code on GitHub")
154134

155135
Whitelist of extra config keys that should be
156136
passed to `bunyan.createLogger` to form
157137
root logger fields.
158138

159139
## BUNYAN_LOGGER_LEVELS
160140

161-
[src/util/common/config.js:32-32](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/config.js#L32-L32 "Source code on GitHub")
141+
[src/util/common/config.js:32-32](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/config.js#L32-L32 "Source code on GitHub")
162142

163143
Array of bunyan's different log levels.
164144
<https://github.com/trentm/node-bunyan#levels>
165145

166146
## DEFAULT_CONFIG
167147

168-
[src/util/common/config.js:35-47](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/config.js#L35-L47 "Source code on GitHub")
148+
[src/util/common/config.js:35-47](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/config.js#L35-L47 "Source code on GitHub")
169149

170150
## assembleConfig
171151

172-
[src/util/common/config.js:60-67](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/config.js#L60-L67 "Source code on GitHub")
152+
[src/util/common/config.js:60-67](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/config.js#L60-L67 "Source code on GitHub")
173153

174154
Merges config with DEFAULT_CONFIG, and appends passed in streams
175155
with pre-configured streams for the runtime.
@@ -186,7 +166,7 @@ Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refer
186166

187167
## toBunyanConfig
188168

189-
[src/util/common/config.js:78-80](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/config.js#L78-L80 "Source code on GitHub")
169+
[src/util/common/config.js:78-80](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/config.js#L78-L80 "Source code on GitHub")
190170

191171
Create a config objct for bunyan from a full `we-js-logger` config object.
192172
Extra keys passed to `bunyan.createLogger` become root logger fields, pass
@@ -201,7 +181,7 @@ Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refer
201181

202182
## logForLevel
203183

204-
[src/util/common/logForLevel.js:10-22](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/logForLevel.js#L10-L22 "Source code on GitHub")
184+
[src/util/common/logForLevel.js:10-22](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/logForLevel.js#L10-L22 "Source code on GitHub")
205185

206186
Creates a log method for a particular level
207187

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

214194
## logIt
215195

216-
[src/util/common/logForLevel.js:19-21](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/common/logForLevel.js#L19-L21 "Source code on GitHub")
196+
[src/util/common/logForLevel.js:19-21](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/logForLevel.js#L19-L21 "Source code on GitHub")
217197

218198
Log at a level.
219199
Must be bound to a logger instance.
@@ -226,7 +206,7 @@ Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Re
226206

227207
## ServerRollbarLogger
228208

229-
[src/util/server/rollbarLogger.js:12-21](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/server/rollbarLogger.js#L12-L21 "Source code on GitHub")
209+
[src/util/server/rollbarLogger.js:12-21](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/server/rollbarLogger.js#L12-L21 "Source code on GitHub")
230210

231211
Custom bunyan stream that transports to Rollbar from a node process.
232212
See <https://rollbar.com/docs/notifier/node_rollbar/> for integration details
@@ -240,7 +220,7 @@ See <https://rollbar.com/docs/notifier/node_rollbar/> for integration details
240220

241221
### write
242222

243-
[src/util/server/rollbarLogger.js:31-44](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/src/util/server/rollbarLogger.js#L31-L44 "Source code on GitHub")
223+
[src/util/server/rollbarLogger.js:31-44](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/server/rollbarLogger.js#L31-L44 "Source code on GitHub")
244224

245225
handles `err` and `req` properties, attaches any custom data,
246226
and calls the appropriate Rollbar method.
@@ -251,9 +231,29 @@ and calls the appropriate Rollbar method.
251231

252232
Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)**
253233

234+
## bunyanToRollbarLevelMap
235+
236+
[src/util/common/rollbar.js:11-18](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/rollbar.js#L11-L18 "Source code on GitHub")
237+
238+
Map of bunyan log levels to Rollbar levels
239+
<https://github.com/trentm/node-bunyan#levels>
240+
<https://rollbar.com/docs/notifier/rollbar.js/api/#rollbardebuginfowarnwarningerrorcritical>
241+
242+
## bunyanLevelToRollbarLevelName
243+
244+
[src/util/common/rollbar.js:25-28](https://github.com/wework/we-js-logger/blob/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/common/rollbar.js#L25-L28 "Source code on GitHub")
245+
246+
Convert bunyan log level to rollbar level. Defaults to 'error'.
247+
248+
**Parameters**
249+
250+
- `level` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** bunyan log level (optional, default `bunyan.ERROR`)
251+
252+
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Rollbar log level
253+
254254
## ServerLogentriesLogger
255255

256-
[src/util/server/logentriesLogger.js:10-20](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/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/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/server/logentriesLogger.js#L10-L20 "Source code on GitHub")
257257

258258
Custom bunyan stream that transports to logentries from a node process
259259

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

269269
## createRequestLogger
270270

271-
[src/util/server/requestLogger.js:12-48](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/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/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/server/requestLogger.js#L12-L48 "Source code on GitHub")
272272

273273
Create a request loging express middleware
274274

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

283283
## requestLoggerMiddleware
284284

285-
[src/util/server/requestLogger.js:24-47](https://github.com/wework/we-js-logger/blob/026970981c04d6e7c9a78f8892df6e9ed7b3158c/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/1ea3b8f13522e752ca9c63c5b079be78a5f3b785/src/util/server/requestLogger.js#L24-L47 "Source code on GitHub")
286286

287287
Request Logger Middleware
288288
Adds base logging to every request

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ 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-4](https://github.com/wework/we-js-logger/compare/v2.0.0-3...v2.0.0-4)
7+
> 7 November 2017
8+
- Cleanup rollbar args [`1ea3b8f`](https://github.com/wework/we-js-logger/commit/1ea3b8f13522e752ca9c63c5b079be78a5f3b785)
9+
610
#### [v2.0.0-3](https://github.com/wework/we-js-logger/compare/v2.0.0-2...v2.0.0-3)
711
> 7 November 2017
812
- Switch from ghooks to husky [`0269709`](https://github.com/wework/we-js-logger/commit/026970981c04d6e7c9a78f8892df6e9ed7b3158c)

‎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-3",
3+
"version": "2.0.0-4",
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)