{"id":24081489,"url":"https://github.com/beh01der/node-docker-monitor","last_synced_at":"2025-04-30T16:27:17.831Z","repository":{"id":32006027,"uuid":"35576998","full_name":"Beh01der/node-docker-monitor","owner":"Beh01der","description":null,"archived":false,"fork":false,"pushed_at":"2023-02-17T10:16:50.000Z","size":26,"stargazers_count":20,"open_issues_count":2,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T00:36:03.301Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Beh01der.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-05-13T22:19:55.000Z","updated_at":"2023-02-17T10:16:55.000Z","dependencies_parsed_at":"2024-06-18T20:14:35.066Z","dependency_job_id":null,"html_url":"https://github.com/Beh01der/node-docker-monitor","commit_stats":{"total_commits":30,"total_committers":5,"mean_commits":6.0,"dds":0.4666666666666667,"last_synced_commit":"bb930551975f33243567fa8d6418f72665fc1654"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beh01der%2Fnode-docker-monitor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beh01der%2Fnode-docker-monitor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beh01der%2Fnode-docker-monitor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beh01der%2Fnode-docker-monitor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Beh01der","download_url":"https://codeload.github.com/Beh01der/node-docker-monitor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251741464,"owners_count":21636259,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-09T23:16:59.534Z","updated_at":"2025-04-30T16:27:17.561Z","avatar_url":"https://github.com/Beh01der.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-docker-monitor\n\nThis library is developed to perform one simple function: help to maintain list of running Docker containers on a single host.\n\n## Install\nInstall locally\n```\nnpm install node-docker-monitor\n```\n\n## Quick start\nFollowing simple snippet starts monitoring containers on local host \n\n```javascript\nvar monitor = require('node-docker-monitor');\n\nmonitor({\n    onContainerUp: function(container) {\n        console.log('Container up: ', container)\n    },\n\n    onContainerDown: function(container) {\n        console.log('Container down: ', container)\n    }\n});\n```\nContainer object has following structure\n```json\n{\n   \"Command\": \"/bin/sh -c '/bin/bash -c 'cd /home; mkdir data; node main/app.js''\",\n   \"Created\": 1431402173,\n   \"Id\": \"81cde361ec7b069cc1ee32a4660176306a2b1d3a3eb52f96f17380f10e75d2e2\",\n   \"Image\": \"m4all-next:15-0511-1104\",\n   \"Names\": [\"/m4all-next\"],\n   \"Ports\": [\n     {\n       \"IP\": \"172.17.42.1\",\n       \"PrivatePort\": 3000,\n       \"PublicPort\": 3002,\n       \"Type\": \"tcp\"\n     }\n   ],\n   \"Status\": \"Up About an hour\",\n   \"Name\": \"m4all-next\"\n }\n```\n\nWhen monitor starts, it calls `onContainerUp()` callback for all currently running containers and then starts listening to Docker events, calling `onContainerUp()` and `onContainerDown()` when appropriate.\n\n## API\n* **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](https://github.com/apocas/dockerode). 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](https://github.com/apocas/dockerode)). \n    * `Options.strategy` - 'monitorAll' (default) | 'monitorSelected' - whether to monitor all containers or only selected. \n    * `Option.selectorLabel` - 'node-docker-monitor' (default) - Label to be used on docker container to select or deselect container for monitoring.\n         \n## Option examples\n* `{}` or `{strategy: 'monitorAll'}` - monitor all containers except those that have label `node-docker-monitor` with *negative value* - `'0' | 'null' | 'false' | 'disable' | 'disabled' | ''`\n* `{strategy: 'monitorSelected'}` - monitor only containers that have label `node-docker-monitor` with *positive value* - any string except `'0' | 'null' | 'false' | 'disable' | 'disabled' | ''`\n* `{strategy: 'monitorSelected', selectorLabel: 'monitor-me'}` - monitor only containers that have label `monitor-me` with *positive value* - any string except `'0' | 'null' | 'false' | 'disable' | 'disabled' | ''`\n\n## License \n**ISC License (ISC)**\n\nCopyright (c) 2015, Andrey Chausenko \u003candrey.chausenko@gmail.com\u003e\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\nWITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\nANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\nWHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\nACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\nOR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeh01der%2Fnode-docker-monitor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeh01der%2Fnode-docker-monitor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeh01der%2Fnode-docker-monitor/lists"}