node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org ยป

mqtt-stats

mqtt-stats

MQTT Stats for Node.js

The goal of this lib is to simplify the creation of custom and lightweight stats/analytics for Node.js web apps.

One usage example of this lib is an internet connected Board with one Led for every node.js app, if the node application goes offline the relative led in the Board will go off.

Methods

init(name, host, mqttObject)

Params:

name: 
  
  Name of the Project

host: 
  
  Host of MQTT broker (See MQTT.js)

mqttObject: 
  
  Object of MQTT Client configuration. (See MQTT.js)

Description:

This method initialize the lib and subscribe the mqtt client to the topic "[PROJECT_NAME]/presence",
In case of publish on "[PROJECT_NAME]/presence" the client will publish on "[PROJECT_NAME]"
express(req, res)

Use:

var stats = require("mqtt-stats");

var app = express();

app.use(stats.express);

Description:

This method will publish to "[PROJECT_NAME]/calls" every Express response
episode(eventName, data)

Params:

eventName: 
  
  The name of the Event

data: 

  The payload of the publish

Description:

This method will publish to "[PROJECT_NAME]/episode/[EVENT_NAME]" on specific episodes (ex. A new login, new post, new user, ecc)