├── static └── .gitkeep ├── tests ├── __init__.py ├── log │ └── .gitkeep ├── multivisor_test.conf ├── functions.py ├── conftest.py └── supervisord_test001.conf ├── multivisor ├── __init__.py ├── tests │ ├── __init__.py │ └── test_multivisor.py ├── client │ ├── __init__.py │ ├── cli.py │ ├── util.py │ ├── http.py │ └── repl.py ├── server │ ├── __init__.py │ ├── tests │ │ ├── __init__.py │ │ ├── conftest.py │ │ └── test_web.py │ ├── util.py │ ├── rpc.py │ └── web.py ├── signals.py ├── util.py ├── rpc.py └── multivisor.py ├── examples └── full_example │ ├── CT2 │ ├── Lima │ ├── vacuum │ ├── wago │ ├── multivisor.conf │ ├── demo │ ├── talkative │ ├── exits │ ├── supervisord_lid002.conf │ ├── supervisord_baslid001.conf │ └── supervisord_lid001.conf ├── .eslintignore ├── requirements.txt ├── doc ├── diagram.png ├── multivisor_desktop.png └── multivisor_mobile.png ├── config ├── prod.env.js ├── dev.env.js └── index.js ├── setup.cfg ├── requirements-dev.txt ├── docker ├── multivisor │ └── multivisor.conf ├── bin │ ├── CT2 │ ├── Lima │ ├── demo │ ├── vacuum │ ├── wago │ ├── talkative │ └── exits ├── Dockerfile └── supervisord │ ├── lid002.conf │ ├── baslid001.conf │ └── lid001.conf ├── .editorconfig ├── .gitignore ├── .babelrc ├── .postcssrc.js ├── src ├── components │ ├── AlertBar.vue │ ├── group │ │ ├── Chip.vue │ │ ├── List.vue │ │ ├── Page.vue │ │ └── Card.vue │ ├── process │ │ ├── State.vue │ │ ├── Chip.vue │ │ ├── Details.vue │ │ ├── Page.vue │ │ ├── Tile.vue │ │ ├── Row.vue │ │ └── Log.vue │ ├── supervisor │ │ ├── List.vue │ │ ├── Chip.vue │ │ ├── Page.vue │ │ └── Card.vue │ ├── Footer.vue │ ├── NotificationBar.vue │ ├── ActionBar.vue │ ├── ToolBar.vue │ └── login │ │ └── Page.vue ├── main.js ├── .gitrepo ├── App.vue ├── router │ └── index.js ├── multivisor.js └── store │ └── index.js ├── .travis.yml ├── index.html ├── TODO.md ├── .eslintrc.js ├── docker-compose.yml ├── package.json ├── setup.py ├── README.md └── LICENSE /static/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/log/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /multivisor/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /multivisor/tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /examples/full_example/CT2: -------------------------------------------------------------------------------- 1 | demo -------------------------------------------------------------------------------- /examples/full_example/Lima: -------------------------------------------------------------------------------- 1 | demo -------------------------------------------------------------------------------- /examples/full_example/vacuum: -------------------------------------------------------------------------------- 1 | demo -------------------------------------------------------------------------------- /examples/full_example/wago: -------------------------------------------------------------------------------- 1 | demo -------------------------------------------------------------------------------- /multivisor/client/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /multivisor/server/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /multivisor/server/tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /multivisor/server/tests/conftest.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | /config/ 3 | /dist/ 4 | /*.js 5 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | flask 2 | gevent 3 | supervisor 4 | six==1.12.0 5 | -------------------------------------------------------------------------------- /doc/diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tiagocoutinho/multivisor/HEAD/doc/diagram.png -------------------------------------------------------------------------------- /tests/multivisor_test.conf: -------------------------------------------------------------------------------- 1 | [supervisor:test001] 2 | url=localhost:9073 3 | 4 | [global] 5 | -------------------------------------------------------------------------------- /config/prod.env.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | module.exports = { 3 | NODE_ENV: '"production"' 4 | } 5 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [build] 2 | build_base=build_py 3 | 4 | [metadata] 5 | description-file = README.md 6 | -------------------------------------------------------------------------------- /doc/multivisor_desktop.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tiagocoutinho/multivisor/HEAD/doc/multivisor_desktop.png -------------------------------------------------------------------------------- /doc/multivisor_mobile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tiagocoutinho/multivisor/HEAD/doc/multivisor_mobile.png -------------------------------------------------------------------------------- /requirements-dev.txt: -------------------------------------------------------------------------------- 1 | -r requirements.txt 2 | pytest==4.4.1 3 | requests==2.21.0 4 | isort==4.3.20 5 | flake8==3.7.7 6 | -------------------------------------------------------------------------------- /multivisor/signals.py: -------------------------------------------------------------------------------- 1 | SIGNALS = [ 2 | "process_changed", 3 | "supervisor_changed", 4 | "notification", 5 | ] 6 | -------------------------------------------------------------------------------- /tests/functions.py: -------------------------------------------------------------------------------- 1 | def assert_fields_in_object(fields, obj): 2 | for field in fields: 3 | assert field in obj 4 | -------------------------------------------------------------------------------- /docker/multivisor/multivisor.conf: -------------------------------------------------------------------------------- 1 | [supervisor:lid001] 2 | 3 | [supervisor:lid002] 4 | 5 | [supervisor:baslid001] 6 | 7 | [global] 8 | name=PE Lab 9 | -------------------------------------------------------------------------------- /config/dev.env.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const merge = require('webpack-merge') 3 | const prodEnv = require('./prod.env') 4 | 5 | module.exports = merge(prodEnv, { 6 | NODE_ENV: '"development"' 7 | }) 8 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | indent_style = space 6 | indent_size = 2 7 | end_of_line = lf 8 | insert_final_newline = true 9 | trim_trailing_whitespace = true 10 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules/ 3 | multivisor/dist/ 4 | build_py/ 5 | dist/ 6 | npm-debug.log* 7 | *.egg-info 8 | .pytest_cache/ 9 | 10 | *.pyc 11 | *.log* 12 | *.pid 13 | .idea/ 14 | .env -------------------------------------------------------------------------------- /examples/full_example/multivisor.conf: -------------------------------------------------------------------------------- 1 | [supervisor:lid001] 2 | url=localhost:9012 3 | 4 | [supervisor:lid002] 5 | url=localhost:9022 6 | 7 | [supervisor:baslid001] 8 | url=localhost:9032 9 | 10 | [global] 11 | name=PE Lab 12 | -------------------------------------------------------------------------------- /docker/bin/CT2: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | import time 5 | 6 | name = ' '.join([sys.argv[0].rsplit('/', 1)[1]] + sys.argv[1:]) 7 | 8 | i = 0 9 | while True: 10 | print('%s %d' % (name, i)) 11 | i += 1 12 | time.sleep(0.25) 13 | 14 | -------------------------------------------------------------------------------- /docker/bin/Lima: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | import time 5 | 6 | name = ' '.join([sys.argv[0].rsplit('/', 1)[1]] + sys.argv[1:]) 7 | 8 | i = 0 9 | while True: 10 | print('%s %d' % (name, i)) 11 | i += 1 12 | time.sleep(0.25) 13 | 14 | -------------------------------------------------------------------------------- /docker/bin/demo: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | import time 5 | 6 | name = ' '.join([sys.argv[0].rsplit('/', 1)[1]] + sys.argv[1:]) 7 | 8 | i = 0 9 | while True: 10 | print('%s %d' % (name, i)) 11 | i += 1 12 | time.sleep(0.25) 13 | 14 | -------------------------------------------------------------------------------- /docker/bin/vacuum: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | import time 5 | 6 | name = ' '.join([sys.argv[0].rsplit('/', 1)[1]] + sys.argv[1:]) 7 | 8 | i = 0 9 | while True: 10 | print('%s %d' % (name, i)) 11 | i += 1 12 | time.sleep(0.25) 13 | 14 | -------------------------------------------------------------------------------- /docker/bin/wago: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | import time 5 | 6 | name = ' '.join([sys.argv[0].rsplit('/', 1)[1]] + sys.argv[1:]) 7 | 8 | i = 0 9 | while True: 10 | print('%s %d' % (name, i)) 11 | i += 1 12 | time.sleep(0.25) 13 | 14 | -------------------------------------------------------------------------------- /docker/bin/talkative: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import time 4 | 5 | i = 0 6 | 7 | while True: 8 | print("%d - The kick brown fox... you know the drill. I am just trying to fill in some bytes for the test. Well bye!" % i) 9 | time.sleep(0.1) 10 | i += 1 11 | -------------------------------------------------------------------------------- /examples/full_example/demo: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | import time 5 | 6 | name = ' '.join([sys.argv[0].rsplit('/', 1)[1]] + sys.argv[1:]) 7 | 8 | i = 0 9 | while True: 10 | print('%s %d' % (name, i)) 11 | i += 1 12 | time.sleep(0.25) 13 | 14 | -------------------------------------------------------------------------------- /examples/full_example/talkative: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import time 4 | 5 | i = 0 6 | 7 | while True: 8 | print("%d - The kick brown fox... you know the drill. I am just trying to fill in some bytes for the test. Well bye!" % i) 9 | time.sleep(0.1) 10 | i += 1 11 | -------------------------------------------------------------------------------- /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | ["env", { 4 | "modules": false, 5 | "targets": { 6 | "browsers": ["> 1%", "last 2 versions", "not ie <= 8"] 7 | } 8 | }], 9 | "stage-2" 10 | ], 11 | "plugins": ["transform-vue-jsx", "transform-runtime"] 12 | } 13 | -------------------------------------------------------------------------------- /.postcssrc.js: -------------------------------------------------------------------------------- 1 | // https://github.com/michael-ciniawsky/postcss-load-config 2 | 3 | module.exports = { 4 | "plugins": { 5 | "postcss-import": {}, 6 | "postcss-url": {}, 7 | // to edit target browsers: use "browserslist" field in package.json 8 | "autoprefixer": {} 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /src/components/AlertBar.vue: -------------------------------------------------------------------------------- 1 | 4 | 5 | 15 | -------------------------------------------------------------------------------- /docker/bin/exits: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | import time 5 | 6 | name = ' '.join([sys.argv[0].rsplit('/', 1)[1]] + sys.argv[1:]) 7 | 8 | die_in = int(sys.argv[1]) if len(sys.argv) > 1 else 10 9 | 10 | i = 0 11 | start = time.time() 12 | while True: 13 | if die_in < time.time() - start: 14 | exit(123) 15 | print('%s %d' % (name, i)) 16 | i += 1 17 | time.sleep(0.1) 18 | 19 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | cache: pip 3 | 4 | python: 5 | - "2.7" 6 | #- "3.3" 7 | #- "3.4" 8 | #- "3.5" 9 | #- "3.6" 10 | #- "3.7" 11 | 12 | install: 13 | - pip install . 14 | - pip install -r requirements-dev.txt 15 | 16 | script: 17 | # TODO: uncomment isort and flake8 when it will start passing 18 | # - isort --check-only 19 | # - flake8 --max-line-length=120 20 | - pytest 21 | -------------------------------------------------------------------------------- /examples/full_example/exits: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | import time 5 | 6 | name = ' '.join([sys.argv[0].rsplit('/', 1)[1]] + sys.argv[1:]) 7 | 8 | die_in = int(sys.argv[1]) if len(sys.argv) > 1 else 10 9 | 10 | i = 0 11 | start = time.time() 12 | while True: 13 | if die_in < time.time() - start: 14 | exit(123) 15 | print('%s %d' % (name, i)) 16 | i += 1 17 | time.sleep(0.1) 18 | 19 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | multivisor 7 | 8 | 9 | 10 |
11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /src/components/group/Chip.vue: -------------------------------------------------------------------------------- 1 | 10 | 11 | 19 | -------------------------------------------------------------------------------- /src/components/group/List.vue: -------------------------------------------------------------------------------- 1 | 10 | 11 | 22 | -------------------------------------------------------------------------------- /src/main.js: -------------------------------------------------------------------------------- 1 | import Vue from 'vue' 2 | import Vuetify from 'vuetify' 3 | import 'vuetify/dist/vuetify.min.css' 4 | 5 | import App from '@/App' 6 | import store from '@/store' 7 | import router from '@/router' 8 | 9 | Vue.use(Vuetify) 10 | 11 | Vue.config.productionTip = false 12 | 13 | /* eslint-disable no-new */ 14 | new Vue({ 15 | el: '#app', 16 | store, 17 | router, 18 | render: h => h(App), 19 | created () { 20 | this.$store.dispatch('init') 21 | } 22 | }) 23 | -------------------------------------------------------------------------------- /TODO.md: -------------------------------------------------------------------------------- 1 | # TODO list 2 | 3 | * login 4 | * [done] supervisor actions: update, restart 5 | * supervisor log 6 | * stop group? 7 | * register group icons, process, host, supervisor? 8 | * group view: should split processes by host sub-section? 9 | * [done] check behavior of numprocs > 1 10 | * [done] real event dispatcher from supervisor 11 | * [done] Different views? per group, per supervisor 12 | * [done] backend: prevent client from subscribing more than once to 13 | a log stream 14 | -------------------------------------------------------------------------------- /src/.gitrepo: -------------------------------------------------------------------------------- 1 | ; DO NOT EDIT (unless you know what you are doing) 2 | ; 3 | ; This subdirectory is a git "subrepo", and this file is maintained by the 4 | ; git-subrepo command. See https://github.com/git-commands/git-subrepo#readme 5 | ; 6 | [subrepo] 7 | remote = https://github.com/vuetifyjs/templates-common.git 8 | branch = subrepo/webpack-src 9 | commit = 090741fa8ba4da0c6f85db64eff64550704123e1 10 | parent = e05204fc0583a8c99f1963ce873eba1266838215 11 | method = merge 12 | cmdver = 0.4.0 13 | -------------------------------------------------------------------------------- /src/components/process/State.vue: -------------------------------------------------------------------------------- 1 | 7 | 8 | 20 | -------------------------------------------------------------------------------- /docker/Dockerfile: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | FROM python:3.11-alpine as build 3 | 4 | WORKDIR /usr/app 5 | RUN python -m venv /usr/app/venv 6 | ENV PATH="/usr/app/venv/bin:$PATH" 7 | 8 | COPY . multivisor/ 9 | WORKDIR /usr/app/multivisor 10 | 11 | RUN --mount=type=cache,target=/root/.cache/pip pip install --disable-pip-version-check supervisor .[rpc,web] 12 | 13 | FROM python:3.11-alpine 14 | 15 | RUN mkdir /var/log/supervisord 16 | 17 | COPY --from=build /usr/app/venv /usr/app/venv 18 | 19 | ENV PATH=/usr/app/venv/bin:$PATH 20 | 21 | COPY docker/multivisor/multivisor.conf /etc/ 22 | COPY docker/supervisord/ /etc/supervisord 23 | COPY docker/bin/* /usr/local/bin/ 24 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | // https://eslint.org/docs/user-guide/configuring 2 | 3 | module.exports = { 4 | root: true, 5 | parser: 'babel-eslint', 6 | parserOptions: { 7 | sourceType: 'module' 8 | }, 9 | env: { 10 | browser: true, 11 | }, 12 | // https://github.com/standard/standard/blob/master/docs/RULES-en.md 13 | extends: 'standard', 14 | // required to lint *.vue files 15 | plugins: [ 16 | 'html' 17 | ], 18 | // add your custom rules here 19 | rules: { 20 | // allow async-await 21 | 'generator-star-spacing': 'off', 22 | // allow debugger during development 23 | 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off' 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/components/process/Chip.vue: -------------------------------------------------------------------------------- 1 | 15 | 16 | 26 | -------------------------------------------------------------------------------- /src/components/supervisor/List.vue: -------------------------------------------------------------------------------- 1 | 15 | 16 | 27 | -------------------------------------------------------------------------------- /src/components/supervisor/Chip.vue: -------------------------------------------------------------------------------- 1 | 17 | 18 | 28 | -------------------------------------------------------------------------------- /multivisor/client/cli.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | 3 | import gevent.monkey 4 | 5 | gevent.monkey.patch_all(thread=False) 6 | 7 | from .. import util 8 | from . import repl, http 9 | 10 | 11 | def parse_args(args=None): 12 | parser = argparse.ArgumentParser() 13 | parser.add_argument( 14 | "--url", help="[http://][:<22000>]", default="localhost:22000" 15 | ) 16 | return parser.parse_args(args) 17 | 18 | 19 | def main(args=None): 20 | options = parse_args(args) 21 | url = util.sanitize_url(options.url, protocol="http", port=22000)["url"] 22 | multivisor = http.Multivisor(url) 23 | cli = repl.Repl(multivisor) 24 | gevent.spawn(multivisor.run) 25 | cli.run() 26 | 27 | 28 | if __name__ == "__main__": 29 | main() 30 | -------------------------------------------------------------------------------- /src/components/Footer.vue: -------------------------------------------------------------------------------- 1 | 15 | 16 | 27 | -------------------------------------------------------------------------------- /src/components/NotificationBar.vue: -------------------------------------------------------------------------------- 1 | 7 | 8 | 30 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | # multivisor demonstration 2 | # $ docker-compose build --parallel 3 | # $ docker-compose up 4 | # Point your web browser to http://localhost:22000 5 | 6 | version: '3' 7 | services: 8 | lid001: 9 | build: 10 | context: . 11 | dockerfile: docker/Dockerfile 12 | command: ["supervisord", "-c", "/etc/supervisord/lid001.conf"] 13 | ports: 14 | - 9011:9001 15 | - 22000:22000 16 | lid002: 17 | build: 18 | context: . 19 | dockerfile: docker/Dockerfile 20 | command: ["supervisord", "-c", "/etc/supervisord/lid002.conf"] 21 | ports: 22 | - 9021:9001 23 | baslid001: 24 | build: 25 | context: . 26 | dockerfile: docker/Dockerfile 27 | command: ["supervisord", "-c", "/etc/supervisord/baslid001.conf"] 28 | ports: 29 | - 9031:9001 30 | -------------------------------------------------------------------------------- /src/App.vue: -------------------------------------------------------------------------------- 1 | 15 | 16 | 34 | -------------------------------------------------------------------------------- /src/components/group/Page.vue: -------------------------------------------------------------------------------- 1 | 17 | 18 | 32 | -------------------------------------------------------------------------------- /src/components/supervisor/Page.vue: -------------------------------------------------------------------------------- 1 | 17 | 18 | 47 | -------------------------------------------------------------------------------- /src/components/ActionBar.vue: -------------------------------------------------------------------------------- 1 | 38 | 39 | 53 | -------------------------------------------------------------------------------- /docker/supervisord/lid002.conf: -------------------------------------------------------------------------------- 1 | [inet_http_server] 2 | port=:9001 3 | 4 | [supervisord] 5 | identifier=lid001 6 | nodaemon = true 7 | pidfile = /var/run/supervisord.pid 8 | logfile = /var/log/supervisord/supervisord.log 9 | childlogdir = /var/log/supervisord 10 | logfile_backups=10 11 | logfile_maxbytes=1MB 12 | 13 | [supervisorctl] 14 | serverurl=http://localhost:9001 15 | 16 | [rpcinterface:supervisor] 17 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 18 | 19 | [eventlistener:multivisor-rpc] 20 | command=multivisor-rpc 21 | events=PROCESS_STATE,SUPERVISOR_STATE_CHANGE 22 | 23 | [group:Vacuum] 24 | programs:vacuum_EH 25 | 26 | [group:PLC] 27 | programs:wcid00e,wcid00f,wcid00g 28 | 29 | [group:Counter] 30 | programs:P201 31 | 32 | [program:vacuum_EH] 33 | command=vacuum EH 34 | autorestart=unexpected 35 | redirect_stderr=true 36 | stdout_logfile=%(program_name)s.log 37 | stdout_logfile_maxbytes=1MB 38 | stdout_logfile_backups=10 39 | 40 | [program:wcid00e] 41 | command=wago %(program_name)s 42 | autorestart=unexpected 43 | redirect_stderr=true 44 | stdout_logfile=%(program_name)s.log 45 | stdout_logfile_maxbytes=1MB 46 | stdout_logfile_backups=10 47 | 48 | [program:wcid00f] 49 | command=wago %(program_name)s 50 | autorestart=unexpected 51 | redirect_stderr=true 52 | stdout_logfile=%(program_name)s.log 53 | stdout_logfile_maxbytes=1MB 54 | stdout_logfile_backups=10 55 | 56 | [program:wcid00g] 57 | command=wago %(program_name)s 58 | autorestart=unexpected 59 | redirect_stderr=true 60 | stdout_logfile=%(program_name)s.log 61 | stdout_logfile_maxbytes=1MB 62 | stdout_logfile_backups=10 63 | 64 | [program:P201] 65 | command=CT2 EH 66 | autorestart=unexpected 67 | redirect_stderr=true 68 | stdout_logfile=%(program_name)s.log 69 | stdout_logfile_maxbytes=1MB 70 | stdout_logfile_backups=10 71 | -------------------------------------------------------------------------------- /examples/full_example/supervisord_lid002.conf: -------------------------------------------------------------------------------- 1 | [inet_http_server] 2 | port=:9021 3 | 4 | [supervisord] 5 | logfile_backups=10 6 | logfile_maxbytes=1MB 7 | logfile=%(here)s/log/supervisor_lid002.log 8 | pidfile=%(here)s/supervisor_lid002.pid 9 | childlogdir=%(here)s/log 10 | identifier=lid002 11 | 12 | [supervisorctl] 13 | serverurl=http://localhost:9021 14 | 15 | [rpcinterface:supervisor] 16 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 17 | 18 | [rpcinterface:multivisor] 19 | supervisor.rpcinterface_factory = multivisor.rpc:make_rpc_interface 20 | bind=*:9022 21 | 22 | [group:Vacuum] 23 | programs:vacuum_EH 24 | 25 | [group:PLC] 26 | programs:wcid00e,wcid00f,wcid00g 27 | 28 | [group:Counter] 29 | programs:P201 30 | 31 | [program:vacuum_EH] 32 | command=%(here)s/vacuum EH 33 | autorestart=unexpected 34 | redirect_stderr=true 35 | stdout_logfile=%(here)s/log/vacuum_EH.log 36 | stdout_logfile_maxbytes=1MB 37 | stdout_logfile_backups=10 38 | 39 | [program:wcid00e] 40 | command=%(here)s/wago %(program_name)s 41 | autorestart=unexpected 42 | redirect_stderr=true 43 | stdout_logfile=%(here)s/log/%(program_name)s.log 44 | stdout_logfile_maxbytes=1MB 45 | stdout_logfile_backups=10 46 | 47 | [program:wcid00f] 48 | command=%(here)s/wago %(program_name)s 49 | autorestart=unexpected 50 | redirect_stderr=true 51 | stdout_logfile=%(here)s/log/%(program_name)s.log 52 | stdout_logfile_maxbytes=1MB 53 | stdout_logfile_backups=10 54 | 55 | [program:wcid00g] 56 | command=%(here)s/wago %(program_name)s 57 | autorestart=unexpected 58 | redirect_stderr=true 59 | stdout_logfile=%(here)s/log/%(program_name)s.log 60 | stdout_logfile_maxbytes=1MB 61 | stdout_logfile_backups=10 62 | 63 | [program:P201] 64 | command=%(here)s/CT2 EH 65 | autorestart=unexpected 66 | redirect_stderr=true 67 | stdout_logfile=%(here)s/log/%(program_name)s.log 68 | stdout_logfile_maxbytes=1MB 69 | stdout_logfile_backups=10 70 | -------------------------------------------------------------------------------- /src/router/index.js: -------------------------------------------------------------------------------- 1 | import Vue from 'vue' 2 | import Router from 'vue-router' 3 | import GroupPage from '@/components/group/Page' 4 | import ProcessPage from '@/components/process/Page' 5 | import SupervisorPage from '@/components/supervisor/Page' 6 | import LoginPage from '@/components/login/Page' 7 | import store from '../store' 8 | 9 | Vue.use(Router) 10 | 11 | const loginRequired = {meta: {requiresAuth: true}} 12 | const router = new Router({ 13 | routes: [ 14 | {path: '/', name: 'Home', component: GroupPage, ...loginRequired}, 15 | {path: '/login', name: 'Login', component: LoginPage}, 16 | {path: '/view/group', name: 'GroupPage', component: GroupPage, ...loginRequired}, 17 | {path: '/view/supervisor', name: 'SupervisorPage', component: SupervisorPage, ...loginRequired}, 18 | {path: '/view/process', name: 'ProcessPage', component: ProcessPage, ...loginRequired} 19 | ], 20 | mode: 'history' 21 | }) 22 | 23 | router.beforeEach(async function (to, from, next) { 24 | if (store.state.useAuthentication === undefined || store.state.isAuthenticated === undefined) { 25 | const response = await fetch('/api/auth') 26 | if (response.status === 504) { 27 | return next() 28 | } 29 | const data = await response.json() 30 | store.commit('setUseAuthentication', data.use_authentication) 31 | store.commit('setIsAuthenticated', data.is_authenticated) 32 | } 33 | if (!store.state.useAuthentication) { 34 | if (to.name === 'Login') { return next({name: 'Home'}) } 35 | return next() 36 | } 37 | const loginRequiredRoute = to.matched.some(route => route.meta.requiresAuth) 38 | // if user is not authenticated and route requires login -> redirect to login page 39 | if (!store.state.isAuthenticated && loginRequiredRoute) { 40 | return next({name: 'Login'}) 41 | } 42 | // if user is authenticated and navigates to login page -> redirect to home page 43 | if (to.name === 'Login' && store.state.isAuthenticated) { 44 | return next({name: 'Home'}) 45 | } 46 | return next() 47 | }) 48 | 49 | export default router 50 | -------------------------------------------------------------------------------- /docker/supervisord/baslid001.conf: -------------------------------------------------------------------------------- 1 | [inet_http_server] 2 | port=:9001 3 | 4 | [supervisord] 5 | identifier=baslid001 6 | nodaemon = true 7 | pidfile = /var/run/supervisord.pid 8 | logfile = /var/log/supervisord/supervisord.log 9 | childlogdir = /var/log/supervisord 10 | logfile_backups=10 11 | logfile_maxbytes=1MB 12 | 13 | [supervisorctl] 14 | serverurl=http://localhost:9001 15 | 16 | [rpcinterface:supervisor] 17 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 18 | 19 | [eventlistener:multivisor-rpc] 20 | command=multivisor-rpc 21 | events=PROCESS_STATE,SUPERVISOR_STATE_CHANGE 22 | 23 | [group:BeamViewer] 24 | programs=basler_mbv1,basler_mbv2,basler_mbv3,basler_wbv1,basler_wbv2 25 | 26 | [program:basler_wbv1] 27 | command=Lima %(program_name)s 28 | autorestart=unexpected 29 | redirect_stderr=true 30 | stdout_logfile=%(program_name)s.log 31 | stdout_logfile_maxbytes=1MB 32 | stdout_logfile_backups=10 33 | 34 | [program:basler_wbv2] 35 | command=Lima %(program_name)s 36 | autorestart=unexpected 37 | redirect_stderr=true 38 | stdout_logfile=%(program_name)s.log 39 | stdout_logfile_maxbytes=1MB 40 | stdout_logfile_backups=10 41 | 42 | [program:basler_mbv1] 43 | command=Lima %(program_name)s 44 | autorestart=unexpected 45 | redirect_stderr=true 46 | stdout_logfile=%(program_name)s.log 47 | stdout_logfile_maxbytes=1MB 48 | stdout_logfile_backups=10 49 | 50 | [program:basler_mbv2] 51 | command=Lima %(program_name)s 52 | autorestart=unexpected 53 | redirect_stderr=true 54 | stdout_logfile=%(program_name)s.log 55 | stdout_logfile_maxbytes=1MB 56 | stdout_logfile_backups=10 57 | 58 | [program:basler_mbv3] 59 | process_name=basler_mbv3-%(process_num)s 60 | numprocs=3 61 | command=Lima %(program_name)s 62 | autorestart=unexpected 63 | redirect_stderr=true 64 | stdout_logfile=%(program_name)s.log 65 | stdout_logfile_maxbytes=1MB 66 | stdout_logfile_backups=10 67 | 68 | [program:talks_too_much] 69 | command=talkative 70 | autorestart=unexpected 71 | redirect_stderr=true 72 | stdout_logfile=%(program_name)s.log 73 | stdout_logfile_maxbytes=1MB 74 | stdout_logfile_backups=10 75 | -------------------------------------------------------------------------------- /multivisor/client/util.py: -------------------------------------------------------------------------------- 1 | import collections 2 | 3 | 4 | def group_processes_status_by(processes, group_by="group", process_filter=None): 5 | result = collections.defaultdict(lambda: dict(processes={})) 6 | if process_filter is None: 7 | process_filter = lambda p: True 8 | for uid, process in processes.items(): 9 | if not process_filter(process): 10 | continue 11 | name = process[group_by] 12 | order = result[name] 13 | order["name"] = name 14 | order["processes"][uid] = process 15 | return result 16 | 17 | 18 | def default_process_status(process, max_puid_len=10, group_by="group"): 19 | nuid = "{{uid:{}}}".format(max_puid_len).format(uid=process["uid"]) 20 | if group_by in (None, "process"): 21 | template = "{nuid} {statename:8} {description}" 22 | else: 23 | template = " {nuid} {statename:8} {description}" 24 | return template.format(nuid=nuid, **process) 25 | 26 | 27 | def processes_status( 28 | status, 29 | group_by="process", 30 | process_filter=None, 31 | process_status=default_process_status, 32 | ): 33 | processes = status["processes"] 34 | if processes: 35 | puid_len = max(map(len, processes)) 36 | else: 37 | puid_len = 8 38 | result = [] 39 | if process_filter is None: 40 | process_filter = lambda p: True 41 | if group_by in (None, "process"): 42 | for puid in sorted(processes): 43 | process = processes[puid] 44 | if process_filter(process): 45 | result.append( 46 | process_status(process, max_puid_len=puid_len, group_by=group_by) 47 | ) 48 | else: 49 | grouped = group_processes_status_by( 50 | processes, group_by=group_by, process_filter=process_filter 51 | ) 52 | for name in sorted(grouped): 53 | result.append(name + ":") 54 | for process in grouped[name]["processes"].values(): 55 | result.append( 56 | process_status(process, max_puid_len=puid_len, group_by=group_by) 57 | ) 58 | return result 59 | -------------------------------------------------------------------------------- /examples/full_example/supervisord_baslid001.conf: -------------------------------------------------------------------------------- 1 | [inet_http_server] 2 | port=:9031 3 | 4 | [supervisord] 5 | logfile_backups=10 6 | logfile_maxbytes=1MB 7 | logfile=%(here)s/log/supervisor_baslid001.log 8 | pidfile=%(here)s/supervisor_baslid001.pid 9 | childlogdir=%(here)s/log 10 | identifier=baslid001 11 | 12 | [supervisorctl] 13 | serverurl=http://localhost:9031 14 | 15 | [rpcinterface:supervisor] 16 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 17 | 18 | [rpcinterface:multivisor] 19 | supervisor.rpcinterface_factory = multivisor.rpc:make_rpc_interface 20 | bind=*:9032 21 | 22 | [group:BeamViewer] 23 | programs=basler_mbv1,basler_mbv2,basler_mbv3,basler_wbv1,basler_wbv2 24 | 25 | [program:basler_wbv1] 26 | command=%(here)s/Lima %(program_name)s 27 | autorestart=unexpected 28 | redirect_stderr=true 29 | stdout_logfile=%(here)s/log/%(program_name)s.log 30 | stdout_logfile_maxbytes=1MB 31 | stdout_logfile_backups=10 32 | 33 | [program:basler_wbv2] 34 | command=%(here)s/Lima %(program_name)s 35 | autorestart=unexpected 36 | redirect_stderr=true 37 | stdout_logfile=%(here)s/log/%(program_name)s.log 38 | stdout_logfile_maxbytes=1MB 39 | stdout_logfile_backups=10 40 | 41 | [program:basler_mbv1] 42 | command=%(here)s/Lima %(program_name)s 43 | autorestart=unexpected 44 | redirect_stderr=true 45 | stdout_logfile=%(here)s/log/%(program_name)s.log 46 | stdout_logfile_maxbytes=1MB 47 | stdout_logfile_backups=10 48 | 49 | [program:basler_mbv2] 50 | command=%(here)s/Lima %(program_name)s 51 | autorestart=unexpected 52 | redirect_stderr=true 53 | stdout_logfile=%(here)s/log/%(program_name)s.log 54 | stdout_logfile_maxbytes=1MB 55 | stdout_logfile_backups=10 56 | 57 | [program:basler_mbv3] 58 | process_name=basler_mbv3-%(process_num)s 59 | numprocs=3 60 | command=%(here)s/Lima %(program_name)s 61 | autorestart=unexpected 62 | redirect_stderr=true 63 | stdout_logfile=%(here)s/log/%(program_name)s.log 64 | stdout_logfile_maxbytes=1MB 65 | stdout_logfile_backups=10 66 | 67 | [program:talks_too_much] 68 | command=%(here)s/talkative 69 | autorestart=unexpected 70 | redirect_stderr=true 71 | stdout_logfile=%(here)s/log/%(program_name)s.log 72 | stdout_logfile_maxbytes=1MB 73 | stdout_logfile_backups=10 74 | -------------------------------------------------------------------------------- /multivisor/server/util.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import functools 3 | 4 | from flask import session, abort 5 | 6 | 7 | def is_login_valid(app, username, password): 8 | username = username.strip() 9 | password = password.strip() 10 | 11 | correct_username = app.multivisor.config["username"] 12 | correct_password = app.multivisor.config["password"] 13 | return constant_time_compare(username, correct_username) and constant_time_compare( 14 | password, correct_password 15 | ) 16 | 17 | 18 | def constant_time_compare(val1, val2): 19 | """ 20 | Returns True if the two strings are equal, False otherwise. 21 | 22 | The time taken is independent of the number of characters that match. 23 | 24 | For the sake of simplicity, this function executes in constant time only 25 | when the two strings have the same length. It short-circuits when they 26 | have different lengths. 27 | 28 | Taken from Django Source Code 29 | """ 30 | val1 = hashlib.sha1(_safe_encode(val1)).hexdigest() 31 | if val2.startswith("{SHA}"): # password can be specified as SHA-1 hash in config 32 | val2 = val2.split("{SHA}")[1] 33 | else: 34 | val2 = hashlib.sha1(_safe_encode(val2)).hexdigest() 35 | if len(val1) != len(val2): 36 | return False 37 | result = 0 38 | for x, y in zip(val1, val2): 39 | result |= ord(x) ^ ord(y) 40 | return result == 0 41 | 42 | 43 | def _safe_encode(data): 44 | """Safely encode @data string to utf-8""" 45 | try: 46 | result = data.encode("utf-8") 47 | except (UnicodeDecodeError, UnicodeEncodeError, AttributeError): 48 | result = data 49 | return result 50 | 51 | 52 | def login_required(app): 53 | """ 54 | Decorator to mark view as requiring being logged in 55 | """ 56 | 57 | def decorator(func): 58 | @functools.wraps(func) 59 | def wrapper_login_required(*args, **kwargs): 60 | auth_on = app.multivisor.use_authentication 61 | 62 | if not auth_on or "username" in session: 63 | return func(*args, **kwargs) 64 | 65 | # user not authenticated, return 401 66 | abort(401) 67 | 68 | return wrapper_login_required 69 | 70 | return decorator 71 | -------------------------------------------------------------------------------- /src/components/ToolBar.vue: -------------------------------------------------------------------------------- 1 | 32 | 33 | 59 | -------------------------------------------------------------------------------- /src/components/process/Details.vue: -------------------------------------------------------------------------------- 1 | 22 | 23 | 63 | -------------------------------------------------------------------------------- /multivisor/util.py: -------------------------------------------------------------------------------- 1 | import re 2 | import fnmatch 3 | 4 | try: 5 | from collections import abc 6 | except ImportError: 7 | import collections as abc 8 | 9 | import six 10 | 11 | _PROTO_RE_STR = "(?P\w+)\://" 12 | _HOST_RE_STR = "?P([\w\-_]+\.)*[\w\-_]+|\*" 13 | _PORT_RE_STR = "\:(?P\d{1,5})" 14 | 15 | URL_RE = re.compile( 16 | "({protocol})?({host})?({port})?".format( 17 | protocol=_PROTO_RE_STR, host=_HOST_RE_STR, port=_PORT_RE_STR 18 | ) 19 | ) 20 | 21 | 22 | def sanitize_url(url, protocol=None, host=None, port=None): 23 | match = URL_RE.match(url) 24 | if match is None: 25 | raise ValueError("Invalid URL: {!r}".format(url)) 26 | pars = match.groupdict() 27 | _protocol, _host, _port = pars["protocol"], pars["host"], pars["port"] 28 | protocol = protocol if _protocol is None else _protocol 29 | host = host if _host is None else _host 30 | port = port if _port is None else _port 31 | protocol = "" if protocol is None else (protocol + "://") 32 | port = "" if port is None else ":" + str(port) 33 | return dict( 34 | url="{}{}{}".format(protocol, host, port), 35 | protocol=protocol, 36 | host=host, 37 | port=port, 38 | ) 39 | 40 | 41 | def filter_patterns(names, patterns): 42 | patterns = [ 43 | "*:{}".format(p) if ":" not in p and "*" not in p else p for p in patterns 44 | ] 45 | result = set() 46 | sets = (fnmatch.filter(names, pattern) for pattern in patterns) 47 | list(map(result.update, sets)) 48 | return result 49 | 50 | 51 | def parse_dict(obj): 52 | """Returns a copy of `obj` where bytes from key/values was replaced by str""" 53 | decoded = {} 54 | for k, v in obj.items(): 55 | if isinstance(k, bytes): 56 | k = k.decode("utf-8") 57 | if isinstance(v, bytes): 58 | v = v.decode("utf-8") 59 | decoded[k] = v 60 | return decoded 61 | 62 | 63 | def parse_obj(obj): 64 | """Returns `obj` or a copy replacing recursively bytes by str 65 | 66 | `obj` can be any objects, including list and dictionary""" 67 | if isinstance(obj, bytes): 68 | return obj.decode() 69 | elif isinstance(obj, six.text_type): 70 | return obj 71 | elif isinstance(obj, abc.Mapping): 72 | return {parse_obj(k): parse_obj(v) for k, v in obj.items()} 73 | elif isinstance(obj, abc.Container): 74 | return type(obj)(parse_obj(i) for i in obj) 75 | return obj 76 | -------------------------------------------------------------------------------- /src/components/process/Page.vue: -------------------------------------------------------------------------------- 1 | 35 | 36 | 72 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "multivisor", 3 | "version": "6.0.2", 4 | "description": "Manage multiple supervisor instances from a centralized UI", 5 | "author": "Tiago Coutinho ", 6 | "private": true, 7 | "scripts": { 8 | "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js", 9 | "start": "npm run dev", 10 | "lint": "eslint --ext .js,.vue src", 11 | "build": "node build/build.js" 12 | }, 13 | "dependencies": { 14 | "vue": "^2.5.22", 15 | "vue-router": "^3.0.2", 16 | "vuetify": "^1.4.4", 17 | "vuex": "^3.1.0" 18 | }, 19 | "devDependencies": { 20 | "autoprefixer": "^7.2.6", 21 | "babel-core": "^6.26.3", 22 | "babel-eslint": "^7.1.1", 23 | "babel-helper-vue-jsx-merge-props": "^2.0.3", 24 | "babel-loader": "^7.1.5", 25 | "babel-plugin-syntax-jsx": "^6.18.0", 26 | "babel-plugin-transform-runtime": "^6.22.0", 27 | "babel-plugin-transform-vue-jsx": "^3.7.0", 28 | "babel-preset-env": "^1.7.0", 29 | "babel-preset-stage-2": "^6.22.0", 30 | "chalk": "^2.4.2", 31 | "copy-webpack-plugin": "^4.6.0", 32 | "css-loader": "^0.28.11", 33 | "eslint": "^3.19.0", 34 | "eslint-config-standard": "^10.2.1", 35 | "eslint-friendly-formatter": "^3.0.0", 36 | "eslint-loader": "^1.7.1", 37 | "eslint-plugin-html": "^3.0.0", 38 | "eslint-plugin-import": "^2.16.0", 39 | "eslint-plugin-node": "^5.2.0", 40 | "eslint-plugin-promise": "^3.8.0", 41 | "eslint-plugin-standard": "^3.1.0", 42 | "extract-text-webpack-plugin": "^3.0.0", 43 | "file-loader": "^1.1.11", 44 | "friendly-errors-webpack-plugin": "^1.7.0", 45 | "html-webpack-plugin": "^2.30.1", 46 | "node-notifier": "^5.3.0", 47 | "optimize-css-assets-webpack-plugin": "^3.2.0", 48 | "ora": "^1.2.0", 49 | "portfinder": "^1.0.20", 50 | "postcss-import": "^11.1.0", 51 | "postcss-loader": "^2.1.6", 52 | "postcss-url": "^7.3.2", 53 | "rimraf": "^2.6.3", 54 | "semver": "^5.6.0", 55 | "shelljs": "^0.7.6", 56 | "uglifyjs-webpack-plugin": "^1.3.0", 57 | "url-loader": "^1.1.2", 58 | "vue-loader": "^13.7.3", 59 | "vue-style-loader": "^3.0.1", 60 | "vue-template-compiler": "^2.5.22", 61 | "webpack": "^3.12.0", 62 | "webpack-bundle-analyzer": "^2.13.1", 63 | "webpack-dev-server": "^3.1.14", 64 | "webpack-merge": "^4.2.1" 65 | }, 66 | "engines": { 67 | "node": ">= 6.0.0", 68 | "npm": ">= 3.0.0" 69 | }, 70 | "browserslist": [ 71 | "> 1%", 72 | "last 2 versions", 73 | "not ie <= 8" 74 | ] 75 | } 76 | -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | from gevent.monkey import patch_all 2 | 3 | patch_all(thread=False) 4 | 5 | 6 | import os 7 | import signal 8 | import subprocess 9 | from time import sleep 10 | 11 | import pytest 12 | import requests 13 | from requests import ConnectionError 14 | 15 | from multivisor.multivisor import Multivisor 16 | from multivisor.multivisor import Supervisor 17 | from multivisor.server.web import get_parser 18 | 19 | 20 | @pytest.fixture 21 | def basic_options(): 22 | args = ["-c", "tests/multivisor_test.conf"] 23 | parser = get_parser(args) 24 | options = parser.parse_args(args) 25 | return options 26 | 27 | 28 | @pytest.fixture 29 | def multivisor_instance(basic_options): 30 | multivisor = Multivisor(basic_options) 31 | return multivisor 32 | 33 | 34 | @pytest.fixture(autouse=True, scope="session") 35 | def supervisor_test001(): 36 | subprocess.call( 37 | 'pkill -9 -f "supervisord -n -c tests/supervisord_test001.conf"', shell=True 38 | ) 39 | p = subprocess.Popen( 40 | "supervisord -n -c tests/supervisord_test001.conf", 41 | shell=True, 42 | stdout=subprocess.PIPE, 43 | preexec_fn=os.setsid, 44 | ) 45 | 46 | address = "tcp://localhost:9073" 47 | supervisor = Supervisor("test1", address) 48 | info = supervisor.read_info() 49 | 50 | # wait until supervisor is running 51 | while not info["running"]: 52 | sleep(0.1) 53 | info = supervisor.read_info() 54 | 55 | yield p 56 | try: 57 | os.killpg(os.getpgid(p.pid), signal.SIGTERM) 58 | except OSError: 59 | pass # process already dead 60 | 61 | 62 | @pytest.fixture(autouse=True, scope="session") 63 | def server(supervisor_test001, base_url): 64 | p = subprocess.Popen( 65 | "python -m multivisor.server.web -c tests/multivisor_test.conf --bind 0:22001", 66 | shell=True, 67 | stdout=subprocess.PIPE, 68 | preexec_fn=os.setsid, 69 | ) 70 | retires = 0 71 | max_retries = 10 72 | while retires < max_retries: 73 | try: 74 | requests.get(base_url) 75 | break 76 | except ConnectionError: 77 | sleep(0.5) 78 | retires += 1 79 | 80 | yield p 81 | try: 82 | os.killpg(os.getpgid(p.pid), signal.SIGTERM) 83 | except OSError: 84 | pass # process already dead 85 | 86 | 87 | @pytest.fixture(scope="session") 88 | def base_url(): 89 | return "http://localhost:22001" 90 | 91 | 92 | @pytest.fixture(scope="session") 93 | def api_base_url(base_url): 94 | return "{}/api".format(base_url) 95 | -------------------------------------------------------------------------------- /src/components/login/Page.vue: -------------------------------------------------------------------------------- 1 | 29 | 30 | 72 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import platform 2 | from setuptools import setup, find_packages 3 | 4 | 5 | supervisor = "supervisor-win" if platform.system() == "Windows" else "supervisor" 6 | 7 | extras = { 8 | "rpc": ["zerorpc", supervisor], 9 | "web": ["flask", "werkzeug", "blinker", "zerorpc", supervisor], 10 | "cli": ["maya", "requests", "prompt_toolkit>=2", "blinker"], 11 | } 12 | 13 | extras["all"] = list(set.union(*(set(i) for i in extras.values()))) 14 | 15 | requires = ["six", "gevent>=1.3"] 16 | 17 | with open("README.md") as readme_file: 18 | readme = readme_file.read() 19 | 20 | setup( 21 | name="multivisor", 22 | version="6.0.2", 23 | author="Tiago Coutinho", 24 | author_email="coutinhotiago@gmail.com", 25 | description="A centralized supervisor UI (web & CLI)", 26 | long_description=readme, 27 | long_description_content_type="text/markdown", 28 | packages=find_packages(exclude=("tests", "tests.*")), 29 | package_data={ 30 | "multivisor.server": ["dist/*", "dist/static/css/*", "dist/static/js/*"] 31 | }, 32 | entry_points=dict( 33 | console_scripts=[ 34 | "multivisor=multivisor.server.web:main [web]", 35 | "multivisor-rpc=multivisor.server.rpc:main [rpc]", 36 | "multivisor-cli=multivisor.client.cli:main [cli]" 37 | ] 38 | ), 39 | extras_require=extras, 40 | install_requires=requires, 41 | classifiers=[ 42 | "Development Status :: 4 - Beta", 43 | "Environment :: Console", 44 | "Environment :: Web Environment", 45 | "Framework :: Flask", 46 | "Intended Audience :: Developers", 47 | "Intended Audience :: Information Technology", 48 | "Intended Audience :: System Administrators", 49 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 50 | "Natural Language :: English", 51 | "Operating System :: POSIX", 52 | "Operating System :: Microsoft :: Windows", 53 | "Programming Language :: Python", 54 | "Programming Language :: Python :: 2", 55 | "Programming Language :: Python :: 2.7", 56 | "Programming Language :: Python :: 3", 57 | "Programming Language :: Python :: 3.5", 58 | "Programming Language :: Python :: 3.6", 59 | "Programming Language :: Python :: 3.7", 60 | "Programming Language :: Python :: 3.8", 61 | "Programming Language :: Python :: 3.9", 62 | "Topic :: System :: Boot", 63 | "Topic :: System :: Monitoring", 64 | "Topic :: System :: Systems Administration", 65 | ], 66 | license="GNU General Public License v3", 67 | ) 68 | -------------------------------------------------------------------------------- /src/components/group/Card.vue: -------------------------------------------------------------------------------- 1 | 38 | 39 | 82 | -------------------------------------------------------------------------------- /config/index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | // Template version: 1.2.8 3 | // see http://vuejs-templates.github.io/webpack for documentation. 4 | 5 | const path = require('path') 6 | 7 | module.exports = { 8 | dev: { 9 | 10 | // Paths 11 | assetsSubDirectory: 'static', 12 | assetsPublicPath: '/', 13 | proxyTable: { 14 | '/api': { 15 | target: 'http://localhost:22000', 16 | debug: true 17 | } 18 | }, 19 | 20 | // Various Dev Server settings 21 | host: '0.0.0.0', // can be overwritten by process.env.HOST 22 | port: 8080, // can be overwritten by process.env.PORT, if port is in use, a free one will be determined 23 | autoOpenBrowser: false, 24 | errorOverlay: true, 25 | notifyOnErrors: true, 26 | poll: false, // https://webpack.js.org/configuration/dev-server/#devserver-watchoptions- 27 | 28 | // Use Eslint Loader? 29 | // If true, your code will be linted during bundling and 30 | // linting errors and warnings will be shown in the console. 31 | useEslint: true, 32 | // If true, eslint errors and warnings will also be shown in the error overlay 33 | // in the browser. 34 | showEslintErrorsInOverlay: false, 35 | 36 | /** 37 | * Source Maps 38 | */ 39 | 40 | // https://webpack.js.org/configuration/devtool/#development 41 | devtool: 'cheap-module-eval-source-map', 42 | 43 | // If you have problems debugging vue-files in devtools, 44 | // set this to false - it *may* help 45 | // https://vue-loader.vuejs.org/en/options.html#cachebusting 46 | cacheBusting: true, 47 | 48 | cssSourceMap: true, 49 | }, 50 | 51 | build: { 52 | // Template for index.html 53 | index: path.resolve(__dirname, '../multivisor/server/dist/index.html'), 54 | 55 | // Paths 56 | assetsRoot: path.resolve(__dirname, '../multivisor/server/dist'), 57 | assetsSubDirectory: 'static', 58 | assetsPublicPath: '/', 59 | 60 | /** 61 | * Source Maps 62 | */ 63 | 64 | productionSourceMap: true, 65 | // https://webpack.js.org/configuration/devtool/#production 66 | devtool: '#source-map', 67 | 68 | // Gzip off by default as many popular static hosts such as 69 | // Surge or Netlify already gzip all static assets for you. 70 | // Before setting to `true`, make sure to: 71 | // npm install --save-dev compression-webpack-plugin 72 | productionGzip: false, 73 | productionGzipExtensions: ['js', 'css'], 74 | 75 | // Run the build command with an extra argument to 76 | // View the bundle analyzer report after build finishes: 77 | // `npm run build --report` 78 | // Set to `true` or `false` to always turn it on or off 79 | bundleAnalyzerReport: process.env.npm_config_report 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /src/components/process/Tile.vue: -------------------------------------------------------------------------------- 1 | 46 | 47 | 85 | -------------------------------------------------------------------------------- /src/components/process/Row.vue: -------------------------------------------------------------------------------- 1 | 58 | 59 | 96 | -------------------------------------------------------------------------------- /tests/supervisord_test001.conf: -------------------------------------------------------------------------------- 1 | [inet_http_server] 2 | port=:9074 3 | 4 | [supervisord] 5 | nodaemon=true 6 | 7 | [supervisorctl] 8 | serverurl=http://localhost:9074 9 | 10 | [rpcinterface:supervisor] 11 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 12 | 13 | [rpcinterface:multivisor] 14 | supervisor.rpcinterface_factory = multivisor.rpc:make_rpc_interface 15 | bind=*:9073 16 | 17 | [group:Vacuum] 18 | programs:vacuum_OH1,vacuum_OH2_1,vacuum_OH2_2 19 | 20 | [group:PLC] 21 | programs:wcid00a,wcid00b,wcid00c,wcid00d 22 | 23 | [group:Counter] 24 | programs:exits_2s,exits_10s,exit_1s_restart 25 | 26 | [program:vacuum_OH1] 27 | command=examples/full_example/vacuum OH1 28 | autorestart=unexpected 29 | stdout_logfile=%(here)s/log/%(program_name)s.log 30 | stdout_logfile_maxbytes=128kB 31 | stdout_logfile_backups=0 32 | stderr_logfile=%(here)s/log/%(program_name)s.err.log 33 | stderr_logfile_maxbytes=128kB 34 | stderr_logfile_backups=0 35 | startsecs=5 36 | 37 | [program:vacuum_OH2_1] 38 | command=examples/full_example/vacuum OH2_1 39 | autorestart=unexpected 40 | redirect_stderr=true 41 | stdout_logfile=%(here)s/log/%(program_name)s.log 42 | stdout_logfile_maxbytes=128kB 43 | stdout_logfile_backups=0 44 | startsecs=10 45 | 46 | [program:vacuum_OH2_2] 47 | command=examples/full_example/vacuum OH2_2 48 | autorestart=unexpected 49 | redirect_stderr=true 50 | stdout_logfile=%(here)s/log/%(program_name)s.log 51 | stdout_logfile_maxbytes=128kB 52 | stdout_logfile_backups=0 53 | 54 | [program:wcid00a] 55 | command=examples/full_example/wago %(program_name)s 56 | autorestart=unexpected 57 | redirect_stderr=true 58 | stdout_logfile=%(here)s/log/%(program_name)s.log 59 | stdout_logfile_maxbytes=128kB 60 | stdout_logfile_backups=0 61 | 62 | [program:wcid00b] 63 | command=examples/full_example/wago %(program_name)s 64 | autorestart=unexpected 65 | redirect_stderr=true 66 | stdout_logfile=%(here)s/log/%(program_name)s.log 67 | stdout_logfile_maxbytes=128kB 68 | stdout_logfile_backups=0 69 | 70 | [program:wcid00c] 71 | command=examples/full_example/wago %(program_name)s 72 | autorestart=unexpected 73 | redirect_stderr=true 74 | stdout_logfile=%(here)s/log/%(program_name)s.log 75 | stdout_logfile_maxbytes=128kB 76 | stdout_logfile_backups=0 77 | 78 | [program:wcid00d] 79 | command=examples/full_example/wago %(program_name)s 80 | autorestart=unexpected 81 | redirect_stderr=true 82 | stdout_logfile=%(here)s/log/%(program_name)s.log 83 | stdout_logfile_maxbytes=128kB 84 | stdout_logfile_backups=0 85 | 86 | [program:exits_2s] 87 | command=examples/full_example/exits 2 88 | autorestart=unexpected 89 | redirect_stderr=true 90 | stdout_logfile=%(here)s/log/%(program_name)s.log 91 | stdout_logfile_maxbytes=128kB 92 | stdout_logfile_backups=0 93 | startsecs=5 94 | 95 | [program:exits_10s] 96 | command=examples/full_example/exits 10 97 | autorestart=unexpected 98 | redirect_stderr=true 99 | stdout_logfile=%(here)s/log/%(program_name)s.log 100 | stdout_logfile_maxbytes=128kB 101 | stdout_logfile_backups=0 102 | startsecs=1 103 | 104 | [program:exit_1s_restart] 105 | command=examples/full_example/exits 1 106 | autorestart=unexpected 107 | redirect_stderr=true 108 | stdout_logfile=%(here)s/log/%(program_name)s.log 109 | stdout_logfile_maxbytes=128kB 110 | stdout_logfile_backups=0 111 | startsecs=2 112 | -------------------------------------------------------------------------------- /examples/full_example/supervisord_lid001.conf: -------------------------------------------------------------------------------- 1 | [inet_http_server] 2 | port=:9011 3 | 4 | [supervisord] 5 | logfile_backups=10 6 | logfile_maxbytes=1MB 7 | logfile=%(here)s/log/supervisor_lid001.log 8 | pidfile=%(here)s/supervisor_lid001.pid 9 | childlogdir=%(here)s/log 10 | identifier=lid001 11 | 12 | [supervisorctl] 13 | serverurl=http://localhost:9011 14 | 15 | [rpcinterface:supervisor] 16 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 17 | 18 | [rpcinterface:multivisor] 19 | supervisor.rpcinterface_factory = multivisor.rpc:make_rpc_interface 20 | bind=*:9012 21 | 22 | [group:Vacuum] 23 | programs:vacuum_OH1,vacuum_OH2_1,vacuum_OH2_2 24 | 25 | [group:PLC] 26 | programs:wcid00a,wcid00b,wcid00c,wcid00d 27 | 28 | [group:Counter] 29 | programs:exits_2s,exits_10s,exit_1s_restart 30 | 31 | [program:vacuum_OH1] 32 | command=%(here)s/vacuum OH1 33 | autorestart=unexpected 34 | stdout_logfile=%(here)s/log/%(program_name)s.log 35 | stdout_logfile_maxbytes=1MB 36 | stdout_logfile_backups=10 37 | stderr_logfile=%(here)s/log/%(program_name)s.err.log 38 | stderr_logfile_maxbytes=1MB 39 | stderr_logfile_backups=1 40 | startsecs=5 41 | 42 | [program:vacuum_OH2_1] 43 | command=%(here)s/vacuum OH2_1 44 | autorestart=unexpected 45 | redirect_stderr=true 46 | stdout_logfile=%(here)s/log/%(program_name)s.log 47 | stdout_logfile_maxbytes=1MB 48 | stdout_logfile_backups=10 49 | startsecs=10 50 | 51 | [program:vacuum_OH2_2] 52 | command=%(here)s/vacuum OH2_2 53 | autorestart=unexpected 54 | redirect_stderr=true 55 | stdout_logfile=%(here)s/log/%(program_name)s.log 56 | stdout_logfile_maxbytes=1MB 57 | stdout_logfile_backups=10 58 | 59 | [program:wcid00a] 60 | command=%(here)s/wago %(program_name)s 61 | autorestart=unexpected 62 | redirect_stderr=true 63 | stdout_logfile=%(here)s/log/%(program_name)s.log 64 | stdout_logfile_maxbytes=1MB 65 | stdout_logfile_backups=10 66 | 67 | [program:wcid00b] 68 | command=%(here)s/wago %(program_name)s 69 | autorestart=unexpected 70 | redirect_stderr=true 71 | stdout_logfile=%(here)s/log/%(program_name)s.log 72 | stdout_logfile_maxbytes=1MB 73 | stdout_logfile_backups=10 74 | 75 | [program:wcid00c] 76 | command=%(here)s/wago %(program_name)s 77 | autorestart=unexpected 78 | redirect_stderr=true 79 | stdout_logfile=%(here)s/log/%(program_name)s.log 80 | stdout_logfile_maxbytes=1MB 81 | stdout_logfile_backups=10 82 | 83 | [program:wcid00d] 84 | command=%(here)s/wago %(program_name)s 85 | autorestart=unexpected 86 | redirect_stderr=true 87 | stdout_logfile=%(here)s/log/%(program_name)s.log 88 | stdout_logfile_maxbytes=1MB 89 | stdout_logfile_backups=10 90 | 91 | [program:exits_2s] 92 | command=%(here)s/exits 2 93 | autorestart=unexpected 94 | redirect_stderr=true 95 | stdout_logfile=%(here)s/log/%(program_name)s.log 96 | stdout_logfile_maxbytes=1MB 97 | stdout_logfile_backups=10 98 | startsecs=5 99 | 100 | [program:exits_10s] 101 | command=%(here)s/exits 10 102 | autorestart=unexpected 103 | redirect_stderr=true 104 | stdout_logfile=%(here)s/log/%(program_name)s.log 105 | stdout_logfile_maxbytes=1MB 106 | stdout_logfile_backups=10 107 | startsecs=1 108 | 109 | [program:exit_1s_restart] 110 | command=%(here)s/exits 1 111 | autorestart=unexpected 112 | redirect_stderr=true 113 | stdout_logfile=%(here)s/log/%(program_name)s.log 114 | stdout_logfile_maxbytes=1MB 115 | stdout_logfile_backups=10 116 | startsecs=2 117 | -------------------------------------------------------------------------------- /multivisor/client/http.py: -------------------------------------------------------------------------------- 1 | import json 2 | 3 | import requests 4 | from blinker import signal 5 | 6 | 7 | class Multivisor(object): 8 | def __init__(self, url): 9 | self.url = url 10 | self._status = None 11 | self.notifications = [] 12 | 13 | def stop_processes(self, *names): 14 | return self.post("/api/process/stop", data=dict(uid=[",".join(names)])) 15 | 16 | def restart_processes(self, *names): 17 | return self.post("/api/process/restart", data=dict(uid=[",".join(names)])) 18 | 19 | @property 20 | def status(self): 21 | if self._status is None: 22 | self._status = self.get_status() 23 | return self._status 24 | 25 | @staticmethod 26 | def _update_status_stats(status): 27 | supervisors, processes = status["supervisors"], status["processes"] 28 | s_stats = dict( 29 | running=sum((s["running"] for s in status["supervisors"].values())), 30 | total=len(supervisors), 31 | ) 32 | s_stats["stopped"] = s_stats["total"] - s_stats["running"] 33 | p_stats = dict( 34 | running=sum((p["running"] for p in status["processes"].values())), 35 | total=len(processes), 36 | ) 37 | p_stats["stopped"] = p_stats["total"] - p_stats["running"] 38 | stats = dict(supervisors=s_stats, processes=p_stats) 39 | status["stats"] = stats 40 | return stats 41 | 42 | def get_status(self): 43 | status = self.get("/api/data").json() 44 | # reorganize status per process 45 | status["processes"] = processes = {} 46 | for supervisor in status["supervisors"].values(): 47 | processes.update(supervisor["processes"]) 48 | self._update_status_stats(status) 49 | return status 50 | 51 | def refresh_status(self): 52 | self._status = None 53 | return self.status 54 | 55 | def get(self, url, params=None, **kwargs): 56 | result = requests.get(self.url + url, params=params, **kwargs) 57 | result.raise_for_status() 58 | return result 59 | 60 | def post(self, url, data=None, json=None, **kwargs): 61 | result = requests.post(self.url + url, data=data, json=json, **kwargs) 62 | result.raise_for_status() 63 | return result 64 | 65 | def __getitem__(self, item): 66 | return self.get(item).json() 67 | 68 | def __setitem__(self, item, value): 69 | self.post(item, data=value) 70 | 71 | def events(self): 72 | stream = self.get("/api/stream", stream=True) 73 | for line in stream.iter_lines(): 74 | if line: 75 | line = line.decode("utf-8") 76 | if line.startswith("data:"): 77 | line = line[5:] 78 | try: 79 | yield json.loads(line) 80 | except ValueError: 81 | print("error", line) 82 | 83 | def run(self): 84 | for event in self.events(): 85 | status = self.status 86 | name, payload = event["event"], event["payload"] 87 | if name == "process_changed": 88 | status["processes"][payload["uid"]].update(payload) 89 | self._update_status_stats(status) 90 | elif name == "notification": 91 | self.notifications.append(payload) 92 | event_signal = signal(name) 93 | event_signal.send(name, payload=payload) 94 | -------------------------------------------------------------------------------- /docker/supervisord/lid001.conf: -------------------------------------------------------------------------------- 1 | [inet_http_server] 2 | port=:9001 3 | 4 | [supervisord] 5 | identifier=lid001 6 | nodaemon = true 7 | pidfile = /var/run/supervisord.pid 8 | logfile = /var/log/supervisord/supervisord.log 9 | childlogdir = /var/log/supervisord 10 | logfile_backups=10 11 | logfile_maxbytes=1MB 12 | 13 | [supervisorctl] 14 | serverurl=http://localhost:9001 15 | 16 | [rpcinterface:supervisor] 17 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 18 | 19 | [eventlistener:multivisor-rpc] 20 | command=multivisor-rpc 21 | events=PROCESS_STATE,SUPERVISOR_STATE_CHANGE 22 | 23 | [group:Vacuum] 24 | programs:vacuum_OH1,vacuum_OH2_1,vacuum_OH2_2 25 | 26 | [group:PLC] 27 | programs:wcid00a,wcid00b,wcid00c,wcid00d 28 | 29 | [group:Counter] 30 | programs:exits_2s,exits_10s,exit_1s_restart 31 | 32 | [program:multivisor] 33 | command=multivisor -c /etc/multivisor.conf 34 | autorestart=unexpected 35 | stdout_logfile=%(program_name)s.log 36 | stdout_logfile_maxbytes=1MB 37 | stdout_logfile_backups=10 38 | stderr_logfile=%(program_name)s.err.log 39 | stderr_logfile_maxbytes=1MB 40 | stderr_logfile_backups=1 41 | 42 | [program:vacuum_OH1] 43 | command=vacuum OH1 44 | autorestart=unexpected 45 | stdout_logfile=%(program_name)s.log 46 | stdout_logfile_maxbytes=1MB 47 | stdout_logfile_backups=10 48 | stderr_logfile=%(program_name)s.err.log 49 | stderr_logfile_maxbytes=1MB 50 | stderr_logfile_backups=1 51 | startsecs=5 52 | 53 | [program:vacuum_OH2_1] 54 | command=vacuum OH2_1 55 | autorestart=unexpected 56 | redirect_stderr=true 57 | stdout_logfile=%(program_name)s.log 58 | stdout_logfile_maxbytes=1MB 59 | stdout_logfile_backups=10 60 | startsecs=10 61 | 62 | [program:vacuum_OH2_2] 63 | command=vacuum OH2_2 64 | autorestart=unexpected 65 | redirect_stderr=true 66 | stdout_logfile=%(program_name)s.log 67 | stdout_logfile_maxbytes=1MB 68 | stdout_logfile_backups=10 69 | 70 | [program:wcid00a] 71 | command=wago %(program_name)s 72 | autorestart=unexpected 73 | redirect_stderr=true 74 | stdout_logfile=%(program_name)s.log 75 | stdout_logfile_maxbytes=1MB 76 | stdout_logfile_backups=10 77 | 78 | [program:wcid00b] 79 | command=wago %(program_name)s 80 | autorestart=unexpected 81 | redirect_stderr=true 82 | stdout_logfile=%(program_name)s.log 83 | stdout_logfile_maxbytes=1MB 84 | stdout_logfile_backups=10 85 | 86 | [program:wcid00c] 87 | command=wago %(program_name)s 88 | autorestart=unexpected 89 | redirect_stderr=true 90 | stdout_logfile=%(program_name)s.log 91 | stdout_logfile_maxbytes=1MB 92 | stdout_logfile_backups=10 93 | 94 | [program:wcid00d] 95 | command=wago %(program_name)s 96 | autorestart=unexpected 97 | redirect_stderr=true 98 | stdout_logfile=%(program_name)s.log 99 | stdout_logfile_maxbytes=1MB 100 | stdout_logfile_backups=10 101 | 102 | [program:exits_2s] 103 | command=exits 2 104 | autorestart=unexpected 105 | redirect_stderr=true 106 | stdout_logfile=%(program_name)s.log 107 | stdout_logfile_maxbytes=1MB 108 | stdout_logfile_backups=10 109 | startsecs=5 110 | 111 | [program:exits_10s] 112 | command=exits 10 113 | autorestart=unexpected 114 | redirect_stderr=true 115 | stdout_logfile=%(program_name)s.log 116 | stdout_logfile_maxbytes=1MB 117 | stdout_logfile_backups=10 118 | startsecs=1 119 | 120 | [program:exit_1s_restart] 121 | command=exits 1 122 | autorestart=unexpected 123 | redirect_stderr=true 124 | stdout_logfile=%(program_name)s.log 125 | stdout_logfile_maxbytes=1MB 126 | stdout_logfile_backups=10 127 | startsecs=2 128 | -------------------------------------------------------------------------------- /src/multivisor.js: -------------------------------------------------------------------------------- 1 | export const stateColorMap = { 2 | STOPPED: 'red', 3 | STARTING: 'blue', 4 | RUNNING: 'green', 5 | BACKOFF: 'orange', 6 | STOPPING: 'blue', 7 | EXITED: 'red', 8 | FATAL: 'purple', 9 | UNKNOWN: 'grey' 10 | } 11 | 12 | export const notificationColorMap = { 13 | DEBUG: 'grey darken-2', 14 | INFO: 'grey darken-3', 15 | WARNING: 'orange', 16 | ERROR: 'error' 17 | } 18 | 19 | export const supervisorAction = (id, action) => { 20 | let form = new FormData() 21 | form.append('supervisor', id) 22 | return fetch('/api/supervisor/' + action, {method: 'POST', body: form}) 23 | } 24 | 25 | export const processAction = (uid, action) => { 26 | let form = new FormData() 27 | form.append('uid', uid) 28 | fetch('/api/process/' + action, { method: 'POST', body: form }) 29 | } 30 | 31 | export const load = () => { 32 | return fetch('/api/data') 33 | } 34 | 35 | export const streamTo = (eventHandler) => { 36 | let eventSource = new EventSource('/api/stream') 37 | eventSource.onmessage = event => { 38 | let data = JSON.parse(event.data) 39 | eventHandler(data) 40 | } 41 | eventSource.onerror = () => { 42 | eventHandler('error') 43 | } 44 | eventSource.onclose = () => { 45 | eventHandler('close') 46 | } 47 | return eventSource 48 | } 49 | 50 | export const formatBytes = (bytes, decimals) => { 51 | if (bytes === 0) return '0 b' 52 | let k = 1024 53 | let dm = decimals || 2 54 | let sizes = ['b', 'Kb', 'Mb', 'Gb', 'Tb', 'Pb', 'Eb', 'Zb', 'Yb'] 55 | let i = Math.floor(Math.log(bytes) / Math.log(k)) 56 | return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i] 57 | } 58 | 59 | export const timeAgo = (timestamp) => { 60 | var templates = { 61 | prefix: '', 62 | suffix: ' ago', 63 | seconds: 'less than a minute', 64 | minute: 'about a minute', 65 | minutes: '%d minutes', 66 | hour: 'about an hour', 67 | hours: 'about %d hours', 68 | day: 'a day', 69 | days: '%d days', 70 | month: 'about a month', 71 | months: '%d months', 72 | year: 'about a year', 73 | years: '%d years' 74 | } 75 | 76 | var template = function (t, n) { 77 | return templates[t] && templates[t].replace(/%d/i, Math.abs(Math.round(n))) 78 | } 79 | 80 | var then = new Date(timestamp * 1000) 81 | 82 | var now = new Date() 83 | var seconds = ((now.getTime() - then) * 0.001) >> 0 84 | var minutes = seconds / 60 85 | var hours = minutes / 60 86 | var days = hours / 24 87 | var years = days / 365 88 | 89 | return templates.prefix + ( 90 | (seconds < 45 && template('seconds', seconds)) || 91 | (seconds < 90 && template('minute', 1)) || 92 | (minutes < 45 && template('minutes', minutes)) || 93 | (minutes < 90 && template('hour', 1)) || 94 | (hours < 24 && template('hours', hours)) || 95 | (hours < 42 && template('day', 1)) || 96 | (days < 30 && template('days', days)) || 97 | (days < 45 && template('month', 1)) || 98 | (days < 365 && template('months', days / 30)) || 99 | (years < 1.5 && template('year', 1)) || 100 | template('years', years) 101 | ) + templates.suffix 102 | } 103 | 104 | export const nullMultivisor = { 105 | name: 'Multivisor', 106 | supervisors: {} 107 | } 108 | 109 | export const nullProcess = { 110 | name: '', 111 | uid: '', 112 | pid: 0, 113 | description: '', 114 | exitstatus: 0, 115 | logfile: null, 116 | stderr_logfile: null, 117 | start: 0, 118 | now: 0 119 | } 120 | -------------------------------------------------------------------------------- /src/components/supervisor/Card.vue: -------------------------------------------------------------------------------- 1 | 53 | 54 | 106 | -------------------------------------------------------------------------------- /src/components/process/Log.vue: -------------------------------------------------------------------------------- 1 | 47 | 48 | 142 | 147 | -------------------------------------------------------------------------------- /multivisor/server/rpc.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | 3 | import sys 4 | import logging 5 | import xmlrpc.client 6 | 7 | from os import environ 8 | from functools import partial 9 | 10 | from gevent import spawn 11 | from gevent.lock import RLock 12 | from gevent.queue import Queue 13 | from gevent.fileobject import FileObject 14 | from zerorpc import stream, Server, LostRemote 15 | from supervisor.childutils import getRPCInterface 16 | 17 | 18 | READY = "READY\n" 19 | ACKNOWLEDGED = "RESULT 2\nOK" 20 | DEFAULT_BIND = "tcp://*:9002" 21 | 22 | 23 | def signal(stream, msg): 24 | stream.write(msg) 25 | stream.flush() 26 | 27 | 28 | def wait_for_event(stream): 29 | header_line = stream.readline() 30 | event = dict((x.split(":") for x in header_line.split())) 31 | payload_str = stream.read(int(event["len"])) 32 | event["payload"] = dict((x.split(":") for x in payload_str.split())) 33 | return event 34 | 35 | 36 | def event_producer_loop(dispatch): 37 | istream = FileObject(sys.stdin) 38 | ostream = FileObject(sys.stdout, mode='w') 39 | while True: 40 | signal(ostream, READY) 41 | event = wait_for_event(istream) 42 | dispatch(event) 43 | signal(ostream, ACKNOWLEDGED) 44 | 45 | 46 | def event_consumer_loop(queue, handler): 47 | for event in queue: 48 | try: 49 | handler(event) 50 | except: 51 | logging.exception("Error processing %s", event) 52 | 53 | 54 | get_rpc = partial(getRPCInterface, environ) 55 | 56 | 57 | def build_method(supervisor, name): 58 | subsystem_name, func_name = name.split(".", 1) 59 | def method(*args): 60 | subsystem = getattr(supervisor.rpc, subsystem_name) 61 | with supervisor.lock: 62 | return getattr(subsystem, func_name)(*args) 63 | method.__name__ = func_name 64 | return func_name, method 65 | 66 | 67 | class Supervisor(object): 68 | 69 | def __init__(self, xml_rpc): 70 | self.event_channels = set() 71 | self.lock = RLock() 72 | self.rpc = xml_rpc 73 | for name in self.rpc.system.listMethods(): 74 | setattr(self, *build_method(self, name)) 75 | 76 | @stream 77 | def event_stream(self): 78 | logging.info("client connected to stream") 79 | channel = Queue() 80 | self.event_channels.add(channel) 81 | try: 82 | yield "First event to trigger connection. Please ignore me!" 83 | for event in channel: 84 | yield event 85 | except LostRemote as e: 86 | logging.info("remote end of stream disconnected") 87 | finally: 88 | self.event_channels.remove(channel) 89 | 90 | def publish_event(self, event): 91 | name = event["eventname"] 92 | if name.startswith("TICK"): 93 | return 94 | event = dict(event) 95 | if name.startswith("PROCESS_STATE"): 96 | payload = event["payload"] 97 | pname = "{}:{}".format(payload["groupname"], payload["processname"]) 98 | logging.info("handling %s of %s", name, pname) 99 | try: 100 | payload["process"] = self.getProcessInfo(pname) 101 | except xmlrpc.client.Fault: 102 | # probably supervisor is shutting down 103 | logging.warn("probably shutting down...") 104 | return 105 | elif not name.startswith("SUPERVISOR_STATE"): 106 | logging.warning("ignored %s", name) 107 | return 108 | for channel in self.event_channels: 109 | channel.put(event) 110 | 111 | 112 | def run(xml_rpc, bind=DEFAULT_BIND): 113 | channel = Queue() 114 | supervisor = Supervisor(xml_rpc) 115 | t1 = spawn(event_consumer_loop, channel, supervisor.publish_event) 116 | t2 = spawn(event_producer_loop, channel.put) 117 | server = Server(supervisor) 118 | server.bind(bind) 119 | server.run() 120 | 121 | 122 | def main(args=None): 123 | import gevent.monkey 124 | 125 | gevent.monkey.patch_all(thread=False, sys=True) 126 | 127 | import argparse 128 | 129 | parser = argparse.ArgumentParser() 130 | parser.add_argument("--bind", help="bind address", default=DEFAULT_BIND) 131 | parser.add_argument( 132 | "--log-level", 133 | help="log level", 134 | type=str, 135 | default="INFO", 136 | choices=["DEBUG", "INFO", "WARN", "ERROR"], 137 | ) 138 | options = parser.parse_args(args) 139 | 140 | log_level = getattr(logging, options.log_level.upper()) 141 | log_fmt = "%(levelname)s %(asctime)-15s %(name)s: %(message)s" 142 | logging.basicConfig(level=log_level, format=log_fmt) 143 | 144 | bind = options.bind 145 | if "://" not in bind: 146 | bind = "tcp://" + bind 147 | try: 148 | rpc = get_rpc() 149 | except KeyError: 150 | print("multivisor-rpc can only run as supervisor eventlistener", file=sys.stderr) 151 | exit(1) 152 | run(rpc, bind) 153 | 154 | 155 | if __name__ == "__main__": 156 | main() 157 | -------------------------------------------------------------------------------- /multivisor/server/tests/test_web.py: -------------------------------------------------------------------------------- 1 | import requests 2 | 3 | from tests.functions import assert_fields_in_object 4 | from tests.conftest import * 5 | 6 | 7 | @pytest.mark.usefixtures("api_base_url") 8 | def test_data_view(api_base_url): 9 | url = "{}/data".format(api_base_url) 10 | response = requests.get(url) 11 | assert response.status_code == 200 12 | data = response.json() 13 | assert_fields_in_object(["name", "supervisors"], data) 14 | assert "test001" in data["supervisors"] 15 | supervisor = data["supervisors"]["test001"] 16 | assert_fields_in_object( 17 | [ 18 | "processes", 19 | "name", 20 | "url", 21 | "pid", 22 | "running", 23 | "host", 24 | "version", 25 | "identification", 26 | "supervisor_version", 27 | "api_version", 28 | ], 29 | supervisor, 30 | ) 31 | 32 | assert supervisor["running"] 33 | processes = supervisor["processes"] 34 | for name, process in processes.items(): 35 | assert_fields_in_object( 36 | [ 37 | "stderr_logfile", 38 | "description", 39 | "statename", 40 | "pid", 41 | "stdout_logfile", 42 | "full_name", 43 | "supervisor", 44 | "logfile", 45 | "exitstatus", 46 | ], 47 | process, 48 | ) 49 | 50 | 51 | @pytest.mark.usefixtures("api_base_url") 52 | def test_config_view(api_base_url): 53 | url = "{}/config/file".format(api_base_url) 54 | response = requests.get(url) 55 | assert response.status_code == 200 56 | data = response.json() 57 | assert "content" in data 58 | 59 | 60 | @pytest.mark.usefixtures("api_base_url") 61 | def test_list_processes_view(api_base_url): 62 | url = "{}/process/list".format(api_base_url) 63 | response = requests.get(url) 64 | assert response.status_code == 200 65 | data = response.json() 66 | assert isinstance(data, list) 67 | assert len(data) == 10 68 | 69 | 70 | @pytest.mark.usefixtures("api_base_url") 71 | def test_process_info_view(api_base_url): 72 | uid = "test001:PLC:wcid00d" 73 | url = "{}/process/info/{}".format(api_base_url, uid) 74 | response = requests.get(url) 75 | assert response.status_code == 200 76 | process_data = response.json() 77 | keys = [ 78 | u"logfile", 79 | u"statename", 80 | u"group", 81 | u"description", 82 | u"pid", 83 | u"stderr_logfile", 84 | u"stop", 85 | u"running", 86 | u"name", 87 | u"start", 88 | u"state", 89 | u"spawnerr", 90 | u"full_name", 91 | u"host", 92 | u"supervisor", 93 | u"now", 94 | u"exitstatus", 95 | u"stdout_logfile", 96 | u"uid", 97 | ] 98 | 99 | assert_fields_in_object(keys, process_data) 100 | assert process_data["uid"] == uid 101 | assert process_data["supervisor"] == "test001" 102 | assert process_data["group"] == "PLC" 103 | assert process_data["name"] == "wcid00d" 104 | 105 | 106 | @pytest.mark.usefixtures("api_base_url") 107 | def test_supervisor_info_view(api_base_url): 108 | uid = "test001" 109 | url = "{}/supervisor/info/{}".format(api_base_url, uid) 110 | response = requests.get(url) 111 | assert response.status_code == 200 112 | supervisor_data = response.json() 113 | keys = [ 114 | u"processes", 115 | u"name", 116 | u"url", 117 | u"pid", 118 | u"running", 119 | u"host", 120 | u"version", 121 | u"identification", 122 | u"supervisor_version", 123 | u"api_version", 124 | ] 125 | 126 | assert_fields_in_object(keys, supervisor_data) 127 | assert supervisor_data["name"] == uid 128 | assert len(supervisor_data["processes"]) == 10 129 | 130 | 131 | @pytest.mark.usefixtures("api_base_url") 132 | def test_reload_view(api_base_url): 133 | url = "{}/admin/reload".format(api_base_url) 134 | response = requests.get(url) 135 | assert response.status_code == 200 136 | 137 | 138 | @pytest.mark.usefixtures("api_base_url") 139 | def test_refresh_view(api_base_url): 140 | url = "{}/refresh".format(api_base_url) 141 | response = requests.get(url) 142 | assert response.status_code == 200 143 | 144 | 145 | @pytest.mark.usefixtures("api_base_url") 146 | def test_stop_process_view(api_base_url, multivisor_instance): 147 | multivisor_instance.refresh() # processes are empty before calling this 148 | uid = "test001:PLC:wcid00d" 149 | process = multivisor_instance.get_process(uid) 150 | # assert process is currently running 151 | index, max_retries = 0, 10 152 | while not process["running"]: 153 | multivisor_instance.refresh() 154 | process = multivisor_instance.get_process(uid) 155 | sleep(0.5) 156 | if index == max_retries: 157 | raise AssertionError("Process {} is not running".format(uid)) 158 | index += 1 159 | 160 | # stop the process 161 | url = "{}/process/stop".format(api_base_url) 162 | response = requests.post(url, {"uid": uid}) 163 | assert response.status_code == 200 164 | 165 | # assert process is stopped 166 | index, max_retries = 0, 10 167 | while process["running"]: 168 | multivisor_instance.refresh() 169 | process = multivisor_instance.get_process(uid) 170 | sleep(0.5) 171 | if index == max_retries: 172 | raise AssertionError("Process {} is not stopped".format(uid)) 173 | index += 1 174 | 175 | 176 | @pytest.mark.usefixtures("api_base_url") 177 | def test_restart_process_view(api_base_url, multivisor_instance): 178 | multivisor_instance.refresh() # processes are empty before calling this 179 | uid = "test001:PLC:wcid00d" 180 | process = multivisor_instance.get_process(uid) 181 | # stop process if it's currently running 182 | if process["running"]: 183 | multivisor_instance.stop_processes(uid) 184 | assert not process["running"] 185 | 186 | # restart the process 187 | url = "{}/process/restart".format(api_base_url) 188 | response = requests.post(url, {"uid": uid}) 189 | assert response.status_code == 200 190 | 191 | # assert process is restarted 192 | multivisor_instance.refresh() 193 | process = multivisor_instance.get_process(uid) 194 | assert process["running"] 195 | -------------------------------------------------------------------------------- /multivisor/tests/test_multivisor.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | 3 | from tests.conftest import * 4 | from tests.functions import assert_fields_in_object 5 | import contextlib 6 | 7 | 8 | @pytest.mark.usefixtures("supervisor_test001") 9 | def test_supervisors_attr(multivisor_instance): 10 | supervisors = multivisor_instance.supervisors 11 | assert "test001" in supervisors 12 | 13 | 14 | @pytest.mark.usefixtures("supervisor_test001") 15 | def test_supervisor_info(multivisor_instance): 16 | supervisor = multivisor_instance.get_supervisor("test001") 17 | info = supervisor.read_info() 18 | assert_fields_in_object( 19 | [ 20 | "running", 21 | "host", 22 | "version", 23 | "identification", 24 | "name", 25 | "url", 26 | "supervisor_version", 27 | "pid", 28 | "processes", 29 | "api_version", 30 | ], 31 | info, 32 | ) 33 | assert info["running"] 34 | assert info["host"] == "localhost" 35 | assert len(info["processes"]) == 10 36 | assert info["name"] == "test001" 37 | assert info["identification"] == "supervisor" 38 | 39 | 40 | @pytest.mark.usefixtures("supervisor_test001") 41 | def test_supervisor_info_from_bytes(multivisor_instance): 42 | supervisor = multivisor_instance.get_supervisor("test001") 43 | 44 | @contextlib.contextmanager 45 | def patched_getAllProcessInfo(s): 46 | try: 47 | getAllProcessInfo = s.server.getAllProcessInfo 48 | 49 | def mockedAllProcessInfo(): 50 | processesInfo = getAllProcessInfo() 51 | for info in processesInfo: 52 | info[b"name"] = info.pop("name").encode("ascii") 53 | info[b"description"] = info.pop("description").encode("ascii") 54 | return processesInfo 55 | 56 | s.server.getAllProcessInfo = mockedAllProcessInfo 57 | yield 58 | finally: 59 | s.server.getAllProcessInfo = getAllProcessInfo 60 | 61 | # Mock getAllProcessInfo with binary data 62 | with patched_getAllProcessInfo(supervisor): 63 | info = supervisor.read_info() 64 | assert_fields_in_object( 65 | [ 66 | "running", 67 | "host", 68 | "version", 69 | "identification", 70 | "name", 71 | "url", 72 | "supervisor_version", 73 | "pid", 74 | "processes", 75 | "api_version", 76 | ], 77 | info, 78 | ) 79 | assert info["running"] 80 | assert info["host"] == "localhost" 81 | assert len(info["processes"]) == 10 82 | assert info["name"] == "test001" 83 | assert info["identification"] == "supervisor" 84 | 85 | 86 | @pytest.mark.usefixtures("supervisor_test001") 87 | def test_processes_attr(multivisor_instance): 88 | multivisor_instance.refresh() # processes are empty before calling this 89 | processes = multivisor_instance.processes 90 | assert len(processes) == 10 91 | assert "test001:PLC:wcid00d" in processes 92 | process = processes["test001:PLC:wcid00d"] 93 | assert_fields_in_object( 94 | [ 95 | "logfile", 96 | "supervisor", 97 | "description", 98 | "state", 99 | "pid", 100 | "stderr_logfile", 101 | "stop", 102 | "host", 103 | "statename", 104 | "name", 105 | "start", 106 | "running", 107 | "stdout_logfile", 108 | "full_name", 109 | "group", 110 | "now", 111 | "exitstatus", 112 | "spawnerr", 113 | "uid", 114 | ], 115 | process, 116 | ) 117 | assert process["supervisor"] == "test001" 118 | assert process["full_name"] == "PLC:wcid00d" 119 | assert process["name"] == "wcid00d" 120 | assert process["uid"] == "test001:PLC:wcid00d" 121 | assert process["group"] == "PLC" 122 | assert "tests/log/wcid00d.log" in process["logfile"] 123 | assert "tests/log/wcid00d.log" in process["stdout_logfile"] 124 | assert process["stderr_logfile"] == "" 125 | 126 | 127 | @pytest.mark.usefixtures("supervisor_test001") 128 | def test_get_process(multivisor_instance): 129 | multivisor_instance.refresh() # processes are empty before calling this 130 | uid = "test001:PLC:wcid00d" 131 | process = multivisor_instance.get_process(uid) 132 | assert process["supervisor"] == "test001" 133 | assert process["full_name"] == "PLC:wcid00d" 134 | assert process["name"] == "wcid00d" 135 | assert process["uid"] == "test001:PLC:wcid00d" 136 | assert process["group"] == "PLC" 137 | assert "tests/log/wcid00d.log" in process["logfile"] 138 | assert "tests/log/wcid00d.log" in process["stdout_logfile"] 139 | assert process["stderr_logfile"] == "" 140 | 141 | 142 | @pytest.mark.usefixtures("supervisor_test001") 143 | def test_use_authentication(multivisor_instance): 144 | assert not multivisor_instance.use_authentication 145 | 146 | 147 | @pytest.mark.usefixtures("supervisor_test001") 148 | def test_stop_process(multivisor_instance): 149 | multivisor_instance.refresh() # processes are empty before calling this 150 | uid = "test001:PLC:wcid00d" 151 | process = multivisor_instance.get_process(uid) 152 | print(process) 153 | index, max_retries = 0, 10 154 | while not process["running"]: # make sure process is running 155 | multivisor_instance.refresh() 156 | process = multivisor_instance.get_process(uid) 157 | sleep(0.5) 158 | if index == max_retries: 159 | raise AssertionError("Process {} is not running".format(uid)) 160 | index += 1 161 | 162 | multivisor_instance.stop_processes(uid) 163 | multivisor_instance.refresh() 164 | process = multivisor_instance.get_process(uid) 165 | assert not process["running"] 166 | 167 | 168 | @pytest.mark.usefixtures("supervisor_test001") 169 | def test_restart_process(multivisor_instance): 170 | multivisor_instance.refresh() # processes are empty before calling this 171 | uid = "test001:PLC:wcid00d" 172 | process = multivisor_instance.get_process(uid) 173 | if process["running"]: 174 | multivisor_instance.stop_processes(uid) 175 | 176 | multivisor_instance.restart_processes(uid) 177 | multivisor_instance.refresh() 178 | process = multivisor_instance.get_process(uid) 179 | assert process["running"] 180 | -------------------------------------------------------------------------------- /src/store/index.js: -------------------------------------------------------------------------------- 1 | import Vue from 'vue' 2 | import Vuex from 'vuex' 3 | import * as multivisor from '@/multivisor' 4 | 5 | Vue.use(Vuex) 6 | 7 | export default new Vuex.Store({ 8 | state: { 9 | multivisor: multivisor.nullMultivisor, 10 | error: '', 11 | notifications: [], 12 | selectedProcesses: [], 13 | search: '', 14 | log: { 15 | process: null, 16 | visible: false, 17 | stream: 'out' 18 | }, 19 | processDetails: { 20 | process: multivisor.nullProcess, 21 | visible: false 22 | }, 23 | isAuthenticated: undefined, 24 | useAuthentication: undefined 25 | }, 26 | mutations: { 27 | updateMultivisor (state, multivisor) { 28 | state.multivisor = multivisor 29 | }, 30 | updateProcess (state, process) { 31 | let supervisor = state.multivisor.supervisors[process.supervisor] 32 | supervisor.processes[process.uid] = process 33 | }, 34 | updateSupervisor (state, supervisor) { 35 | state.multivisor.supervisors[supervisor.name] = supervisor 36 | }, 37 | newNotification (state, notification) { 38 | state.notifications.push(notification) 39 | }, 40 | setLogVisible (state, visible) { 41 | state.log.visible = visible 42 | }, 43 | setLog (state, log) { 44 | state.log = log 45 | }, 46 | setSelectedProcesses (state, selectedProcesses) { 47 | state.selectedProcesses = selectedProcesses 48 | }, 49 | addSelectedProcesses (state, processes) { 50 | let toAdd = new Set([...state.selectedProcesses, ...processes]) 51 | state.selectedProcesses = [...toAdd] 52 | }, 53 | removeSelectedProcesses (state, processes) { 54 | let toRemove = new Set(processes) 55 | state.selectedProcesses = state.selectedProcesses.filter(process => !toRemove.has(process)) 56 | }, 57 | updateSearch (state, search) { 58 | state.search = search 59 | }, 60 | setProcessDetailsVisible (state, visible) { 61 | state.processDetails.visible = visible 62 | }, 63 | setProcessDetails (state, details) { 64 | state.processDetails = details 65 | }, 66 | setIsAuthenticated (state, isAuthenticated) { 67 | state.isAuthenticated = isAuthenticated 68 | }, 69 | setUseAuthentication (state, useAuthentication) { 70 | state.useAuthentication = useAuthentication 71 | }, 72 | logout (state) { 73 | state.isAuthenticated = false 74 | }, 75 | setError (state, error) { 76 | state.error = error 77 | }, 78 | setMultivisorError (state) { 79 | state.error = 'Couldn\'t connect to multivisor server, make sure it is running' 80 | } 81 | }, 82 | actions: { 83 | async init ({ commit }) { 84 | const response = await multivisor.load() 85 | if (response.status === 401) { 86 | return 87 | } else if (response.status === 504) { // server down 88 | commit('setMultivisorError') 89 | } else { 90 | const data = await response.json() 91 | commit('updateMultivisor', data) 92 | } 93 | const eventHandler = (event) => { 94 | if (event === 'error' || event === 'close') { 95 | commit('setMultivisorError') 96 | commit('updateMultivisor', multivisor.nullMultivisor) 97 | } else if (event.event === 'process_changed') { 98 | commit('updateProcess', event.payload) 99 | } else if (event.event === 'supervisor_changed') { 100 | commit('updateSupervisor', event.payload) 101 | } else if (event.event === 'notification') { 102 | commit('newNotification', event.payload) 103 | } 104 | } 105 | multivisor.streamTo(eventHandler) 106 | }, 107 | restartProcesses (context, uids) { 108 | multivisor.processAction(uids, 'restart') 109 | }, 110 | stopProcesses (context, uid) { 111 | multivisor.processAction(uid, 'stop') 112 | }, 113 | selectAll () { 114 | this.commit('setSelectedProcesses', [...this.getters.filteredProcessUIDs]) 115 | }, 116 | clearSelected () { 117 | this.commit('setSelectedProcesses', []) 118 | }, 119 | restartSelected () { 120 | this.dispatch('restartProcesses', this.state.selectedProcesses).then(() => { 121 | this.dispatch('clearSelected') 122 | }) 123 | }, 124 | stopSelected () { 125 | this.dispatch('stopProcesses', this.state.selectedProcesses).then(() => { 126 | this.dispatch('clearSelected') 127 | }) 128 | }, 129 | updateSupervisor (context, uid) { 130 | multivisor.supervisorAction(uid, 'update') 131 | }, 132 | restartSupervisor (context, uid) { 133 | multivisor.supervisorAction(uid, 'restart') 134 | }, 135 | logout () { 136 | this.commit('logout') 137 | fetch('/api/logout', {method: 'POST'}) 138 | } 139 | }, 140 | getters: { 141 | name (state) { 142 | return state.multivisor.name 143 | }, 144 | supervisors (state) { 145 | return Object.values(state.multivisor.supervisors) 146 | }, 147 | processes (state, getters) { 148 | return getters.supervisors.reduce((processes, supervisor) => { 149 | processes.push(...Object.values(supervisor.processes)) 150 | return processes 151 | }, []) 152 | }, 153 | groupMap (state, getters) { 154 | return getters.processes.reduce((groups, proc) => { 155 | (proc.group in groups && groups[proc.group].processes.push(proc)) || 156 | (groups[proc.group] = { name: proc.group, processes: [proc] }) 157 | return groups 158 | }, {}) 159 | }, 160 | groups (state, getters) { 161 | return Object.values(getters.groupMap) 162 | }, 163 | supervisor (state) { 164 | return (uid) => { return state.multivisor.supervisors[uid] } 165 | }, 166 | process (state, getters) { 167 | return (uid) => { 168 | return getters.processes.find((process) => { 169 | return process.uid === uid 170 | }) 171 | } 172 | }, 173 | group (state, getters) { 174 | return (name) => { return getters.groupMap[name] } 175 | }, 176 | filteredProcessUIDs (state, getters) { 177 | if (!state.search) { 178 | return new Set(getters.processes.map(process => process.uid)) 179 | } 180 | let search = state.search.toLowerCase() 181 | return getters.processes.reduce((filtered, process) => { 182 | if (process.uid.toLowerCase().indexOf(search) !== -1 || 183 | process.statename.toLowerCase().indexOf(search) !== -1) { 184 | filtered.add(process.uid) 185 | } 186 | return filtered 187 | }, new Set()) 188 | }, 189 | filteredGroupMap (state, getters) { 190 | if (!state.search) { 191 | return getters.groups 192 | } 193 | let filteredProcesses = getters.filteredProcessUIDs 194 | return getters.processes.reduce((groups, proc) => { 195 | if (filteredProcesses.has(proc.uid)) { 196 | (proc.group in groups && groups[proc.group].processes.push(proc)) || 197 | (groups[proc.group] = { name: proc.group, processes: [proc] }) 198 | } 199 | return groups 200 | }, {}) 201 | }, 202 | filteredGroups (state, getters) { 203 | return Object.values(getters.filteredGroupMap) 204 | }, 205 | totalNbProcesses (state, getters) { 206 | return getters.processes.length 207 | }, 208 | nbRunningProcesses (state, getters) { 209 | return getters.processes.reduce((acc, process) => { 210 | return process.running ? acc + 1 : acc 211 | }, 0) 212 | }, 213 | nbStoppedProcesses (state, getters) { 214 | return getters.totalNbProcesses - getters.nbRunningProcesses 215 | }, 216 | totalNbSupervisors (state, getters) { 217 | return getters.supervisors.length 218 | }, 219 | nbRunningSupervisors (state, getters) { 220 | return getters.supervisors.reduce((acc, supervisor) => { 221 | return supervisor.running ? acc + 1 : acc 222 | }, 0) 223 | }, 224 | nbStoppedSupervisors (state, getters) { 225 | return getters.totalNbSupervisors - getters.nbRunningSupervisors 226 | }, 227 | nbGroups (state, getters) { 228 | return getters.groups.length 229 | } 230 | } 231 | }) 232 | -------------------------------------------------------------------------------- /multivisor/client/repl.py: -------------------------------------------------------------------------------- 1 | import fnmatch 2 | import functools 3 | 4 | import maya 5 | from blinker import signal 6 | from prompt_toolkit import PromptSession, HTML, print_formatted_text 7 | from prompt_toolkit.application import run_in_terminal 8 | from prompt_toolkit.auto_suggest import AutoSuggestFromHistory 9 | from prompt_toolkit.completion import WordCompleter 10 | from prompt_toolkit.history import InMemoryHistory 11 | from prompt_toolkit.key_binding import KeyBindings 12 | from prompt_toolkit.styles import Style 13 | from prompt_toolkit.validation import ValidationError 14 | 15 | from multivisor.signals import SIGNALS 16 | from . import util 17 | 18 | STYLE = Style.from_dict( 19 | { 20 | "stopped": "ansired", 21 | "starting": "ansiblue", 22 | "running": "ansigreen", 23 | "backoff": "orange", 24 | "stopping": "ansiblue", 25 | "exited": "ansired bold", 26 | "fatal": "violet", 27 | "unknown": "grey", 28 | } 29 | ) 30 | 31 | NOTIF_STYLE = {"DEBUG": "grey", "INFO": "blue", "WARNING": "orange", "ERROR": "red"} 32 | 33 | 34 | def process_description(process): 35 | # TODO 36 | status = process["statename"] 37 | if status == "FATAL": 38 | return process["description"] 39 | elif process["running"]: 40 | start = maya.MayaDT(process["start"]) 41 | desc = "pid {pid}, started {start} ({delta})".format( 42 | pid=process["pid"], start=start.rfc2822(), delta=start.slang_time() 43 | ) 44 | else: 45 | stop = maya.MayaDT(process["stop"]) 46 | desc = "stopped on {stop} ({delta} ago)".format( 47 | stop=stop.rfc2822(), delta=stop.slang_time() 48 | ) 49 | return desc 50 | 51 | 52 | def process_status(process, max_puid_len=10, group_by="group"): 53 | state = process["statename"] 54 | uid = u"{{uid:{}}}".format(max_puid_len).format(uid=process["uid"]) 55 | desc = process_description(process) 56 | text = u"{p}{uid} <{lstate}>{state:8} {description}".format( 57 | p=("" if group_by in (None, "process") else " "), 58 | uid=uid, 59 | state=state, 60 | lstate=state.lower(), 61 | description=desc, 62 | ) 63 | return HTML(text) 64 | 65 | 66 | def processes_status(status, group_by="group", filter="*"): 67 | filt = lambda p: fnmatch.fnmatch(p["uid"], filter) 68 | return util.processes_status( 69 | status, group_by=group_by, process_filter=filt, process_status=process_status 70 | ) 71 | 72 | 73 | def print_processes_status(status, *args): 74 | kwargs = {} 75 | if args: 76 | kwargs["filter"] = args[0] 77 | for text in processes_status(status, **kwargs): 78 | print_formatted_text(text, style=STYLE) 79 | 80 | 81 | def cmd(f=None, name=None): 82 | if f is None: 83 | return functools.partial(cmd, name=name) 84 | name = name or f.__name__ 85 | f.__cmd__ = name.decode() if isinstance(name, bytes) else name 86 | return f 87 | 88 | 89 | class Commands(object): 90 | def __init__(self, multivisor): 91 | self.multivisor = multivisor 92 | 93 | @cmd(name="refresh-status") 94 | def refresh_status(self): 95 | """ 96 | refresh Refresh status (eq of Ctrl+F5 in browser) 97 | """ 98 | print_processes_status(self.multivisor.refresh_status()) 99 | 100 | @cmd 101 | def status(self, *args): 102 | """ 103 | status Status of all processes 104 | status Status of a pattern of processes 105 | """ 106 | print_processes_status(self.multivisor.status, *args) 107 | 108 | @cmd 109 | def restart(self, *args): 110 | """ 111 | restart * Restart a list of process patterns 112 | """ 113 | if not args: 114 | raise ValidationError(message="Need at least one process") 115 | self.multivisor.restart_processes(*args) 116 | 117 | @cmd 118 | def stop(self, *args): 119 | """ 120 | stop * Stop a list of process patterns 121 | """ 122 | if not args: 123 | raise ValidationError(message="Need at least one process") 124 | self.multivisor.stop_processes(*args) 125 | 126 | @cmd 127 | def help(self, *args): 128 | """ 129 | Available commands (type help ): 130 | ======================================= 131 | 132 | {cmds} 133 | """ 134 | if not args: 135 | args = ("help",) 136 | cmd = self.get_command(args[0]) 137 | cmds = " ".join(self.get_commands()) 138 | raw_text = cmd.__doc__.format(cmds=cmds) 139 | text = "\n".join(map(str.strip, raw_text.split("\n"))) 140 | print_formatted_text(text) 141 | 142 | @classmethod 143 | def get_commands(cls): 144 | result = {} 145 | for name in dir(cls): 146 | member = getattr(cls, name) 147 | cmd = getattr(member, "__cmd__", None) 148 | if cmd: 149 | result[cmd] = name 150 | return result 151 | 152 | def get_command(self, name): 153 | method_name = self.get_commands().get(name) 154 | if method_name is None: 155 | raise ValidationError(message="Unknown command '{}'".format(name)) 156 | return getattr(self, method_name) 157 | 158 | 159 | def Prompt(**kwargs): 160 | history = InMemoryHistory() 161 | auto_suggest = AutoSuggestFromHistory() 162 | prmpt = u"multivisor> " 163 | return PromptSession(prmpt, history=history, auto_suggest=auto_suggest, **kwargs) 164 | 165 | 166 | class Repl(object): 167 | 168 | keys = KeyBindings() 169 | 170 | def __init__(self, multivisor): 171 | self.multivisor = multivisor 172 | self.commands = Commands(multivisor) 173 | status = self.multivisor.status 174 | words = list(status["processes"].keys()) 175 | words.extend(self.commands.get_commands()) 176 | completer = WordCompleter(words) 177 | self.session = Prompt( 178 | completer=completer, bottom_toolbar=self.toolbar, key_bindings=self.keys 179 | ) 180 | self.session.app.commands = self.commands 181 | self.__update_toolbar() 182 | for signal_name in SIGNALS: 183 | signal(signal_name).connect(self.__update_toolbar) 184 | 185 | def __update_toolbar(self, *args, **kwargs): 186 | status = self.multivisor.status 187 | stats = status["stats"] 188 | s_stats, p_stats = stats["supervisors"], stats["processes"] 189 | notifications = self.multivisor.notifications 190 | if notifications: 191 | notif = notifications[-1] 192 | else: 193 | notif = dict(level="INFO", message="Welcome to multivisor CLI") 194 | html = ( 195 | u"{name} | Supervisors: {s[total]} (" 196 | u'/' 197 | u') ' 198 | u"| Processes: {p[total]} (" 199 | u'/' 200 | u') ' 201 | u'| '.format( 202 | name=status["name"], 203 | s=s_stats, 204 | p=p_stats, 205 | notif_color=NOTIF_STYLE[notif["level"]], 206 | notif_msg=notif["message"], 207 | ) 208 | ) 209 | self.__toolbar = HTML(html) 210 | self.session.app.invalidate() 211 | 212 | @keys.add(u"f5") 213 | def __on_refresh(self): 214 | run_in_terminal(self.app.commands.refresh_status()) 215 | 216 | def parse_command_line(self, text): 217 | args = text.split() 218 | cmd = self.commands.get_command(args[0]) 219 | return cmd, args[1:] 220 | 221 | def run_command_line(self, text): 222 | try: 223 | cmd, args = self.parse_command_line(text) 224 | cmd(*args) 225 | except KeyboardInterrupt: 226 | raise 227 | except Exception as err: 228 | print_formatted_text(HTML(u"Error: {}".format(err))) 229 | 230 | def toolbar(self): 231 | return self.__toolbar 232 | 233 | def run(self): 234 | self.commands.status() 235 | while True: 236 | try: 237 | text = self.session.prompt() 238 | if not text: 239 | continue 240 | self.run_command_line(text) 241 | except KeyboardInterrupt: 242 | continue 243 | except EOFError: 244 | break 245 | -------------------------------------------------------------------------------- /multivisor/rpc.py: -------------------------------------------------------------------------------- 1 | """ 2 | An extension to the standard supervisor RPC interface which subscribes 3 | to internal supervisor events and dispatches them to 0RPC. 4 | 5 | disadvantages: it depends on supervisor internal supervisor.events.subscribe 6 | interface so its usage is quite risky. 7 | advantages: it avoids creating an eventlistener process just to forward events. 8 | 9 | The python environment where supervisor runs must have multivisor installed 10 | """ 11 | 12 | import os 13 | import queue 14 | import logging 15 | import functools 16 | import threading 17 | 18 | from gevent import spawn, hub, sleep 19 | from gevent.queue import Queue 20 | from six import text_type 21 | from zerorpc import stream, Server, LostRemote, Context 22 | 23 | from supervisor.http import NOT_DONE_YET 24 | from supervisor.rpcinterface import SupervisorNamespaceRPCInterface 25 | from supervisor.events import subscribe, Event, getEventNameByType 26 | 27 | # unsubscribe only appears in supervisor > 3.3.4 28 | try: 29 | from supervisor.events import unsubscribe 30 | except: 31 | unsubscribe = lambda x, y: None 32 | 33 | from .util import sanitize_url, parse_obj 34 | 35 | DEFAULT_BIND = "tcp://*:9002" 36 | 37 | 38 | def sync(klass): 39 | def wrap_func(meth): 40 | @functools.wraps(meth) 41 | def wrapper(*args, **kwargs): 42 | args[0]._log.debug("0RPC: called {}".format(meth.__name__)) 43 | result = meth(*args, **kwargs) 44 | if callable(result): 45 | r = NOT_DONE_YET 46 | while r is NOT_DONE_YET: 47 | sleep(0.1) 48 | r = result() 49 | result = r 50 | return result 51 | 52 | return wrapper 53 | 54 | for name in dir(klass): 55 | if name.startswith("_") or name == "event_stream": 56 | continue 57 | meth = getattr(klass, name) 58 | if not callable(meth): 59 | continue 60 | setattr(klass, name, wrap_func(meth)) 61 | return klass 62 | 63 | 64 | # When supervisor is asked to restart, it closes file descriptors 65 | # from 5..1024. Since we are not able to restart the ZeroRPC server 66 | # (see https://github.com/0rpc/zerorpc-python/issues/208) this patch 67 | # prevents supervisor from closing the gevent pipes and 0MQ sockets 68 | # This is a really agressive move but seems to work until the above 69 | # bug is solved 70 | from supervisor.options import ServerOptions 71 | 72 | ServerOptions.cleanup_fds = lambda options: None 73 | 74 | 75 | @sync 76 | class MultivisorNamespaceRPCInterface(SupervisorNamespaceRPCInterface): 77 | def __init__(self, supervisord, bind): 78 | SupervisorNamespaceRPCInterface.__init__(self, supervisord) 79 | self._bind = bind 80 | self._channel = queue.Queue() 81 | self._event_channels = set() 82 | self._server = None 83 | self._watcher = None 84 | self._shutting_down = False 85 | self._log = logging.getLogger("MVRPC") 86 | 87 | def _start(self): 88 | subscribe(Event, self._handle_event) 89 | 90 | def _stop(self): 91 | unsubscribe(Event, self._handle_event) 92 | self._shutting_down = True 93 | 94 | def _shutdown(self): 95 | # disconnect all streams 96 | for channel in self._event_channels: 97 | channel.put(None) 98 | if self._server is not None: 99 | self._server.stop() 100 | self._server.close() 101 | 102 | def _process_event(self, event): 103 | if self._shutting_down: 104 | return 105 | event_name = getEventNameByType(event.__class__) 106 | stop_event = event_name == "SUPERVISOR_STATE_CHANGE_STOPPING" 107 | if stop_event: 108 | self._log.info("supervisor stopping!") 109 | self._stop() 110 | elif event_name.startswith("TICK"): 111 | return 112 | try: 113 | payload_str = text_type(event.payload()) 114 | except AttributeError: 115 | # old supervisor version 116 | payload_str = text_type(event) 117 | payload = dict((x.split(":") for x in payload_str.split())) 118 | if event_name.startswith("PROCESS_STATE"): 119 | pname = "{}:{}".format(payload["groupname"], payload["processname"]) 120 | payload[u"process"] = parse_obj(self.getProcessInfo(pname)) 121 | # broadcast the event to clients 122 | server = self.supervisord.options.identifier 123 | new_event = { 124 | u"pool": u"multivisor", 125 | u"server": text_type(server), 126 | u"eventname": text_type(event_name), 127 | u"payload": payload, 128 | } 129 | for channel in self._event_channels: 130 | channel.put(new_event) 131 | if stop_event: 132 | self._shutdown() 133 | 134 | # called on 0RPC server thread 135 | def _dispatch_event(self): 136 | while not self._channel.empty(): 137 | event = self._channel.get() 138 | self._process_event(event) 139 | 140 | # called on main thread 141 | def _handle_event(self, event): 142 | if self._server is None: 143 | reply = start_rpc_server(self, self._bind) 144 | if isinstance(reply, Exception): 145 | self._log.critical("severe 0RPC error: %s", reply) 146 | self._stop() 147 | self._shutdown() 148 | return 149 | self._server, self._watcher = reply 150 | self._channel.put(event) 151 | self._watcher.send() 152 | 153 | # handle stop synchronously 154 | event_name = getEventNameByType(event.__class__) 155 | if event_name == "SUPERVISOR_STATE_CHANGE_STOPPING": 156 | self._server._stop_event.wait() 157 | self._server = None 158 | self._watcher = None 159 | 160 | @stream 161 | def event_stream(self): 162 | self._log.info("client connected to stream") 163 | channel = Queue() 164 | self._event_channels.add(channel) 165 | try: 166 | yield "First event to trigger connection. Please ignore me!" 167 | for event in channel: 168 | if event is None: 169 | self._log.info("stop: closing client") 170 | return 171 | # self._log.info(event) 172 | yield event 173 | except LostRemote as e: 174 | self._log.info("remote end of stream disconnected") 175 | finally: 176 | self._event_channels.remove(channel) 177 | 178 | 179 | class ServerMiddleware(object): 180 | def server_after_exec(self, request_event, reply_event): 181 | if reply_event.args: 182 | reply_event._args = parse_obj(reply_event.args) 183 | 184 | 185 | def start_rpc_server(multivisor, bind): 186 | future_server = queue.Queue(1) 187 | th = threading.Thread( 188 | target=run_rpc_server, name="RPCServer", args=(multivisor, bind, future_server) 189 | ) 190 | th.daemon = True 191 | th.start() 192 | return future_server.get() 193 | 194 | 195 | def run_rpc_server(multivisor, bind, future_server): 196 | multivisor._log.info("0RPC: spawn server on {}...".format(os.getpid())) 197 | watcher = hub.get_hub().loop.async_() 198 | stop_event = threading.Event() 199 | watcher.start(lambda: spawn(multivisor._dispatch_event)) 200 | server = None 201 | try: 202 | context = Context() 203 | context.register_middleware(ServerMiddleware()) 204 | server = Server(multivisor, context=context) 205 | server._stop_event = stop_event 206 | server.bind(bind) 207 | future_server.put((server, watcher)) 208 | multivisor._log.info("0RPC: server running!") 209 | server.run() 210 | multivisor._log.info("0RPC: server stopped!") 211 | except Exception as err: 212 | future_server.put(err) 213 | finally: 214 | watcher.stop() 215 | del server 216 | # prevent reusage of this loop because supervisor closes all ports 217 | # when a restart happens. It actually doesn't help preventing a crash 218 | hub.get_hub().destroy(destroy_loop=True) 219 | multivisor._log.info("0RPC: server thread destroyed!") 220 | stop_event.set() 221 | 222 | 223 | def make_rpc_interface(supervisord, bind=DEFAULT_BIND): 224 | # Uncomment following lines to configure python standard logging 225 | # log_level = logging.INFO 226 | # log_fmt = '%(asctime)-15s %(levelname)s %(threadName)-8s %(name)s: %(message)s' 227 | # logging.basicConfig(level=log_level, format=log_fmt) 228 | 229 | url = sanitize_url(bind, protocol="tcp", host="*", port=9002) 230 | multivisor = MultivisorNamespaceRPCInterface(supervisord, url["url"]) 231 | multivisor._start() 232 | return multivisor 233 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Multivisor 2 | 3 | multivisor web on chrome desktop app 7 | 8 | 9 | [![Multivisor][pypi-version]](https://pypi.python.org/pypi/multivisor) 10 | [![Python Versions][pypi-python-versions]](https://pypi.python.org/pypi/multivisor) 11 | [![Pypi status][pypi-status]](https://pypi.python.org/pypi/multivisor) 12 | ![License][license] 13 | [![Build Status][build]](https://travis-ci.org/guy881/multivisor) 14 | 15 | A centralized supervisor UI (Web & CLI) 16 | 17 | * Processes status always up to date 18 | * Reactivity through asynchronous actions 19 | * Notifications when state changes 20 | * Mobile aware, SPA web page 21 | * Powerful filters 22 | * Interactive CLI 23 | * works on [supervisor](https://pypi.org/project/supervisor/) 24 | and [supervisor-win](https://pypi.org/project/supervisor-win/) 25 | 26 | Multivisor is comprised of 3 components: 27 | 28 | 1. **web server**: gathers information from all supervisors and provides a 29 | dashboard like UI to the entire system 30 | 1. **multivisor RPC**: an RPC extension to supervisor used to communicate 31 | between each supervisord and multivisor web server 32 | 1. **CLI**: an optional CLI which communicates with multivisor web server 33 | 34 | ## Installation and configuration 35 | 36 | The installation and configuration steps are exactly the same on Linux and 37 | Windows. 38 | 39 | Thanks to the [ESRF](https://esrf.eu) sponsorship, multivisor is able to work 40 | well with [supervisor-win](https://pypi.org/project/supervisor-win/). 41 | 42 | ### RPC 43 | 44 | The multivisor RPC must be installed in the same environment(s) as your 45 | supervisord instances. It can be installed on python environments ranging from 46 | 2.7 to 3.x. 47 | 48 | From within the same python environment as your supervisord process, type: 49 | 50 | ```bash 51 | pip install multivisor[rpc] 52 | ``` 53 | 54 | There are two options to configure multivisor RPC: 1) as an extra 55 | [rpcinterface](http://supervisord.org/configuration.html#rpcinterface-x-section-settings) 56 | to supervisord or 2) an [eventlistener](http://supervisord.org/configuration.html#eventlistener-x-section-settings) process managed by supervisord. 57 | 58 | The first option has the advantage of not requiring an extra process but it's 59 | implementation relies on internal supervisord details. Therefore, the multivisor 60 | author recommends using the 2nd approach. 61 | 62 | #### Option 1: rpcinterface 63 | 64 | Configure the multivisor rpc interface by adding the following lines 65 | to your *supervisord.conf*: 66 | 67 | ```ini 68 | [rpcinterface:multivisor] 69 | supervisor.rpcinterface_factory = multivisor.rpc:make_rpc_interface 70 | bind=*:9002 71 | ``` 72 | 73 | If no *bind* is given, it defaults to `*:9002`. 74 | 75 | Repeat the above procedure for every supervisor you have running. 76 | 77 | #### Option 2: eventlistener 78 | 79 | Configure the multivisor rpc interface by adding the following lines 80 | to your *supervisord.conf*: 81 | 82 | ```ini 83 | [eventlistener:multivisor-rpc] 84 | command=multivisor-rpc --bind 0:9002 85 | events=PROCESS_STATE,SUPERVISOR_STATE_CHANGE 86 | ``` 87 | 88 | If no *bind* is given, it defaults to `*:9002`. 89 | 90 | You are free to choose the event listener name. As a convention we propose 91 | `multivisor-rpc`. 92 | 93 | NB: Make sure that `multivisor-rpc` command is accessible or provide full PATH. 94 | 95 | Repeat the above procedure for every supervisor you have running. 96 | 97 | 98 | ### Web server 99 | 100 | The multivisor web server requires a python 3.x environment. It must be 101 | installed on a machine with a network access to the different supervisors. 102 | This is achieved with: 103 | 104 | ```bash 105 | pip install multivisor[web] 106 | ``` 107 | 108 | The web server is configured with a INI like configuration file 109 | (much like supervisor itself) that is passed as command line argument. 110 | It is usually named *multivisor.conf* but can be any filename you which. 111 | 112 | The file consists of a `global` section where you can give an optional name to 113 | your multivisor instance (default is *multivisor*. This name will appear on the 114 | top left corner of multivisor the web page). 115 | 116 | To add a new supervisor to the list simply add a section `[supervisor:]`. 117 | It accepts an optional `url` in the format `[][:]`. The default 118 | is `:9002`. 119 | 120 | Here is an example: 121 | 122 | ```ini 123 | [global] 124 | name=ACME 125 | 126 | [supervisor:roadrunner] 127 | # since no url is given it will be roadrunner:9002 128 | 129 | [supervisor:coyote] 130 | # no host is given: defaults to coyote 131 | url=:9011 132 | 133 | [supervisor:bugsbunny] 134 | # no port is given: defaults to 9002 135 | url=bugsbunny.acme.org 136 | 137 | [supervisor:daffyduck] 138 | url=daffyduck.acme.org:9007 139 | ``` 140 | 141 | multivisor web on mobile 145 | 146 | Once installed and configured, the web server can be started from the command 147 | line with: 148 | 149 | ```bash 150 | multivisor -c ./multivisor.conf 151 | ``` 152 | 153 | Start a browser pointing to [localhost:22000](http://localhost:22000). 154 | On a mobile device it should look something like the figure on the right. 155 | 156 | Of course the multivisor web server itself can be configured in supervisor as a 157 | normal program. 158 | 159 | #### Authentication 160 | 161 | To protect multivisor from unwanted access, you can enable authentication. 162 | 163 | Specify `username` and `password` parameters in `global` section of your configuration file e.g.: 164 | 165 | ```ini 166 | [global] 167 | username=test 168 | password=test 169 | ``` 170 | 171 | You can also specify `password` as SHA-1 hash in hex, with `{SHA}` prefix: e.g. 172 | `{SHA}a94a8fe5ccb19ba61c4c0873d391e987982fbbd3` (example hash is `test` in SHA-1). 173 | 174 | In order to use authentication, you also need to set `MULTIVISOR_SECRET_KEY` environmental variable, 175 | as flask sessions module needs some secret value to create secure session. 176 | You can generate some random hash easily using python: 177 | `python -c 'import os; import binascii; print(binascii.hexlify(os.urandom(32)))'` 178 | 179 | ### CLI 180 | 181 | The multivisor CLI is an optional component which can be installed with: 182 | 183 | ```bash 184 | pip install multivisor[cli] 185 | ``` 186 | 187 | The CLI connects directly to the web server using an HTTP REST API. 188 | It doesn't require any configuration. 189 | 190 | It can be started with: 191 | 192 | ```bash 193 | multivisor-cli --url localhost:22000 194 | ``` 195 | 196 | ![CLI in action](doc/cli.svg) 197 | 198 | # Running the docker demo 199 | 200 | ```bash 201 | $ docker-compose build --parallel 202 | $ docker-compose up 203 | ``` 204 | 205 | That's it! 206 | 207 | Start a browser pointing to [localhost:22000](http://localhost:22000). 208 | 209 | # Running the example from scratch 210 | 211 | ```bash 212 | # Fetch the project: 213 | git clone https://github.com/tiagocoutinho/multivisor 214 | cd multivisor 215 | 216 | 217 | # Install frontend dependencies 218 | npm install 219 | # Build for production with minification 220 | npm run build 221 | 222 | # feel free to use your favorite python virtual environment 223 | # here. Otherwise you will need administrative privileges 224 | pip install .[all] 225 | 226 | # Launch a few supervisors 227 | mkdir examples/full_example/log 228 | supervisord -c examples/full_example/supervisord_lid001.conf 229 | supervisord -c examples/full_example/supervisord_lid002.conf 230 | supervisord -c examples/full_example/supervisord_baslid001.conf 231 | 232 | # Finally, launch multivisor: 233 | multivisor -c examples/full_example/multivisor.conf 234 | ``` 235 | 236 | That's it! 237 | 238 | Start a browser pointing to [localhost:22000](http://localhost:22000). On a mobile 239 | device it should look something like this: 240 | 241 | ![multivisor on mobile](doc/multivisor_mobile.png) 242 | 243 | # Technologies 244 | 245 | ![multivisor diagram](doc/diagram.png) 246 | 247 | The `multivisor` backend runs a [flask](http://flask.pocoo.org/) web server. 248 | 249 | The `multivisor-cli` runs a 250 | [prompt-toolkit](http://python-prompt-toolkit.rtfd.io) based console. 251 | 252 | The frontend is based on [vue](https://vuejs.org/) + 253 | [vuex](https://vuex.vuejs.org/) + [vuetify](https://vuetifyjs.com/). 254 | 255 | # Development 256 | 257 | ## Build & Install 258 | 259 | ```bash 260 | 261 | # install frontend 262 | npm install 263 | 264 | # build for production with minification 265 | npm run build 266 | 267 | # install backend 268 | pip install -e . 269 | 270 | ``` 271 | 272 | ## Run 273 | 274 | ```bash 275 | # serve at localhost:22000 276 | multivisor -c multivisor.conf 277 | ``` 278 | 279 | Start a browser pointing to [localhost:22000](http://localhost:22000) 280 | 281 | ## Development mode 282 | 283 | You can run the backend using the webpack dev server to facilitate your 284 | development cycle: 285 | 286 | First, start multivisor (which listens on 22000 by default): 287 | 288 | ```bash 289 | python -m multivisor.server.web -c multivisor.conf 290 | ``` 291 | 292 | Now, in another console, run the webpack dev server (it will 293 | transfer the requests between the browser and multivisor): 294 | 295 | ``` bash 296 | npm run dev 297 | ``` 298 | 299 | That's it. If you modify `App.vue` for example, you should see the changes 300 | directly on your browser. 301 | 302 | 303 | [pypi-python-versions]: https://img.shields.io/pypi/pyversions/multivisor.svg 304 | [pypi-version]: https://img.shields.io/pypi/v/multivisor.svg 305 | [pypi-status]: https://img.shields.io/pypi/status/multivisor.svg 306 | [license]: https://img.shields.io/pypi/l/multivisor.svg 307 | [build]: https://travis-ci.org/guy881/multivisor.svg?branch=develop 308 | -------------------------------------------------------------------------------- /multivisor/server/web.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import functools 3 | 4 | import gevent 5 | from blinker import signal 6 | from gevent.monkey import patch_all 7 | 8 | patch_all(thread=False) 9 | 10 | import os 11 | import logging 12 | 13 | from gevent import queue, sleep 14 | from gevent.pywsgi import WSGIServer 15 | from flask import Flask, render_template, Response, request, json, jsonify, session 16 | from werkzeug.debug import DebuggedApplication 17 | from werkzeug.serving import run_simple 18 | 19 | from multivisor.signals import SIGNALS 20 | from multivisor.util import sanitize_url 21 | from multivisor.multivisor import Multivisor 22 | from .util import is_login_valid, login_required 23 | 24 | 25 | log = logging.getLogger("multivisor") 26 | 27 | app = Flask(__name__, static_folder="./dist/static", template_folder="./dist") 28 | 29 | 30 | @app.route("/api/admin/reload") 31 | @login_required(app) 32 | def reload(): 33 | app.multivisor.reload() 34 | return "OK" 35 | 36 | 37 | @app.route("/api/refresh") 38 | @login_required(app) 39 | def refresh(): 40 | app.multivisor.refresh() 41 | return jsonify(app.multivisor.safe_config) 42 | 43 | 44 | @app.route("/api/data") 45 | @login_required(app) 46 | def data(): 47 | return jsonify(app.multivisor.safe_config) 48 | 49 | 50 | @app.route("/api/config/file") 51 | @login_required(app) 52 | def config_file_content(): 53 | content = app.multivisor.config_file_content 54 | return jsonify(dict(content=content)) 55 | 56 | 57 | @app.route("/api/supervisor/update", methods=["POST"]) 58 | @login_required(app) 59 | def update_supervisor(): 60 | names = ( 61 | str.strip(supervisor) for supervisor in request.form["supervisor"].split(",") 62 | ) 63 | app.multivisor.update_supervisors(*names) 64 | return "OK" 65 | 66 | 67 | @app.route("/api/supervisor/restart", methods=["POST"]) 68 | @login_required(app) 69 | def restart_supervisor(): 70 | names = ( 71 | str.strip(supervisor) for supervisor in request.form["supervisor"].split(",") 72 | ) 73 | app.multivisor.restart_supervisors(*names) 74 | return "OK" 75 | 76 | 77 | @app.route("/api/supervisor/reread", methods=["POST"]) 78 | @login_required(app) 79 | def reread_supervisor(): 80 | names = ( 81 | str.strip(supervisor) for supervisor in request.form["supervisor"].split(",") 82 | ) 83 | app.multivisor.reread_supervisors(*names) 84 | return "OK" 85 | 86 | 87 | @app.route("/api/supervisor/shutdown", methods=["POST"]) 88 | @login_required(app) 89 | def shutdown_supervisor(): 90 | names = ( 91 | str.strip(supervisor) for supervisor in request.form["supervisor"].split(",") 92 | ) 93 | app.multivisor.shutdown_supervisors(*names) 94 | return "OK" 95 | 96 | 97 | @app.route("/api/process/restart", methods=["POST"]) 98 | @login_required(app) 99 | def restart_process(): 100 | patterns = request.form["uid"].split(",") 101 | procs = app.multivisor.restart_processes(*patterns) 102 | return "OK" 103 | 104 | 105 | @app.route("/api/process/stop", methods=["POST"]) 106 | @login_required(app) 107 | def stop_process(): 108 | patterns = request.form["uid"].split(",") 109 | app.multivisor.stop_processes(*patterns) 110 | return "OK" 111 | 112 | 113 | @app.route("/api/process/list") 114 | @login_required(app) 115 | def list_processes(): 116 | return jsonify(tuple(app.multivisor.processes.keys())) 117 | 118 | 119 | @app.route("/api/process/info/") 120 | @login_required(app) 121 | def process_info(uid): 122 | process = app.multivisor.get_process(uid) 123 | process.refresh() 124 | return json.dumps(process) 125 | 126 | 127 | @app.route("/api/supervisor/info/") 128 | @login_required(app) 129 | def supervisor_info(uid): 130 | supervisor = app.multivisor.get_supervisor(uid) 131 | supervisor.refresh() 132 | return json.dumps(supervisor) 133 | 134 | 135 | @app.route("/api/process/log//tail/") 136 | @login_required(app) 137 | def process_log_tail(stream, uid): 138 | sname, pname = uid.split(":", 1) 139 | supervisor = app.multivisor.get_supervisor(sname) 140 | server = supervisor.server 141 | if stream == "out": 142 | tail = server.tailProcessStdoutLog 143 | else: 144 | tail = server.tailProcessStderrLog 145 | 146 | def event_stream(): 147 | i, offset, length = 0, 0, 2 ** 12 148 | while True: 149 | data = tail(pname, offset, length) 150 | log, offset, overflow = data 151 | # don't care about overflow in first log message 152 | if overflow and i: 153 | length = min(length * 2, 2 ** 14) 154 | else: 155 | data = json.dumps(dict(message=log, size=offset)) 156 | yield "data: {}\n\n".format(data) 157 | sleep(1) 158 | i += 1 159 | 160 | return Response(event_stream(), mimetype="text/event-stream") 161 | 162 | 163 | @app.route("/api/login", methods=["post"]) 164 | def login(): 165 | if not app.multivisor.use_authentication: 166 | return "Authentication is not required" 167 | username = request.form.get("username") 168 | password = request.form.get("password") 169 | if is_login_valid(app, username, password): 170 | session["username"] = username 171 | return json.dumps({}) 172 | else: 173 | response_data = {"errors": {"password": "Invalid username or password"}} 174 | return json.dumps(response_data), 400 175 | 176 | 177 | @app.route("/api/auth", methods=["get"]) 178 | def auth(): 179 | response_data = { 180 | "use_authentication": app.multivisor.use_authentication, 181 | "is_authenticated": "username" in session, 182 | } 183 | return json.dumps(response_data) 184 | 185 | 186 | @app.route("/api/logout", methods=["post"]) 187 | def logout(): 188 | session.clear() 189 | return json.dumps({}) 190 | 191 | 192 | @app.route("/api/stream") 193 | @login_required(app) 194 | def stream(): 195 | def event_stream(): 196 | client = queue.Queue() 197 | app.dispatcher.add_listener(client) 198 | for event in client: 199 | yield event 200 | app.dispatcher.remove_listener(client) 201 | 202 | return Response(event_stream(), mimetype="text/event-stream") 203 | 204 | 205 | @app.route("/", defaults={"path": ""}) 206 | @app.route("/") 207 | def catch_all(path): 208 | return render_template("index.html") 209 | 210 | 211 | class Dispatcher(object): 212 | def __init__(self): 213 | self.clients = [] 214 | for signal_name in SIGNALS: 215 | signal(signal_name).connect(self.on_multivisor_event) 216 | 217 | def add_listener(self, client): 218 | self.clients.append(client) 219 | 220 | def remove_listener(self, client): 221 | self.clients.remove(client) 222 | 223 | def on_multivisor_event(self, signal, payload): 224 | data = json.dumps(dict(payload=payload, event=signal)) 225 | event = "data: {0}\n\n".format(data) 226 | for client in self.clients: 227 | client.put(event) 228 | 229 | 230 | def set_secret_key(): 231 | """ 232 | In order to use flask sessions, secret_key must be set, 233 | require "MULTIVISOR_SECRET_KEY" env variable only if 234 | login and password is set in multivisor config 235 | You can generate secret by invoking: 236 | python -c 'import os; import binascii; print(binascii.hexlify(os.urandom(32)))' 237 | """ 238 | if app.multivisor.use_authentication: 239 | secret_key = os.environ.get("MULTIVISOR_SECRET_KEY") 240 | if not secret_key: 241 | raise Exception( 242 | '"MULTIVISOR_SECRET_KEY" environmental variable must be set ' 243 | "when authentication is enabled" 244 | ) 245 | app.secret_key = secret_key 246 | 247 | 248 | @app.errorhandler(401) 249 | def custom_401(error): 250 | response_data = {"message": "Authenthication is required to access this endpoint"} 251 | return Response( 252 | json.dumps(response_data), 401, {"content-type": "application/json"} 253 | ) 254 | 255 | 256 | def run_with_reloader_if_debug(func): 257 | @functools.wraps(func) 258 | def wrapper_login_required(*args, **kwargs): 259 | if not app.debug: 260 | return func(*args, **kwargs) 261 | return run_simple(func, *args, **kwargs, use_reloader=True) 262 | 263 | return wrapper_login_required 264 | 265 | 266 | def get_parser(args): 267 | import argparse 268 | 269 | parser = argparse.ArgumentParser() 270 | parser.add_argument( 271 | "--bind", help="[host][:port] (default: *:22000)", default="*:22000" 272 | ) 273 | parser.add_argument( 274 | "-c", 275 | help="configuration file", 276 | dest="config_file", 277 | default="/etc/multivisor.conf", 278 | ) 279 | parser.add_argument( 280 | "--log-level", 281 | help="log level", 282 | type=str, 283 | default="INFO", 284 | choices=["DEBUG", "INFO", "WARN", "ERROR"], 285 | ) 286 | return parser 287 | 288 | 289 | @run_with_reloader_if_debug 290 | def main(args=None): 291 | parser = get_parser(args) 292 | options = parser.parse_args(args) 293 | 294 | log_level = getattr(logging, options.log_level.upper()) 295 | log_fmt = "%(levelname)s %(asctime)-15s %(name)s: %(message)s" 296 | logging.basicConfig(level=log_level, format=log_fmt) 297 | 298 | if not os.path.exists(options.config_file): 299 | parser.exit( 300 | status=2, message="configuration file does not exist. Bailing out!\n" 301 | ) 302 | 303 | bind = sanitize_url(options.bind, host="*", port=22000)["url"] 304 | 305 | app.dispatcher = Dispatcher() 306 | app.multivisor = Multivisor(options) 307 | 308 | if app.multivisor.use_authentication: 309 | secret_key = os.environ.get("MULTIVISOR_SECRET_KEY") 310 | if not secret_key: 311 | raise Exception( 312 | '"MULTIVISOR_SECRET_KEY" environmental variable must be set ' 313 | "when authentication is enabled" 314 | ) 315 | app.secret_key = secret_key 316 | 317 | application = DebuggedApplication(app, evalex=True) if app.debug else app 318 | http_server = WSGIServer(bind, application=application) 319 | logging.info("Start accepting requests") 320 | try: 321 | http_server.serve_forever() 322 | except KeyboardInterrupt: 323 | log.info("Ctrl-C pressed. Bailing out") 324 | 325 | 326 | if __name__ == "__main__": 327 | main() 328 | -------------------------------------------------------------------------------- /multivisor/multivisor.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import copy 3 | import logging 4 | import os 5 | import time 6 | import weakref 7 | 8 | from blinker import signal 9 | 10 | try: 11 | from ConfigParser import SafeConfigParser as ConfigParser 12 | except ImportError: 13 | from configparser import ConfigParser 14 | 15 | import zerorpc 16 | from gevent import spawn, sleep, joinall 17 | from supervisor.xmlrpc import Faults 18 | from supervisor.states import RUNNING_STATES 19 | 20 | from .util import sanitize_url, filter_patterns, parse_dict 21 | 22 | log = logging.getLogger("multivisor") 23 | 24 | 25 | class Supervisor(dict): 26 | 27 | Null = { 28 | "identification": None, 29 | "api_version": None, 30 | "version": None, 31 | "supervisor_version": None, 32 | "processes": {}, 33 | "running": False, 34 | "pid": None, 35 | } 36 | 37 | def __init__(self, name, url): 38 | super(Supervisor, self).__init__(self.Null) 39 | self.name = self["name"] = name 40 | self.url = self["url"] = url 41 | self.log = log.getChild(name) 42 | addr = sanitize_url(url, protocol="tcp", host=name, port=9002) 43 | self.address = addr["url"] 44 | self.host = self["host"] = addr["host"] 45 | self.server = zerorpc.Client(self.address) 46 | # fill supervisor info before events start coming in 47 | self.event_loop = spawn(self.run) 48 | 49 | def __repr__(self): 50 | return "{}(name={})".format(self.__class__.__name__, self.name) 51 | 52 | def __eq__(self, other): 53 | this, other = dict(self), dict(other) 54 | this_p = this.pop("processes") 55 | other_p = other.pop("processes") 56 | return this == other and list(this_p.keys()) == list(other_p.keys()) 57 | 58 | def run(self): 59 | last_retry = time.time() 60 | while True: 61 | try: 62 | self.log.info("(re)initializing...") 63 | self.refresh() 64 | for i, event in enumerate(self.server.event_stream()): 65 | # ignore first event. It serves only to trigger 66 | # connection and avoid TimeoutExpired 67 | if i != 0: 68 | self.handle_event(event) 69 | except zerorpc.LostRemote: 70 | self.log.info("Lost remote") 71 | except zerorpc.TimeoutExpired: 72 | self.log.info("Timeout expired") 73 | except Exception as err: 74 | self.log.warning("Unexpected error %r", err) 75 | finally: 76 | curr_time = time.time() 77 | delta = curr_time - last_retry 78 | if delta < 10: 79 | sleep(10 - delta) 80 | last_retry = time.time() 81 | 82 | def handle_event(self, event): 83 | name = event["eventname"] 84 | self.log.info("handling %s...", name) 85 | if name.startswith("SUPERVISOR_STATE"): 86 | self.refresh() 87 | elif not self["running"]: 88 | self.refresh() 89 | elif name.startswith("PROCESS_GROUP"): 90 | self.refresh() 91 | elif name.startswith("PROCESS_STATE"): 92 | payload = event["payload"] 93 | puid = "{}:{}:{}".format( 94 | self.name, payload["groupname"], payload["processname"] 95 | ) 96 | self["processes"][puid].handle_event(event) 97 | 98 | def create_base_info(self): 99 | return dict(self.Null, name=self.name, url=self.url, host=self.host) 100 | 101 | def read_info(self): 102 | info = self.create_base_info() 103 | server = self.server 104 | info["pid"] = server.getPID() 105 | info["running"] = True 106 | info["identification"] = server.getIdentification() 107 | info["api_version"] = server.getAPIVersion() 108 | info["supervisor_version"] = server.getSupervisorVersion() 109 | info["processes"] = processes = {} 110 | procInfo = server.getAllProcessInfo() 111 | for proc in procInfo: 112 | process = Process(self, parse_dict(proc)) 113 | processes[process["uid"]] = process 114 | return info 115 | 116 | def update_info(self, info): 117 | info = parse_dict(info) 118 | if self == info: 119 | this_p, info_p = self["processes"], info["processes"] 120 | if this_p != info_p: 121 | for name, process in info_p.items(): 122 | if process != this_p[name]: 123 | send(process, "process_changed") 124 | self.update(info) 125 | else: 126 | self.update(info) 127 | send(self, "supervisor_changed") 128 | 129 | def refresh(self): 130 | try: 131 | info = self.read_info() 132 | except: 133 | info = self.create_base_info() 134 | raise 135 | finally: 136 | self.update_info(info) 137 | 138 | def update_server(self, group_names=()): 139 | server = self.server 140 | try: 141 | added, changed, removed = server.reloadConfig()[0] 142 | except zerorpc.RemoteError as rerr: 143 | error(rerr.msg) 144 | return 145 | 146 | # If any gnames are specified we need to verify that they are 147 | # valid in order to print a useful error message. 148 | if group_names: 149 | groups = set() 150 | for info in server.getAllProcessInfo(): 151 | groups.add(info["group"]) 152 | # New gnames would not currently exist in this set so 153 | # add those as well. 154 | groups.update(added) 155 | 156 | for gname in group_names: 157 | if gname not in groups: 158 | self.log.debug("unknown group %s", gname) 159 | 160 | for gname in removed: 161 | if group_names and gname not in group_names: 162 | continue 163 | results = server.stopProcessGroup(gname) 164 | self.log.debug("stopped process group %s", gname) 165 | 166 | fails = [res for res in results if res["status"] == Faults.FAILED] 167 | if fails: 168 | self.log.debug("%s as problems; not removing", gname) 169 | continue 170 | server.removeProcessGroup(gname) 171 | self.log.debug("removed process group %s", gname) 172 | 173 | for gname in changed: 174 | if group_names and gname not in group_names: 175 | continue 176 | server.stopProcessGroup(gname) 177 | self.log.debug("stopped process group %s", gname) 178 | 179 | server.removeProcessGroup(gname) 180 | server.addProcessGroup(gname) 181 | self.log.debug("updated process group %s", gname) 182 | 183 | for gname in added: 184 | if group_names and gname not in group_names: 185 | continue 186 | server.addProcessGroup(gname) 187 | self.log.debug("added process group %s", gname) 188 | 189 | self.log.info("Updated %s", self.name) 190 | 191 | def _reread(self): 192 | return self.server.reloadConfig() 193 | 194 | def restart(self): 195 | # do a reread. If there is an error (bad config) inform the user and 196 | # and refuse to restart 197 | try: 198 | self._reread() 199 | except zerorpc.RemoteError as rerr: 200 | error("Cannot restart: {}".format(rerr.msg)) 201 | return 202 | result = self.server.restart(timeout=30) 203 | if result: 204 | info("Restarted {}".format(self.name)) 205 | else: 206 | error("Error restarting {}".format(self.name)) 207 | 208 | def reread(self): 209 | try: 210 | added, changed, removed = self._reread()[0] 211 | except zerorpc.RemoteError as rerr: 212 | error(rerr.msg) 213 | else: 214 | info( 215 | "Reread config of {} " 216 | "({} added; {} changed; {} disappeared)".format( 217 | self.name, len(added), len(changed), len(removed) 218 | ) 219 | ) 220 | 221 | def shutdown(self): 222 | result = self.server.shutdown() 223 | if result: 224 | info("Shut down {}".format(self.name)) 225 | else: 226 | error("Error shutting down {}".format(self.name)) 227 | 228 | 229 | class Process(dict): 230 | 231 | Null = {"running": False, "pid": None, "state": None, "statename": "UNKNOWN"} 232 | 233 | def __init__(self, supervisor, *args, **kwargs): 234 | super(Process, self).__init__(self.Null) 235 | if args: 236 | self.update(args[0]) 237 | self.update(kwargs) 238 | supervisor_name = supervisor["name"] 239 | full_name = self.get("group", "") + ":" + self.get("name", "") 240 | uid = "{}:{}".format(supervisor_name, full_name) 241 | self.log = log.getChild(uid) 242 | self.supervisor = weakref.proxy(supervisor) 243 | self["full_name"] = full_name 244 | self["running"] = self["state"] in RUNNING_STATES 245 | self["supervisor"] = supervisor_name 246 | self["host"] = supervisor["host"] 247 | self["uid"] = uid 248 | 249 | @property 250 | def server(self): 251 | return self.supervisor.server 252 | 253 | @property 254 | def full_name(self): 255 | return self["full_name"] 256 | 257 | def handle_event(self, event): 258 | event_name = event["eventname"] 259 | if event_name.startswith("PROCESS_STATE"): 260 | payload = event["payload"] 261 | proc_info = payload.get("process") 262 | if proc_info is not None: 263 | proc_info = parse_dict(proc_info) 264 | old = self.update_info(proc_info) 265 | if old != self: 266 | old_state, new_state = old["statename"], self["statename"] 267 | send(self, event="process_changed") 268 | if old_state != new_state: 269 | info( 270 | "{} changed from {} to {}".format( 271 | self, old_state, new_state 272 | ) 273 | ) 274 | 275 | def read_info(self): 276 | proc_info = dict(self.Null) 277 | try: 278 | from_serv = parse_dict(self.server.getProcessInfo(self.full_name)) 279 | proc_info.update(from_serv) 280 | except Exception as err: 281 | self.log.warn("Failed to read info from %s: %s", self["uid"], err) 282 | return proc_info 283 | 284 | def update_info(self, proc_info): 285 | old = dict(self) 286 | proc_info["running"] = proc_info["state"] in RUNNING_STATES 287 | self.update(proc_info) 288 | return old 289 | 290 | def refresh(self): 291 | proc_info = self.read_info() 292 | proc_info = parse_dict(proc_info) 293 | self.update_info(proc_info) 294 | 295 | def start(self): 296 | try: 297 | self.server.startProcess(self.full_name, False, timeout=30) 298 | except: 299 | message = "Error trying to start {}!".format(self) 300 | error(message) 301 | self.log.exception(message) 302 | 303 | def stop(self): 304 | try: 305 | self.server.stopProcess(self.full_name) 306 | except: 307 | message = "Failed to stop {}".format(self["uid"]) 308 | warning(message) 309 | self.log.exception(message) 310 | 311 | def restart(self): 312 | if self["running"]: 313 | self.stop() 314 | self.start() 315 | 316 | def __str__(self): 317 | return "{0} on {1}".format(self["name"], self["supervisor"]) 318 | 319 | def __eq__(self, proc): 320 | p1, p2 = dict(self), dict(proc) 321 | p1.pop("description") 322 | p1.pop("now") 323 | p2.pop("description") 324 | p2.pop("now") 325 | return p1 == p2 326 | 327 | def __ne__(self, proc): 328 | return not self == proc 329 | 330 | 331 | # Configuration 332 | 333 | 334 | def load_config(config_file): 335 | parser = ConfigParser() 336 | parser.read(config_file) 337 | dft_global = dict(name="multivisor") 338 | 339 | supervisors = {} 340 | config = dict(dft_global, supervisors=supervisors) 341 | config.update(parser.items("global")) 342 | tasks = [] 343 | for section in parser.sections(): 344 | if not section.startswith("supervisor:"): 345 | continue 346 | name = section[len("supervisor:") :] 347 | section_items = dict(parser.items(section)) 348 | url = section_items.get("url", "") 349 | supervisors[name] = Supervisor(name, url) 350 | return config 351 | 352 | 353 | def send(payload, event): 354 | event_signal = signal(event) 355 | return event_signal.send(event, payload=payload) 356 | 357 | 358 | def notification(message, level): 359 | payload = dict(message=message, level=level, time=time.time()) 360 | send(payload, "notification") 361 | 362 | 363 | def info(message): 364 | notification(message, "INFO") 365 | 366 | 367 | def warning(message): 368 | logging.warning(message) 369 | notification(message, "WARNING") 370 | 371 | 372 | def error(message): 373 | logging.error(message) 374 | notification(message, "ERROR") 375 | 376 | 377 | class Multivisor(object): 378 | def __init__(self, options): 379 | self.options = options 380 | self.reload() 381 | 382 | @property 383 | def config(self): 384 | if self._config is None: 385 | self._config = load_config(self.options.config_file) 386 | return self._config 387 | 388 | @property 389 | def safe_config(self): 390 | """ 391 | :return: config dict without username and password 392 | """ 393 | if not self.use_authentication: 394 | return self.config 395 | 396 | config = copy.copy(self.config) 397 | config.pop("username", "") 398 | config.pop("password", "") 399 | return config 400 | 401 | @property 402 | def config_file_content(self): 403 | with open(self.options.config_file) as config_file: 404 | return config_file.read() 405 | 406 | def reload(self): 407 | self._config = None 408 | return self.config 409 | 410 | @property 411 | def supervisors(self): 412 | return self.config["supervisors"] 413 | 414 | @property 415 | def processes(self): 416 | procs = (svisor["processes"] for svisor in self.supervisors.values()) 417 | return {puid: proc for sprocs in procs for puid, proc in sprocs.items()} 418 | 419 | @property 420 | def use_authentication(self): 421 | """ 422 | :return: whether authentication should be used 423 | """ 424 | username = self.config.get("username", False) 425 | password = self.config.get("password", False) 426 | return bool(username and password) 427 | 428 | @property 429 | def secret_key(self): 430 | return os.environ.get("MULTIVISOR_SECRET_KEY") 431 | 432 | def refresh(self): 433 | tasks = [spawn(supervisor.refresh) for supervisor in self.supervisors.values()] 434 | joinall(tasks) 435 | 436 | def get_supervisor(self, name): 437 | return self.supervisors[name] 438 | 439 | def get_process(self, uid): 440 | supervisor, _ = uid.split(":", 1) 441 | return self.supervisors[supervisor]["processes"][uid] 442 | 443 | def _do_supervisors(self, operation, *names): 444 | supervisors = (self.get_supervisor(name) for name in names) 445 | tasks = [spawn(operation, supervisor) for supervisor in supervisors] 446 | joinall(tasks) 447 | 448 | def _do_processes(self, operation, *patterns): 449 | procs = self.processes 450 | puids = filter_patterns(procs, patterns) 451 | tasks = [spawn(operation, procs[puid]) for puid in puids] 452 | joinall(tasks) 453 | 454 | def update_supervisors(self, *names): 455 | self._do_supervisors(Supervisor.update_server, *names) 456 | 457 | def restart_supervisors(self, *names): 458 | self._do_supervisors(Supervisor.restart, *names) 459 | 460 | def reread_supervisors(self, *names): 461 | self._do_supervisors(Supervisor.reread, *names) 462 | 463 | def shutdown_supervisors(self, *names): 464 | self._do_supervisors(Supervisor.shutdown, *names) 465 | 466 | def restart_processes(self, *patterns): 467 | self._do_processes(Process.restart, *patterns) 468 | 469 | def stop_processes(self, *patterns): 470 | self._do_processes(Process.stop, *patterns) 471 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------