Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rjchicago/docker-event-stream
A simple, lightweight, zero-dependency EventEmitter for Docker Events.
https://github.com/rjchicago/docker-event-stream
docker docker-events eventemitter events nodejs swarm
Last synced: about 2 months ago
JSON representation
A simple, lightweight, zero-dependency EventEmitter for Docker Events.
- Host: GitHub
- URL: https://github.com/rjchicago/docker-event-stream
- Owner: rjchicago
- License: mit
- Created: 2022-02-04T14:54:55.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-03-11T17:15:04.000Z (over 2 years ago)
- Last Synced: 2024-06-22T18:44:17.505Z (3 months ago)
- Topics: docker, docker-events, eventemitter, events, nodejs, swarm
- Language: JavaScript
- Homepage:
- Size: 60.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-event-stream
A simple, lightweight, zero-dependency NodeJS [EventEmitter](https://nodejs.org/api/events.html#class-eventemitter) for [Docker Events](https://docs.docker.com/engine/reference/commandline/events/).
## installation
``` sh
npm install @rjchicago/docker-event-stream --save
```
## init
Call `DockerEventStream.init()` to initialize. By default, `DockerEventStream` will emit **all** events for both scopes `local` and `swarm`.
You may pass `options` in the init call to connect a remote host, limit or filter events.
``` js
const options = {
host: $HOST, // hostname or IP
port: $PORT, // i.e. 2375
since: $SINCE, // i.e. '10s'
filter: {
$FILTER1_KEY: $FILTER1_VALUE, // i.e. scope: 'local'
$FILTER2_KEY: $FILTER2_VALUE, // i.e. type: 'container'
$FILTER3_KEY: [ $FILTER3_VALUE1, $FILTER3_VALUE2 ] // i.e. event: [ 'start', 'die' ]
}
}
```
## use
In this demo, we'll use the default configuration and log all events to console.
Demo `index.js`:
``` javascript
const DockerEventStream = require('@rjchicago/docker-event-stream');
DockerEventStream.init();
DockerEventStream.on('event', console.log);
```
To bring up our demo app, run the following...
``` sh
# create demo folder
mkdir docker-event-stream-demo
cd docker-event-stream-demo
# init
npm init -y
npm install -s @rjchicago/docker-event-stream
# create demo index.js
echo "const DockerEventStream = require('@rjchicago/docker-event-stream');
DockerEventStream.init();
DockerEventStream.on('event', console.log);" > index.js
# run demo
node index.js
```
Next, in another shell, test an event:
``` sh
docker run --rm alpine echo "hello"
```
In the application shell, you will see the stream of docker events...
``` js
{
status: 'create',
id: 'd5af2dc4f43d6866bd2a8991a0584268ac5aad94b7014ff5c5dfa2f1259037bd',
from: 'alpine:3.15',
Type: 'container',
Action: 'create',
Actor: {
ID: 'd5af2dc4f43d6866bd2a8991a0584268ac5aad94b7014ff5c5dfa2f1259037bd',
Attributes: { image: 'alpine:3.15', name: 'random_name' }
},
scope: 'local',
time: 1643984948,
timeNano: 1643984948954996500
}
```
## options
### since
See [Docker Events docs](https://docs.docker.com/engine/reference/commandline/events/#limiting-filtering-and-formatting-the-output)
* `since` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m).
* if you do not provide the `since` option, only new and/or live events will be emitted.
### filtering
See [Docker Events docs](https://docs.docker.com/engine/reference/commandline/events/#limiting-filtering-and-formatting-the-output)
> The currently supported filters are:
>
> * config (config=`name or id`)
> * container (container=`name or id`)
> * daemon (daemon=`name or id`)
> * event (event=`event action`)
> * image (image=`repository or tag`)
> * label (label=`key` or label=`key`=`value`)
> * network (network=`name or id`)
> * node (node=`id`)
> * plugin (plugin=`name or id`)
> * scope (scope=`local or swarm`)
> * secret (secret=`name or id`)
> * service (service=`name or id`)
> * type (type=`container or image or volume or network or daemon or plugin or service or node or secret or config`)
> * volume (volume=`name`)
NOTE:
> * using the same filter multiple times will be handled as `OR`.
> * using multiple filters will be handled as `AND`.
#### example
The following will listen on "local" events since "30s" ago from containers "foo" `OR` "bar" only:
``` js
const options = {
since: 30s,
filter: {
scope: 'local',
container: ['foo', 'bar']
}
}
```
## docker-compose
When running Node.js inside of Docker, you need map the docker socket under volumes in your docker-compose.yml:
``` yaml
volumes:
- /var/run/docker.sock:/var/run/docker.sock
```
> See [docker](./examples/docker) under [examples](./examples)
## publish
Increment the package version and commit with the follow message format:
> `Release ${VERSION}`
The GitHub Actions Workflow is automated using [publish-to-npm](https://github.com/marketplace/actions/publish-to-npm)
## contribution
Please do! Open a pull request with your code or idea and let's chat!
## license
> see [LICENSE](./LICENSE)
[](https://github.com/marketplace/actions/super-linter)