gosuv
中文README 不是很全，能看懂英文的还是尽量看英文
current is in beta
Process management writtern by golang, inspired by python-supervisor
So why write another supervisor?
I have been using python-supervisor for many years and there are something uncomfortable feelings.
- Log can't contains ANSI color chars
- The configuration file can add on the web, often forgot some settings.
supervisorctl reloadwill cause supervisord restarted- Hard to set status change to fatal notifications.
- No process performance monitor page.
- Program starts with no common environ, eg, missing HOME and USER variable
- Kill process default is not group kill which make sub process still running.
- More... will added when I think of it.
Features
-
Web control page
- Start, Stop, Tail, Reload
- Realtime log
- Add program support
- Edit support
- Delete support
- Memory and CPU monitor
- Path auto complete https://github.com/twitter/typeahead.js
-
HTTP Basic auth
-
Github webhook
-
Single log page, include search support
-
中文文档
Requirements
Go version at least 1.6+
Installation
Binaries
The fastest way is run with. Default install location is /usr/local/bin, change env-var BINDIR will also change install location.
curl https://raw.githubusercontent.com/codeskyblue/gosuv/master/get.sh, bash
Or just download binaries
https://github.com/codeskyblue/gosuv/releases
Thanks to goreleaser which makes publish binaries automaticly.
Build from source
go get -d github.com/codeskyblue/gosuv
cd $GOPATH/src/github.com/codeskyblue/gosuv
go generate # package html resources into go
go build -tags vfs
Quick start
After you installed gosuv, the first thing is to start server.
gosuv start-server
Basic operations
$ gosuv status
PROGRAM NAME STATUS
test running
test_again stopped
$ gosuv stop test
$ gosuv start test
Open web http://localhost:11313 to see the manager page. And follow the gif to add a program to gosuv.
Configuration
Default config file stored in directory $HOME/.gosuv/, Set env-var GOSUV_HOME_DIR can change config file store directory.
- file
programs.ymlcontains all program settings. - file
config.ymlcontains server config
File config.yml can be generated by gosuv conftest
Example config.yaml
server:
httpauth:
enabled: true
username: admin
password: admin
addr: :8083
name: 10.10.99.177
master: ""
notifications:
dingtalk:
groups:
- secret: c1b8032******************aa736a
mobile:
- "153********"
client:
server_url: http://admin:admin@localhost:8083
master 的支持来自 https://github.com/ihaiker/distributed-gosuv
Logs can be found in $HOME/.gosuv/log/
Edit config file(default located in $HOME/.gosuv/programs.yml) and run gosuv reload will take effect immediately.
Design
HTTP is follow the RESTFul guide.
Get or Update program
<GET, PUT> /api/programs/:name
Add new program
POST /api/programs
Del program
DELETE /api/programs/:name
State
Only 4 states. ref
Notification
Configuration example
- demo-program:
command: ...
notifications:
pushover:
api_key: [token]
users:
- [user1]
- [user2]
Now only support pushover, and only status change to fatal will get notified.
Integrate with github (todo)
This is feature that will helps update your deployment environment once your updated in the github.
This part is set in the programs.yml, take look the example
- demo-program:
command: python app.py
directory: /opt/demo
webhook:
github:
secret: 123456
command: git pull origin master
Alternative
- Go implementation of supervisor https://github.com/ochinchina/supervisord