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

@ceejbot/pagerduty-trigger

v1.0.1

Published

trigger a pagerduty alert

Downloads

12

Readme

pagerduty-trigger

npm install pagerduty-trigger

A small module that allows you to trigger and resolve a PagerDuty alerts.

Usage

Set two environment variables:

export PAGER_DUTY_SERVICE=your-service-id
export PAGER_DUTY_API_KEY=an-api-key-with-write-perms

You can then trigger an alert like this:

var trigger = require('pagerduty-trigger');
trigger('Trouble at mill!', function(err, incidentID) {
    console.log('incident created with id ' + incidentID);
});

Resolve the same incident like this:

var resolve = require('pagerduty-trigger').resolve;
resolve(incidentID, function(err, response) {
    console.log('we have now resolved ' + incidentID);
});

API

pagerduty-trigger takes a string as the first argument, representing the description.

  triggerAlert("Your description!", function(err, incident_key) {
  //your code here
  });

pagerduty-trigger can also take an object as the first argument.

var event = {
   "description": "Your description",
   "contexts":[
    {
      "type": "link",
      "href": "http://acme.pagerduty.com"
    }],
    "details": {
      "ping time": "1500ms",
      "load avg": 0.75
    }
};
triggerAlert(event, function(err, incident_key) {
  //your code here
});

The resolve() function requires either a string incident_key argument or an object with an incident_key field. See PagerDuty's documentation for other fields you might pass.

command-line tool

You can create an event using the handy command-line tool pd-trigger. Usage:

pd-trigger "One of t'flayrods has gone out of skew on treadle!"

It will respond with the ID of the incident created. You can then feed that ID to the resolve script: pd-resolve incident-id.

License

ISC.