~/projects

cat readme.md

pusher-status

npm version JavaScript Style Guide Github build status License MIT

This library returns the status of Pusher’s components using the data from the status page of Pusher.

Installation

Open a terminal inside your project and type:

npm i --save pusher-status

Usage

const Pusher = require('pusher-status')

Pusher.status((err, res) => {
    if (err) {
        // process error
    }

    console.log(`Status = ${res.status}`)
    console.log(`Numbers of components correctly working = ${res['components']['operational'].length}`)

    if (res.status != 'OK') {
        console.log(`Numbers of components not working = ${res['components']['outage'].lenght}`)
    }
})

Components

Inside Pusher’s Status Page you can find the following components:

NameDescription
Channels REST APIThe API your servers use to publish messages and query channel state, described here: https://pusher.com/docs/rest_api
Channels WebSocket client APIThe API which Pusher Channels end-users connect to, generally for subscribing to events
Channels Dashboarddashboard.pusher.com: Where you can view statistics and manage your apps.
Channels Stats IntegrationsIntegration of Pusher Channels with Datadog and other 3rd party providers
Channels presence channelsNo description provided
Channels WebhooksNo description provided
Channels Pusher.js CDNThe CDN backing js.pusher.com, serving the javascript client library to end users.
BeamsNo description provided
Beams dashboardNo description provided
Marketing WebsiteThe website at www.pusher.com
Payment APIThe API that handle charging, plan upgrade, downgrade and cancellation

Examples

You can also find the .json files of the examples below inside the /examples folder.

All operational

{
	"status": "OK",
	"components": {
		"operational": [{
			"name": "Channels REST API",
			"position": 1,
			"description": "The API your servers use to publish messages and query channel state, described here: https://pusher.com/docs/rest_api"
		}, {
			"name": "Channels WebSocket client API",
			"position": 2,
			"description": "The API which Pusher Channels end-users connect to, generally for subscribing to events"
		}, {
			"name": "Channels Dashboard",
			"position": 3,
			"description": "dashboard.pusher.com: Where you can view statistics and manage your apps."
		}, {
			"name": "Channels Stats Integrations",
			"position": 4,
			"description": "Integration of Pusher Channels with Datadog and other 3rd party providers"
		}, {
			"name": "Channels presence channels",
			"position": 5,
			"description": null
		}, {
			"name": "Channels Webhooks",
			"position": 6,
			"description": null
		}, {
			"name": "Channels Pusher.js CDN",
			"position": 7,
			"description": "The CDN backing js.pusher.com, serving the javascript client library to end users."
		}, {
			"name": "Beams",
			"position": 8,
			"description": null
		}, {
			"name": "Chatkit",
			"position": 9,
			"description": null
		}, {
			"name": "Marketing Website",
			"position": 10,
			"description": "The website at www.pusher.com"
		}, {
			"name": "Payment API",
			"position": 11,
			"description": "The API that handle charging, plan upgrade, downgrade and cancellation"
		}],
		"outage": []
	}
}

Some not working

{
	"status": "ERROR",
	"components": {
		"operational": [{
			"name": "Channels REST API",
			"position": 1,
			"description": "The API your servers use to publish messages and query channel state, described here: https://pusher.com/docs/rest_api"
		}, {
			"name": "Channels WebSocket client API",
			"position": 2,
			"description": "The API which Pusher Channels end-users connect to, generally for subscribing to events"
		}, {
			"name": "Channels Dashboard",
			"position": 3,
			"description": "dashboard.pusher.com: Where you can view statistics and manage your apps."
		}, {
			"name": "Channels Stats Integrations",
			"position": 4,
			"description": "Integration of Pusher Channels with Datadog and other 3rd party providers"
		}, {
			"name": "Channels presence channels",
			"position": 5,
			"description": null
		}, {
			"name": "Channels Webhooks",
			"position": 6,
			"description": null
		}, {
			"name": "Channels Pusher.js CDN",
			"position": 7,
			"description": "The CDN backing js.pusher.com, serving the javascript client library to end users."
		}, {
			"name": "Beams",
			"position": 8,
			"description": null
		}, {
			"name": "Chatkit",
			"position": 9,
			"description": null
		}],
		"outage": [{
			"name": "Marketing Website",
			"position": 10,
			"description": "The website at www.pusher.com"
		}, {
			"name": "Payment API",
			"position": 11,
			"description": "The API that handle charging, plan upgrade, downgrade and cancellation"
		}]
	}
}