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: docs/transports.md
+35-12Lines changed: 35 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@ There are several [core transports](#built-in-to-winston) included in `winston`
10
10
that leverage the built-in networking and file I/O offered by Node.js core. In
11
11
addition, there are transports which are [actively supported by winston
12
12
contributors](#maintained-by-winston-contributors). And last (but not least)
13
-
there are additional transports written by
13
+
there are additional transports written by
14
14
[members of the community](#community-transports).
15
15
16
16
> Additionally there are transports previously maintained by winston
17
-
> contributors that are [looking for maintainers](#looking-for-maintainers).
17
+
> contributors that are [looking for maintainers](#looking-for-maintainers).
18
18
19
19
***[Built-in to winston](#built-in-to-winston)**
20
20
*[Console](#console-transport)
@@ -59,6 +59,7 @@ there are additional transports written by
59
59
*[SQLite3](#sqlite3-transport)
60
60
*[SSE with KOA 2](#sse-transport-with-koa-2)
61
61
*[Sumo Logic](#sumo-logic-transport)
62
+
*[Worker Thread based async Console transport](#worker-thread-based-async-console-transport)
62
63
*[Winlog2 Transport](#winlog2-transport)
63
64
64
65
***[Looking for maintainers](#looking-for-maintainers)**
@@ -147,7 +148,7 @@ The Stream transport takes a few simple options:
147
148
148
149
## Maintained by winston contributors
149
150
150
-
Starting with `[email protected]` an effort was made to remove any transport which added additional dependencies to `winston`. At the time there were several transports already in `winston` which will have slowly waned in usage. The
151
+
Starting with `[email protected]` an effort was made to remove any transport which added additional dependencies to `winston`. At the time there were several transports already in `winston` which will have slowly waned in usage. The
151
152
following transports are **actively maintained by members of the winston Github
152
153
organization.**
153
154
@@ -578,9 +579,9 @@ logger.log('info', 'Log from LogDNA Winston', meta);
578
579
579
580
### Logzio Transport
580
581
581
-
You can download the logzio transport here : [https://github.com/logzio/winston-logzio](https://github.com/logzio/winston-logzio)
582
+
You can download the logzio transport here : [https://github.com/logzio/winston-logzio](https://github.com/logzio/winston-logzio)
582
583
583
-
*Basic Usage*
584
+
*Basic Usage*
584
585
```js
585
586
constwinston=require('winston');
586
587
constLogzio=require('winston-logzio');
@@ -739,7 +740,7 @@ logger.add(new SeqTransport({
739
740
740
741
*__serverUrl__ - the URL for your Seq server's ingestion
741
742
*__apiKey__ - (optional) The Seq API Key to use
742
-
*__onError__ - Callback to execute when an error occurs within the transport
743
+
*__onError__ - Callback to execute when an error occurs within the transport
743
744
744
745
### SimpleDB Transport
745
746
@@ -762,7 +763,7 @@ The SimpleDB transport takes the following options. All items marked with an ast
762
763
*Metadata:* Logged as a native JSON object to the 'meta' attribute of the item.
763
764
764
765
### Slack Transport
765
-
[winston-slack-webhook-transport][39] is a transport that sends all log messages to the Slack chat service.
766
+
[winston-slack-webhook-transport][39] is a transport that sends all log messages to the Slack chat service.
*__webhookUrl__ - Slack incoming webhook URL. This can be from a basic integration or a bot. **REQUIRED**
786
787
*__channel__ - Slack channel to post message to.
@@ -803,7 +804,7 @@ logger.add(new wbs({
803
804
804
805
// path to the sqlite3 database file on the disk
805
806
db:'<name of sqlite3 database file>',
806
-
807
+
807
808
// A list of params to log
808
809
params: ['level', 'message']
809
810
}));
@@ -823,7 +824,28 @@ Options:
823
824
*__url__: The Sumo Logic HTTP collector URL
824
825
825
826
### SSE transport with KOA 2
826
-
[winston-koa-sse](https://github.com/alexvictoor/winston-koa-sse) is a transport that leverages on Server Sent Event. With this transport you can use your browser console to view your server logs.
827
+
[winston-koa-sse](https://github.com/alexvictoor/winston-koa-sse) is a transport that leverages on Server Sent Event. With this transport you can use your browser console to view your server logs.
0 commit comments