PM2.io Agent Standalone for NodeJS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example improv: handle promise rejection if server is down at startup Oct 18, 2018
src
tests tests: add test when log are enabled by reverse action (stderr) #8 Dec 7, 2018
.drone.yml
.gitignore improv: proxy connector Nov 5, 2018
README.md version: patch bump to 1.0.8 Nov 19, 2018
constants.js First commit Aug 31, 2018
index.js improv: move ./index to ./src/index Sep 3, 2018
package.json version: patch bump to 1.1.1 Dec 14, 2018
yarn.lock test: fix v8-to-istanbul to 1.2.0 Nov 5, 2018

README.md

pm2-io-agent-node

This module is used by @pm2/io to communicate with PM2.io's servers.

This module is using websocket to send and receive data from websocket server.

NOTE: This module is only compatible with node >= 6

How to use

Just like that:

const Agent = require('@pm2/agent-node')

// This object is used by the agent to send data for each status, you can edit it when you want
const process = {
  axm_options: {}
}

// Init connection and verify credentials
const agent = new Agent({
  publicKey: '', // Your PM2 Plus public key
  secretKey: '', // Your PM2 Plus secret key
  appName: '' // Your application name (used as server name also)
}, process)

// If public or secret key is invalid, an error will be throw
await agent.start()

You can send data like this:

agent.send('process:exception', {data: ...})

Release

To release a new version, first install gren :

yarn global add github-release-notes

Push a commit in github with the new version you want to release :

git commit -am "version: major|minor|patch bump to X.X.X"

Care for the versionning, we use the semver versioning currently. Please be careful about the version when pushing a new package.

Then tag a version with git :

git tag -s vX.X.X

Push the tag into github (this will trigger the publish to npm) :

git push origin vX.X.X

To finish update the changelog of the release on github with gren (be sure that gren has selected the right tags):

gren release -o -D commits -u keymetrics -r pm2-io-agent-node