Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/n4kz/weaver

Interactive process management system for node.js
https://github.com/n4kz/weaver

Last synced: 3 months ago
JSON representation

Interactive process management system for node.js

Host: GitHub
URL: https://github.com/n4kz/weaver
Owner: n4kz
License: lgpl-3.0
Created: 2012-12-19T21:18:54.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2016-09-26T16:50:40.000Z (over 8 years ago)
Last Synced: 2024-10-03T03:04:07.015Z (3 months ago)
Language: CoffeeScript
Size: 152 KB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license.txt

Awesome Lists containing this project

README

# Weaver

Interactive process management system for node.js

# Installation

```bash
# Global
npm -g install weaver

# Local
npm install weaver
```

If you have chosen local installation, check your `PATH` environment variable. `npm` creates symlinks to
all binaries in `node_modules/.bin` hidden folder. So you may want to prepend it to `PATH`.

# Usage

weaver [--port ] [--config ] [--debug]
weaver [--port ] [--config ] upgrade
weaver [--port ] restart [[task|pid], ...]
weaver [--port ] stop [[task|pid], ...]
weaver [--port ] kill [[task|pid], ...]
weaver [--port ] drop
weaver [--port ] [--nocolor] status
weaver [--port ] [--nocolor] dump
weaver [--port ] monitor
weaver [--port ] exit

# Commands

- `upgrade` Extend configuration with tasks from configuration file
- `restart` Restart all tasks, task group, task by pid
- `stop` Stop all tasks, task group, task by pid
- `kill` Send signal to task group or task by pid
- `drop` Stop task group and remove it from configuration
- `status` Show status for all tasks
- `dump` Show current configuration
- `monitor` Stream log messages from daemon
- `exit` Stop all tasks and exit

# Options

--config Configuration file [default: weaver.json]
--debug Do not fork and give additional output
--nocolor Do not use colors for output
--help Show help and exit
--version Show version and exit
--port Use specified port [default: 8092]

Also `WEAVER_PORT` and `WEAVER_DEBUG` environment variables can be used to set options, but
command line options have higher priority.

# Configuration example

```json
{
"path": "..",
"tasks": {
"web": {
"count": 2,
"source": "lib/main.js",
"persistent": false,
"arguments": ["--web", "--port", [8001, 8002]],
"watch": ["lib/**/*.js", "config/default.js", "config/local.json"],
"env": {
"NODE_ENV": "local"
}
},

"worker": {
"count": 1,
"timeout": 2000,
"source": "lib/main.js",
"persistent": false,
"arguments": ["--worker"],
"watch": ["lib/worker/*.js"],
"env": {
"NODE_ENV": "local"
}
},

"redis": {
"count": 1,
"source": "redis-cli",
"executable": true,
"arguments": ["monitor"]
}
}
}
```

With such config file weaver will run three processes and restart them when one of watched files is modified. Fourth process will
send commands from redis in monitor mode to log. Processes are organized in three groups and can be managed by group name.
For example to restart web processes you need to say

weaver restart web

and to stop redis monitor

weaver stop redis

Processes in the web group get different command line arguments but similar environment. By default tasks have access to `PATH`, `NODE_PATH` and `HOME`
environment variables. `NODE_PATH` is set automatically only when `executable` flag is not set.

Bash commands to start processes manually in same way as weaver does in example above

NODE_ENV="local" node ../lib/main.js --web --port 8001
NODE_ENV="local" node ../lib/main.js --web --port 8002
NODE_ENV="local" node ../lib/main.js --worker
redis-cli monitor

# Configuration file structure

- `path` Path to working directory, relative to configuration file or absolute. Optional
- `tasks` Task groups
- `count` Task count for group. Can be zero
- `source` Source file or executable for task group. Relative to `cwd` or absolute
- `persistent` Restart task on unclean exit. Defaults to false. Boolean. Optional
- `executable` Source is executable itself and v8 instance is not needed to run it. Defaults to false. Boolean. Optional
- `arguments` Arguments for tasks in task group. Nested array should have length equal to task count. Optional
- `env` Environment variables for task group. Optional
- `watch` Restart all tasks in task group when one of watched files was modified. Optional
- `timeout` Timeout between SIGINT and SIGTERM for stop and restart commands. Defaults to 1000ms. Optional
- `runtime` Minimal runtime required for persistent task to be restarted after unclean exit. Defaults to 1000ms. Optional
- `cwd` Task group working directory. Relative to `path` or absolute. Optional

Configuration file is validated with JSON Schema from file `lib/schema.json`.

# Logs

Weaver will collect logs for you and send anything from subtasks stdout and stderr to udp4:localhost:8092 (or any other port of your choice).
In debug mode this functionality is disabled and logs are printed to stdout.
To do something with this logs you can use monitor mode

weaver monitor

Or any other program capable to capture udp

socat udp4-listen:8092 stdout

# Copyright and License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.