Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

@pm2/agent

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@pm2/agent

PM2.io Agent Daemon


Version published
Weekly downloads
1.4M
decreased by-1.86%
Maintainers
2
Weekly downloads
 
Created

pm2-io-agent

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

Transporters

WebsocketTransporter is using websocket to send and receive data from websocket server.

Launch

Using daemon

To launch using daemon you need to run :

node src/InteractorDaemon.js

Before, you need to set these environment vars

KeyValue
KEYMETRICS_NODEWhere bucket's endpoints will be resolved
PM2_SECRET_KEYBucket's secret key
PM2_PUBLIC_KEYBucket's public key
PM2_MACHINE_NAMEMachine name
PM2_VERSIONPM2 Version

Using client

You can use src/InteractorClient.js and method launchAndInteract with constants as first argument (empty object is authorized), options as second argument which is an object with key secret_key, public_key, machine_name and callback as third argument.

const InteractorClient = require('keymetrics-agent/src/InteractorClient')

InteractorClient.launchAndInteract({}, {
  secret_key: '',
  public_key: '',
  machine_name: ''
}, (err, msg) => {
})

Configuration

To configure this agent you can use config.json.

Default

By default AxonTransporter is enabled and using push and reverse bucket's endpoint. You can override this endpoints with AGENT_PUSH_ENDPOINT and AGENT_REVERSE_ENDPOINT environements' vars

By default WebsocketTransporter is disabled, you can enabled it with AGENT_TRANSPORT_WEBSOCKET environement's var, it's using websocket bucket's endpoint but you can override it with AGENT_WEBSOCKET_ENDPOINT environement's var.

Transporters

Into this configuration you can put transporter name as key and for values, two keys are available enabled and endpoints.

The enabled key is using to disable or enable transporter.

The endpoints key can be a string or an object. It depends on what the connect method of the transporter needs. If you set a string, the connect method will be called with endpoint's value or raw value if no endpoint is matched. For objects, the connect method will be called with this object, and value of the keys will be replaced by endpoint's value or raw value if no endpoint is matched.

FAQs

Package last updated on 13 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts