meteor-ping

Ping a Meteor app to confirm it is online

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
meteor-ping
201.0.37 years ago8 years agoMinified + gzip package size for meteor-ping in KB

Readme

meteor-ping
Build Status
Ping a Meteor app. This "DDP ping" only succeeds if a Meteor-specific test (subscribing to a collection) passes.
Timing is done internally to adjust for Node.js startup time.
This code is used heavily and frequently for pinging many Meteor apps in production.

Synopsis

Command-line use

npm install -g meteor-ping
meteor-ping --host www.meteor.com --port 443

Upon failure, a message is printed to standard error and the program exits with an error code.
Upon success, the milliseconds elapsed for the ping is printed to standard output.

API

npm install --save meteor-ping

The only public function is ping(), which takes one argument, a standard Node.js-style callback. The second argument to the callback is an object with one key: elapsedTimeInMs. Example usage:
'use strict';

var MeteorPing = require('meteor-ping');

// all args are optional, here are the defaults
var localApp = new MeteorPing({
  host: 'localhost',
  port: 3000,
  ssl: false,
  timeout: 10 * 1000, // 10 seconds
});

localApp.ping(function(error, result) {
  if (error) {
    console.error(error);
    process.exit(1);
  } else {
    console.log('done. Milliseconds elapsed: ' + result.elapsedTimeInMs);
  }
});

MeteorPing constructor arguments

All arguments are optional.
  1. host - domain name of Meteor server to ping. Must be a valid IP address or hostname.
* Default `localhost`.
  1. port - port of Meteor server to ping. Must be a valid port number.
* Default `3000`.
  1. ssl - whether to use SSL for the connection. Boolean. Automatically true if port is 443 (no idea why).
* Default `false`.
  1. connectTimeout - milliseconds before timing out the DDP connect() call. Must be a number greater than or equal to 1.
* Default `5000`.
  1. subscribeTimeout - milliseconds before timing out the DDP subscribe() call. Must be a number greater than or equal to 1.
* Default `5000`.
  1. collection - collection to use for subscribe() call. Must be a string. Consider using a database-backed collection if you have one--this provides a full round-trip ping.
* Default `meteor.loginServiceConfiguration`.

Description

Meteor apps deliver static content and layout. A websocket or long-polling connection is used to deliver data. An app may return a HTTP 200 OK even if data cannot be retrieved. It is helpful to have a smarter check to ensure the static content and data are available.
The pinged app must use the Accounts system or must override the collection constructor argument.

Compatibility

This package has been tested with Node.js version 4.6.1.

Copyright, License

Copyright (C) 2016 Adam Monsen
MIT license.