logsans
TypeScript icon, indicating that this package has built-in type declarations

0.0.10 • Public • Published

LogSans - Companion Library for LogSnag

LogSans Client - LogSans is a companion library for LogSnag. LogSans enables notification for events that have NOT happened in a pre-defined frequency.

NPM Version

Installation

npm install --save logsans

Usage

Import Library

const {LogSnag} = require("logsans")

🕺 Notice how we've named the variable LogSnag (instead of the LogSans). This allows you to not have to change your exsiting code if you have already implemented LogSnag. 😎

Initialize Client

const logsnag = new LogSnag(process.env.YOUR_LOG_SNAG_TOKEN);

Publish Event & Track Event

logsnag.publish({
    project: "your-logsnag-project",
    channel: "your-logsnag-channel",
    event: "Your logsnag event",
    icon: "🎉",
    notify: true,
    logsans: true /* This property is only needed if you want LogSans to be able to notify you when this event does NOT happen. */
});

This will do two things:

  1. It publishes your event to LogSnag
  2. Tracks your event on LogSans so that LogSans can alert you when the event does NOT happen within the last X minutes. (X being the "frequency" set - more on that below)

Tell LogSans When to Check

Now that you are tracking your events, it is time to tell LogSans how often to check for it.

To do that, user the Create Recurring Check endpoint here:

logsnag.check({
    project: "your-logsnag-project",
    channel: "your-logsnag-channel",
    event: "Your logsnag event",
    frequency:20 /* in minutes */
});

More Documentation: https://documenter.getpostman.com/view/10930387/Uz5MFEMj

Once you create a Recurring Check, LogSans alert you if it has not detected your event in the timeframe set by the frequency property.

For Example

If frequency is set to 30 (minutes), LogSans will check every 30 minutes. If it does not detect your event, it will publish a LogSnag event telling you that it has not seen that event in the last 30 minutes.

Readme

Keywords

Package Sidebar

Install

npm i logsans

Weekly Downloads

2

Version

0.0.10

License

MIT

Unpacked Size

17.3 kB

Total Files

31

Last publish

Collaborators

  • twostep