tilloo-plugin-sns

1.0.0 • Public • Published

A distributed cron with cli and web ui

NPM Version NPM Downloads Build Status

Installation

npm install tilloo-plugin-sns --save

Features

  • Sends email on job failure via AWS SNS
  • Sends email on job recovery via AWS SNS

Background

We recently moved our notifications from Mandrill to SNS. This plugin was created to support notifications via SNS.

Getting Started

This package is NOT included in Tilloo by default. To use it you need to do an npm install tilloo-plugin-sns in the tilloo directory and then configure it.

Configuration

The configuration for the plugin lives inside the Tilloo config.json.

  "notification"{
    "threshold":3600,
    "plugins":{
      "tilloo-plugin-sns": {
        "accessKeyId": "<AWS Access Key Id>",
        "secretAccessKey": "<AWS Secret Access Key>",
        "region": "<AWS region SNS topic is in>",
        "topicArn": "<AWS SNS topicArn>",
        "from_name": "Tilloo Notification",
        "from_email": "<from_email@example.com>",
        "to_email": "<to_email@example.com>"
      }
    }
  }

If you are using IAM roles you can leave out accessKeyId and secretAccessKey and the AWS-SDK should use your IAM role. You can also specify them via environment variables if desired.

Region and topicArn are always required.

People

The author is Chris Kinsman

License

MIT

Dependencies (2)

Dev Dependencies (6)

Package Sidebar

Install

npm i tilloo-plugin-sns

Weekly Downloads

1

Version

1.0.0

License

MIT

Last publish

Collaborators

  • chriskinsman