particle-status v1.0.0

particle-status

Node module to monitor the status of the components in the Particle Cloud status page.

Installation

npm install particle-status

Usage

Import the module:

const particle = require('particle-status')

Define an array with the names (or the indexes) of the components to be monitored (see Components):

// monitor Cellular Connectivity, REST API, Integrations

// use names of the components
components = [particle.CELLULAR_CONNECTIVITY, particle.REST_API, particle.INTEGRATIONS]

// use indexes of the components
components = [0, 2, 3]

It is also possible to monitor all the components:

components = particle.ALL_COMPONENTS

Check the status of monitored components:

particle.status(components, (err, status) => {
  if (err) {
    return
  }

  // do something with status object
  console.log(`operational: ${status.operational}`)
  console.log(`outages count: ${status.outage.length}`)
})

Components

These are the components available in the Particle status page

Status format

The status object contains two fields:

• operational: determine if every monitored component is operational
• components: contains three arrays (operational, outage and minor) with the components that are operational or affected by major or minor outages

Example with all systems operational

{
	"operational": true,
	"components": {
		"operational": [
			{
				"status": "operational",
				"name": "api.particle.io"
			},
			{
				"status": "operational",
				"name": "Mobile carriers"
			},
			{
				"status": "operational",
				"name": "Webhooks"
			}
		],
		"outage": [],
		"minor": []
	}
}

Example with some monitored system affected by the outage

{
	"operational": false,
	"components": {
		"operational": [
			{
				"status": "operational",
				"name": "Mobile carriers"
			}
		],
		"outage": [
			{
				"status": "outage",
				"name": "api.particle.io"
			},
			{
				"status": "outage",
				"name": "Webhooks"
			}
		],
		"minor": []
	}
}