npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@livy/slack-webhook-handler

v1.0.3

Published

Sends Livy log records to Slack through notifications

Downloads

112

Readme

@livy/slack-webhook-handler

This Livy handler sends log records to Slack through notifications.


Synchronous logger support: no

Runtime: Node.js


Basic Example

const { SlackWebHookHandler } = require('@livy/slack-webhook-handler')

const handler = new SlackWebHookHandler('https://example.com/logs')

Installation

Install it via npm:

npm install @livy/slack-webhook-handler

Options

The first argument to this handler's constructor is the Slack webhook URL to send logs to.

An object of options can be passed as the second argument.

The following options are available:

bubble

Type: boolean

Default: true

Description: Controls whether records handled by this handler should bubble up to other handlers.

See also: Bubbling

channel

Type: string

Description: Slack channel (encoded ID or name)

excludedFields

Type: string[]

Default: []

Description: A dot separated list of fields to exclude from slack message. E.g. ['context.field1', 'extra.field2'].

formatter

Type: FormatterInterface

Default: new LineFormatter() (pre-configured to respect includeContextAndExtra)

Description: The formatter to use.

iconEmoji

Type: string

Description: The emoji name to use

includeContextAndExtra

Type: boolean

Default: false

Description: Whether the attachment should include context and extra data from a log record

level

Type: LogLevel

Default: 'critical'

Description: Controls which log records should be handled based on their log level.

useAttachment

Type: boolean

Default: true

Description: Whether the message should be added to Slack as attachment (plain text otherwise).

username

Type: string

Description: Name of a bot to deliver the message.

useShortAttachments

Type: boolean

Default: false

Description: Whether the the context/extra messages added to Slack as attachments should be in short style.

Public API

bubble

Controls whether records handled by this handler should bubble up to other handlers. Initially set through the bubble option.

See also: Bubbling

defaultFormatter (read-only)

The formatter used by this handler if no formatter option is set.

formatter

This handler supports formatters by implementing the FormattableHandlerInterface.

slackRecord (read-only)

Get the SlackRecord instance associated with the handler.

level

The minimum log level of a log record to be considered by this handler. Initially set through the level option.

processors

This handler supports processors by implementing the ProcessableHandlerInterface.

reset()

This handler implements the ResettableInterface. Resetting it resets all attached processors.

You usually don't want to call this method manually on an individual handler. Consider calling it on the logger instead.

webhookUrl (read-only)

Get the Slack webhook URL of the handler.