Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.65 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.65 KB
Raw

Heroku self ping

To avoid the thirty minutes time limit on your dyno, use this npm module:

require('heroku-self-ping').default("http://your-app-url");

or:

import hsp from 'heroku-self-ping';

hsp("http://your-app-url");

This will register a timer self-pinging your app every 20 minutes.

This timer will only activate when your app is running on Heroku platform. The script is a no-op on any other environment, including local and CI.

Parameters

  • your-app-url can be any URL to access your app -- an herokuapp.com subdomain or any custom domain defined with your app.

Heroku doesn't allow an app to retrieve its current name, which is why you need to manually specify the URL.

  • options, optional object with the following keys:
    • interval number of ms between two heartbeats calls. Default to 20 * 60 * 1000 (20 minutes).
    • logger function to use for logging. Default to console.log
    • verbose send more information to logger function. Default to false.

Return

The function returns an interval id when running on Heroku and the URL is not falsy, and false in other cases.

Usage

We recommend you set a custom env variable, for instance heroku config:set APP_URL http://yourapp.herokuapp.com and access it later from process.env.APP_URL.

The lib won't do anything when passed an empty url.

You can also use

`https://${process.env.HEROKU_APP_NAME}.herokuapp.com`

if you first run

heroku labs:enable runtime-dyno-metadata -a <app name>

See here for details: https://devcenter.heroku.com/articles/dyno-metadata