You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: API.md
+23-23
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@
28
28
29
29
## ClientLogger
30
30
31
-
[src/client.js:80-86](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/client.js#L80-L86"Source code on GitHub")
31
+
[src/client.js:80-86](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/client.js#L80-L86"Source code on GitHub")
32
32
33
33
A logger than can be used in browsers
34
34
@@ -40,13 +40,13 @@ A logger than can be used in browsers
40
40
41
41
## ClientConsoleLogger
42
42
43
-
[src/util/client/consoleLogger.js:9-9](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/client/consoleLogger.js#L9-L9"Source code on GitHub")
44
44
45
45
Pretty logging to `console` for client applications
46
46
47
47
### write
48
48
49
-
[src/util/client/consoleLogger.js:16-48](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/client/consoleLogger.js#L16-L48"Source code on GitHub")
[src/util/client/logentriesLogger.js:10-23](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/client/logentriesLogger.js#L10-L23"Source code on GitHub")
62
62
63
63
Custom bunyan stream that transports to Logentries from client applications
64
64
@@ -70,7 +70,7 @@ Custom bunyan stream that transports to Logentries from client applications
70
70
71
71
### write
72
72
73
-
[src/util/client/logentriesLogger.js:30-37](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/client/logentriesLogger.js#L30-L37"Source code on GitHub")
[src/util/client/rollbarLogger.js:21-37](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/client/rollbarLogger.js#L21-L37"Source code on GitHub")
86
86
87
87
Custom rollbar stream that transports to logentries from a browser
88
88
Wortks with a global Rollbar instance that is already initialized.
@@ -99,7 +99,7 @@ integrating Rollbar in client apps
99
99
100
100
### write
101
101
102
-
[src/util/client/rollbarLogger.js:44-56](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/util/client/rollbarLogger.js#L44-L56"Source code on GitHub")
102
+
[src/util/client/rollbarLogger.js:44-56](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/client/rollbarLogger.js#L44-L56"Source code on GitHub")
[src/node.js:68-82](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/node.js#L68-L82"Source code on GitHub")
114
+
[src/node.js:68-82](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/node.js#L68-L82"Source code on GitHub")
115
115
116
116
A logger than can be used in node processes
117
117
@@ -123,33 +123,33 @@ A logger than can be used in node processes
123
123
124
124
## BUNYAN_CONFIG_FIELDS
125
125
126
-
[src/util/common/config.js:9-14](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/config.js#L9-L14"Source code on GitHub")
127
127
128
128
Config keys that should always be passed to
129
129
`bunyan.createLogger`
130
130
131
131
## DEFAULT_ROOT_FIELDS
132
132
133
-
[src/util/common/config.js:22-25](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/util/common/config.js#L22-L25"Source code on GitHub")
133
+
[src/util/common/config.js:22-26](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/config.js#L22-L26"Source code on GitHub")
134
134
135
135
Whitelist of extra config keys that should be
136
136
passed to `bunyan.createLogger` to form
137
137
root logger fields.
138
138
139
139
## BUNYAN_LOGGER_LEVELS
140
140
141
-
[src/util/common/config.js:32-32](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/util/common/config.js#L32-L32"Source code on GitHub")
141
+
[src/util/common/config.js:33-33](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/config.js#L33-L33"Source code on GitHub")
142
142
143
143
Array of bunyan's different log levels.
144
144
<https://github.com/trentm/node-bunyan#levels>
145
145
146
146
## DEFAULT_CONFIG
147
147
148
-
[src/util/common/config.js:35-47](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/util/common/config.js#L35-L47"Source code on GitHub")
148
+
[src/util/common/config.js:36-48](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/config.js#L36-L48"Source code on GitHub")
149
149
150
150
## assembleConfig
151
151
152
-
[src/util/common/config.js:60-67](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/util/common/config.js#L60-L67"Source code on GitHub")
152
+
[src/util/common/config.js:61-68](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/config.js#L61-L68"Source code on GitHub")
153
153
154
154
Merges config with DEFAULT_CONFIG, and appends passed in streams
[src/util/common/config.js:78-80](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/util/common/config.js#L78-L80"Source code on GitHub")
169
+
[src/util/common/config.js:79-81](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/config.js#L79-L81"Source code on GitHub")
170
170
171
171
Create a config objct for bunyan from a full `we-js-logger` config object.
172
172
Extra keys passed to `bunyan.createLogger` become root logger fields, pass
[src/util/common/logForLevel.js:10-22](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/logForLevel.js#L10-L22"Source code on GitHub")
[src/util/common/logForLevel.js:19-21](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/logForLevel.js#L19-L21"Source code on GitHub")
[src/util/server/rollbarLogger.js:12-21](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/server/rollbarLogger.js#L12-L21"Source code on GitHub")
210
210
211
211
Custom bunyan stream that transports to Rollbar from a node process.
212
212
See <https://rollbar.com/docs/notifier/node_rollbar/> for integration details
@@ -220,7 +220,7 @@ See <https://rollbar.com/docs/notifier/node_rollbar/> for integration details
220
220
221
221
### write
222
222
223
-
[src/util/server/rollbarLogger.js:31-44](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/server/rollbarLogger.js#L31-L44"Source code on GitHub")
224
224
225
225
handles `err` and `req` properties, attaches any custom data,
[src/util/common/rollbar.js:11-18](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/util/common/rollbar.js#L11-L18"Source code on GitHub")
236
+
[src/util/common/rollbar.js:11-18](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/rollbar.js#L11-L18"Source code on GitHub")
[src/util/common/rollbar.js:25-28](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/src/util/common/rollbar.js#L25-L28"Source code on GitHub")
244
+
[src/util/common/rollbar.js:25-28](https://github.com/wework/we-js-logger/blob/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/common/rollbar.js#L25-L28"Source code on GitHub")
245
245
246
246
Convert bunyan log level to rollbar level. Defaults to 'error'.
[src/util/server/logentriesLogger.js:10-20](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/server/logentriesLogger.js#L10-L20"Source code on GitHub")
257
257
258
258
Custom bunyan stream that transports to logentries from a node process
[src/util/server/requestLogger.js:12-48](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/server/requestLogger.js#L12-L48"Source code on GitHub")
[src/util/server/requestLogger.js:24-47](https://github.com/wework/we-js-logger/blob/e04eb30bd53ea9275562bce42e3cae6db44e4836/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/40092326eb67b7e4226500081ec51bc9e64b0277/src/util/server/requestLogger.js#L24-L47"Source code on GitHub")
0 commit comments