Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blablacar/go-synapse
Service discovery router
https://github.com/blablacar/go-synapse
haproxy infra owner-infra router service-discovery
Last synced: about 1 month ago
JSON representation
Service discovery router
- Host: GitHub
- URL: https://github.com/blablacar/go-synapse
- Owner: blablacar
- Archived: true
- Created: 2016-01-15T21:44:06.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-08-23T12:07:19.000Z (over 5 years ago)
- Last Synced: 2024-08-02T01:25:50.192Z (4 months ago)
- Topics: haproxy, infra, owner-infra, router, service-discovery
- Language: Go
- Homepage:
- Size: 895 KB
- Stars: 25
- Watchers: 51
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-repositories - blablacar/go-synapse - Service discovery router (Go)
README
[](https://travis-ci.org/blablacar/go-synapse)
# Synapse
Synapse is a Service discovery mechanism. It watch servers for services in a backend and report status in a router.
This simplify service communication with backends and allow auto discovery & hot reconfiguration of the communication.
This provide better services discovery and fault-tolerant communication between services
At BlaBlaCar, we use a synapse for each service node that want to communicate with another service and discover those backend nodes (> 2000). [Nerve](https://github.com/blablacar/go-nerve) report node statuses to a Zookeeper and synapse watch it to update a local Hapoxy. All outgoing communication is going through this haproxy.
## Airbnb
Go-Synapse is a go rewrite of Airbnb's [Synapse](https://github.com/airbnb/synapse) with additional features.
## Installation
Download the latest version on the [release page](https://github.com/blablacar/go-synapse/releases).
Create a configuration file base on the doc or [examples](https://github.com/blablacar/go-synapse/tree/master/examples).
Run with `./synapse synapse-config.yml`
### Building
_`****`_
Just clone the repository and run `./gomake`
## Configuration
It's a YAML file. You can find examples [here](https://github.com/blablacar/go-synapse/tree/master/examples)
Very minimal configuration file with only one service :
```yaml
routers:
- type: console
eventsBufferDurationInMilli: 500
services:
- serverSort: random # random, name, date
watcher:
type: zookeeper
hosts: ['localhost:2181']
path: /services/api/myapi
serverOptions:
... # depend on router type
routerOptions:
... # depend on router type
```
Root attributes:
```yaml
logLevel: info
apiHost: 127.0.0.1
apiPort: 3454
routers:
...
```
### Router config
#### Router console
Nothing special to configure for this router.
```yaml
...
routers:
- type: console
services:
- ...
```
#### Router haproxy
Router have haproxy specific attributes, but there is also services attributes
```yaml
...
routers:
- type: haproxy
configPath: /tmp/hap.config
reloadCommand: [./examples/haproxy_reload.sh]
reloadTimeoutInMilli: 1000
reloadMinIntervalInMilli: 500
global: # []string
- stats socket /tmp/hap.socket level admin
defaults: # []string
listen: # map[string][]string
stats:
- mode http
- bind 127.0.0.1:1936
- stats enable
services:
- watcher:
...
serverOptions: check inter 2s rise 3 fall 2
routerOptions:
frontend:
- mode tcp
- timeout client 31s
- bind 127.0.0.1:5679
backend:
- mode tcp
- timeout server 2m
- timeout connect 45s
```
serverOptions support minimal templating:
```
serverOptions: cookie {{sha1String .Name}} check inter 2s rise 3 fall 2
serverOptions: cookie {{randString 10}} check inter 2s rise 3 fall 2
serverOptions: cookie {{.Name}} check inter 2s rise 3 fall 2
```
### Router template
```yaml
...
routers:
- type: template
destinationFile: /tmp/notexists/templated
templateFile: ./examples/template.tmpl
postTemplateCommand: [/bin/bash, -c, "echo 'ZZ' > /tmp/DDDD"]
services:
- watcher:
...
```
## Services
```yaml
routers:
- type: ...
services:
- name: db-read
watcher:
...
serverCorrelation: # this will remove the first server declared in otherService from this service
type: excludeServer
otherServiceName: db-write
scope: first
```
## Watcher config
### zookeeper watcher
```yaml
routers:
- type: ...
services:
- watcher:
type: zookeeper
hosts: [ 'localhost:2181', 'localhost:2182' ]
path: /services/es/es_site_search
timeoutInMilli: 2000
```