Gathering detailed insights and metrics for winston-slack-webhook-transport
Gathering detailed insights and metrics for winston-slack-webhook-transport
Gathering detailed insights and metrics for winston-slack-webhook-transport
Gathering detailed insights and metrics for winston-slack-webhook-transport
winston-slack-webhook-transport-ts
A Slack transport for Winston 3 that logs to a channel via webhooks. With enabling inject Proxy Agent
winston-slack-hook
Slack WebHook transport for Winston logging library
@syntaxza/slack-webhook-transport
Slack Webhook Transport for Winston 3.x.x allowing retry logic using Bluebird retry
A Slack transport for Winston 3 that logs to a channel via webhooks
npm install winston-slack-webhook-transport
Typescript
Module System
Node Version
NPM Version
JavaScript (98.04%)
Dockerfile (1.96%)
Total Downloads
4,813,591
Last Day
843
Last Week
26,720
Last Month
119,090
Last Year
1,207,798
MIT License
35 Stars
70 Commits
13 Forks
1 Watchers
3 Branches
7 Contributors
Updated on Nov 12, 2024
Minified
Minified + Gzipped
Latest Version
2.3.6
Package Id
winston-slack-webhook-transport@2.3.6
Unpacked Size
23.25 kB
Size
7.13 kB
File Count
6
NPM Version
8.19.4
Node Version
16.20.2
Published on
Nov 12, 2024
Cumulative downloads
Total Downloads
2
A Slack transport for Winston 3+ that logs to a channel via webhooks.
npm install winston winston-slack-webhook-transport
1const winston = require("winston"); 2const SlackHook = require("winston-slack-webhook-transport"); 3 4const logger = winston.createLogger({ 5 level: "info", 6 transports: [ 7 new SlackHook({ 8 webhookUrl: "https://hooks.slack.com/services/xxx/xxx/xxx" 9 }) 10 ] 11}); 12 13logger.info("This should now appear on Slack");
1const winston = require("winston"); 2const SlackHook = require("winston-slack-webhook-transport"); 3 4const logger = winston.createLogger({}); 5 6logger.add(new SlackHook({ webhookUrl: "https://hooks.slack.com/services/xxx/xxx/xxx" }));
webhookUrl
REQUIRED - Slack incoming webhook URL. Follow steps 1 through 3 at this link to create a new webhook if you don't already have one.formatter
- Custom function to format messages with. This function accepts the info
object (see Winston documentation) and must return an object with at least one of the following three keys: text
(string), attachments
(array of attachment objects), blocks
(array of layout block objects). These will be used to structure the format of the logged Slack message. By default, messages will use the format of [level]: [message]
with no attachments or layout blocks. A value of false
can also be returned to prevent a message from being sent to Slack.level
- Level to log. Global settings will apply if left undefined.unfurlLinks
- Enables or disables link unfurling. (Default: false
)unfurlMedia
- Enables or disables media unfurling. (Default: false
)mrkdwn
- Enables or disables mrkdwn
formatting within attachments or layout blocks (Default: false
)proxy
- Allows specifying a proxy server that gets passed directly down to Axios (Default: undefined
)channel
- Overrides the webhook's default channel. This should be a channel ID. (Default: undefined
)username
- Overrides the webhook's default username. (Default: undefined
)iconEmoji
- An emoji code string to use in place of the default icon. (Interchangeable with iconUrl
) (Default: undefined
)iconUrl
- An icon image URL string to use in place of the default icon. Interchangeable with iconEmoji
. (Default: undefined
)emitAxiosErrors
- Enables or disables emitting errors when Axios throws an error. This can occur if Slack returns a non-200 response code, such as 429 Too Many Requests
. When disabled, Slack errors will be silently dropped, though if unhandled this can possibly lead to unexpected and transient crashes. Enable to handle those errors yourself. (Default: false
)winston-slack-webhook-transport
supports the ability to format messages using Slack's message layout features. To do this, supply a custom formatter function that returns the requisite object structure to create the desired layout. You can use the Slack Block Kit Builder to quickly and easily prototype advanced layouts using Block Kit.
If for some reason you don't want to send a message to Slack, you can also return false
to prevent the log message from being sent.
Formatters can also override the channel the message is posted to, username, and icon by defining the properties channel
, username
, iconEmoji
, or iconUrl
in the same object structure. These will override any options set in the transport constructor.
Note that if you're using Block Kit using either the attachments
or blocks
keys, the text
parameter will function as a fallback for surfaces that do not support Block Kit, such as push notifications. It is recommended to include text
when possible in these cases.
1const winston = require("winston"); 2const SlackHook = require("winston-slack-webhook-transport"); 3 4const logger = winston.createLogger({ 5 level: "info", 6 transports: [ 7 new SlackHook({ 8 webhookUrl: "https://hooks.slack.com/services/xxx/xxx/xxx", 9 formatter: info => { 10 return { 11 text: "This will function as a fallback for surfaces that don't support Block Kit, like IRC clients or mobile push notifications.", 12 blocks: [ 13 { 14 type: "section", 15 text: { 16 type: "plain_text", 17 text: "You can pass more info to the formatter by supplying additional parameters in the logger call" 18 } 19 } 20 ], 21 attachments: [ 22 { 23 text: "Or don't pass anything. That's fine too" 24 } 25 ] 26 } 27 } 28 }) 29 ] 30}); 31 32logger.info("Definitely try playing around with this.");
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
packaging workflow detected
Details
Reason
4 existing vulnerabilities detected
Details
Reason
dependency not pinned by hash detected -- score normalized to 2
Details
Reason
Found 4/21 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreLast Day
39.6%
843
Compared to previous day
Last Week
-14.8%
26,720
Compared to previous week
Last Month
6.9%
119,090
Compared to previous month
Last Year
0.1%
1,207,798
Compared to previous year