UNPKG

8.61 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Module: logger</title>
6
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14</head>
15
16<body>
17
18<div id="main">
19
20 <h1 class="page-title">Module: logger</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31
32
33</header>
34
35<article>
36 <div class="container-overview">
37
38
39
40
41
42 </div>
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59 <h3 class="subsection-title">Methods</h3>
60
61
62
63
64
65
66
67 <h4 class="name" id=".getLogger"><span class="type-signature">(static) </span>getLogger<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
68
69
70
71
72
73
74<div class="description">
75 <p>Returns a logger.</p>
76</div>
77
78
79
80
81
82
83
84
85
86 <h5>Parameters:</h5>
87
88
89<table class="params">
90 <thead>
91 <tr>
92
93 <th>Name</th>
94
95
96 <th>Type</th>
97
98
99 <th>Attributes</th>
100
101
102
103
104 <th class="last">Description</th>
105 </tr>
106 </thead>
107
108 <tbody>
109
110
111 <tr>
112
113 <td class="name"><code>options</code></td>
114
115
116 <td class="type">
117
118
119<span class="param-type">Object</span>
120
121
122
123 </td>
124
125
126 <td class="attributes">
127
128 &lt;optional><br>
129
130
131
132
133
134 </td>
135
136
137
138
139 <td class="description last"><p>Options for configuring the logger</p>
140 <h6>Properties</h6>
141
142
143<table class="params">
144 <thead>
145 <tr>
146
147 <th>Name</th>
148
149
150 <th>Type</th>
151
152
153 <th>Attributes</th>
154
155
156
157
158 <th class="last">Description</th>
159 </tr>
160 </thead>
161
162 <tbody>
163
164
165 <tr>
166
167 <td class="name"><code>console</code></td>
168
169
170 <td class="type">
171
172
173<span class="param-type">Boolean</span>
174
175
176
177 </td>
178
179
180 <td class="attributes">
181
182 &lt;optional><br>
183
184
185
186
187
188 </td>
189
190
191
192
193 <td class="description last"><p>Whether or not to log to the console. Default true.</p></td>
194 </tr>
195
196
197
198 <tr>
199
200 <td class="name"><code>logLevel</code></td>
201
202
203 <td class="type">
204
205
206<span class="param-type">String</span>
207
208
209
210 </td>
211
212
213 <td class="attributes">
214
215 &lt;optional><br>
216
217
218
219
220
221 </td>
222
223
224
225
226 <td class="description last"><p>The log level to use.
227 (error, warn, info, verbose, debug, silly).
228 Defaults to warn.</p></td>
229 </tr>
230
231
232
233 <tr>
234
235 <td class="name"><code>fileName</code></td>
236
237
238 <td class="type">
239
240
241<span class="param-type">String</span>
242
243
244
245 </td>
246
247
248 <td class="attributes">
249
250 &lt;optional><br>
251
252
253
254
255
256 </td>
257
258
259
260
261 <td class="description last"><p>File to log to. Defaults to none (console only).</p></td>
262 </tr>
263
264
265
266 <tr>
267
268 <td class="name"><code>module</code></td>
269
270
271 <td class="type">
272
273
274<span class="param-type">Object</span>
275
276
277
278 </td>
279
280
281 <td class="attributes">
282
283 &lt;optional><br>
284
285
286
287
288
289 </td>
290
291
292
293
294 <td class="description last"><p>The module the logger is used from. Used to put the
295 file name in the log message.</p></td>
296 </tr>
297
298
299
300 <tr>
301
302 <td class="name"><code>json</code></td>
303
304
305 <td class="type">
306
307
308<span class="param-type">Boolean</span>
309
310
311
312 </td>
313
314
315 <td class="attributes">
316
317 &lt;optional><br>
318
319
320
321
322
323 </td>
324
325
326
327
328 <td class="description last"><p>Whether or not to format message as JSON. Default false.</p></td>
329 </tr>
330
331
332
333 <tr>
334
335 <td class="name"><code>verboseLabel</code></td>
336
337
338 <td class="type">
339
340
341<span class="param-type">Boolean</span>
342
343
344
345 </td>
346
347
348 <td class="attributes">
349
350 &lt;optional><br>
351
352
353
354
355
356 </td>
357
358
359
360
361 <td class="description last"><p>Whether or not to include the verbose label in log.
362 Default false.</p></td>
363 </tr>
364
365
366 </tbody>
367</table>
368
369 </td>
370 </tr>
371
372
373 </tbody>
374</table>
375
376
377
378
379
380
381<dl class="details">
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414</dl>
415
416
417
418
419
420
421
422
423
424
425
426
427
428<h5>Returns:</h5>
429
430
431<div class="param-desc">
432 <p>An instance of a logger</p>
433</div>
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449</article>
450
451</section>
452
453
454
455
456</div>
457
458<nav>
459 <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-authn.html">authn</a></li><li><a href="module-bigIqLicenseProviderFactory.html">bigIqLicenseProviderFactory</a></li><li><a href="module-cryptoUtil.html">cryptoUtil</a></li><li><a href="module-httpUtil.html">httpUtil</a></li><li><a href="module-ipc.html">ipc</a></li><li><a href="module-localCryptoUtil.html">localCryptoUtil</a></li><li><a href="module-localKeyUtil.html">localKeyUtil</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-metricsCollector.html">metricsCollector</a></li><li><a href="module-sharedConstants.html">sharedConstants</a></li><li><a href="module-signals.html">signals</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="BigIp.html">BigIp</a></li><li><a href="BigIpCluster.html">BigIpCluster</a></li><li><a href="BigIpGtm.html">BigIpGtm</a></li><li><a href="BigIpOnboard.html">BigIpOnboard</a></li><li><a href="BigIq.html">BigIq</a></li><li><a href="BigIq50LicenseProvider.html">BigIq50LicenseProvider</a></li><li><a href="BigIq52LicenseProvider.html">BigIq52LicenseProvider</a></li><li><a href="BigIq53LicenseProvider.html">BigIq53LicenseProvider</a></li><li><a href="BigIq54LicenseProvider.html">BigIq54LicenseProvider</a></li><li><a href="CloudProvider.html">CloudProvider</a></li><li><a href="DnsProvider.html">DnsProvider</a></li><li><a href="GenericNodeProvider.html">GenericNodeProvider</a></li><li><a href="GtmDnsProvider.html">GtmDnsProvider</a></li><li><a href="IControl.html">IControl</a></li></ul><h3>Mixins</h3><ul><li><a href="bigIqClusterMixins.html">bigIqClusterMixins</a></li><li><a href="bigIqOnboardMixins.html">bigIqOnboardMixins</a></li></ul><h3>Global</h3><ul><li><a href="global.html#checkTask">checkTask</a></li><li><a href="global.html#forceResetUserPassword">forceResetUserPassword</a></li><li><a href="global.html#getDataFromPropPath">getDataFromPropPath</a></li><li><a href="global.html#getLicenseProvider">getLicenseProvider</a></li></ul>
460</nav>
461
462<br class="clear">
463
464<footer>
465 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
466</footer>
467
468<script> prettyPrint(); </script>
469<script src="scripts/linenumber.js"> </script>
470</body>
471</html>
\No newline at end of file