Docker monitor helping to maintain list of running containers
npm install node-docker-monitorThis library is developed to perform one simple function: help to maintain list of running Docker containers on a single host.
More details about usage of node-docker-monitor with fully functional example https://memz.co/api-gateway-microservices-docker-node-js/
npm install node-docker-monitor
Quick start
Following simple snippet starts monitoring containers on local host javascript
var monitor = require('node-docker-monitor');monitor({
onContainerUp: function(container) {
console.log('Container up: ', container)
},
onContainerDown: function(container) {
console.log('Container down: ', container)
}
});
`
Container object has following structure
json
{
"Command": "/bin/sh -c '/bin/bash -c 'cd /home; mkdir data; node main/app.js''",
"Created": 1431402173,
"Id": "81cde361ec7b069cc1ee32a4660176306a2b1d3a3eb52f96f17380f10e75d2e2",
"Image": "m4all-next:15-0511-1104",
"Names": ["/m4all-next"],
"Ports": [
{
"IP": "172.17.42.1",
"PrivatePort": 3000,
"PublicPort": 3002,
"Type": "tcp"
}
],
"Status": "Up About an hour",
"Name": "m4all-next"
}
`When monitor starts, it calls
callback for all currently running containers and then starts listening to Docker events, calling onContainerUp() and onContainerDown() when appropriate.API
function(handler, [dockerOptions | dockerodeObject], [options]) - starts monitor with event handler that will receive events. Even handler must have onContainerUp(containerInfo, docker) and onContainerDown(containerInfo, docker) functions receiving parameters containerInfo - container info and docker* - dockerode Docker() object. By default, it communicates to local Docker instance via /var/run/docker.sock Unix socket. You can change default Docker configuration by providing either configuration object or pre-constructed Docker (for more details see).
* Options.strategy - 'monitorAll' (default) | 'monitorSelected' - whether to monitor all containers or only selected.
* Option.selectorLabel - 'node-docker-monitor' (default) - Label to be used on docker container to select or deselect container for monitoring.
Option examples
{} or {strategy: 'monitorAll'} - monitor all containers except those that have label node-docker-monitor with negative value* - '0' | 'null' | 'false' | 'disable' | 'disabled' | ''
- monitor only containers that have label node-docker-monitor with positive value* - any string except '0' | 'null' | 'false' | 'disable' | 'disabled' | ''
- monitor only containers that have label monitor-me with positive value* - any string except '0' | 'null' | 'false' | 'disable' | 'disabled' | ''`
Usage example of node-docker-monitor with fully functional API Gateway for microservices here
Copyright (c) 2015, Andrey Chausenko
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.