Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ifimust/srsr
Really Simple Service Registry
https://github.com/ifimust/srsr
gin go golang microservices slsa
Last synced: 2 months ago
JSON representation
Really Simple Service Registry
- Host: GitHub
- URL: https://github.com/ifimust/srsr
- Owner: ifIMust
- License: mit
- Created: 2024-07-11T16:55:02.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-10T05:14:51.000Z (5 months ago)
- Last Synced: 2024-10-15T17:21:53.373Z (2 months ago)
- Topics: gin, go, golang, microservices, slsa
- Language: Go
- Homepage:
- Size: 6.31 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# srsr
Really Simple Service Registry
## Description
srsr is a service registry written in Go. Its purpose is to allow microservices to find each other.
The primary goals are easy setup, and easy client implementation.
srsr uses [Gin](https://gin-gonic.com/) to offer an HTTP-based API.
It's very trusting; it does minimal validation to prevent abuse.
When multiple services are registered with the same service name, one is chosen at random on lookup.
Clients are provided for Go and Python projects.
By default, clients are expected to send a heartbeat every 30 seconds, or they will be deregistered.
The provided clients are configured to send a heartbeat every 20 seconds.
## Usage
### Server
Precompiled binaries are available for most systems.
```
chmod +x ./srsr-linux-amd64
./srsr-linux-amd64 [-p PORT] [-t TIMEOUT_SECONDS]
```
### Client
A Python client is provided [here](https://github.com/ifIMust/srsrpy).
A Go client is provided in the `client` package.
`go get github.com/ifIMust/srsr/client`
```
import "github.com/ifIMust/srsr/client"
// ...
var c client.ServiceRegistry = client.NewServiceRegistry(server_address, my_name, my_address)
c.Register()
// ...
c.Deregister()
```
## API Endpoints
All actions are performed as JSON Post requests.
### /register
Register a service. The client should do this once at startup, and store the returned ID for later use.
Example request:
```
{"name": "flard_service", "address": "321.123.321.123:4321"}
```
Response:
```
{"success": true, "id": "1ccda9cb-0432-4306-965d-6e0fbad571bc"}
```
The client may specify a port in the address string. If the client service cannot easily determine their binding address, they may specify the port only. The server will attempt to deduce the address.
```
{"name": "flard_service", "port": "1234"}
```
If neither addresss, nor port are specified, the service is registered at `http://localhost`, which might not be correct.
### /deregister
Deregister a service. The client should do this once at shutdown, using the ID stored from registration.
Example request:
```
{"id": "1ccda9cb-0432-4306-965d-6e0fbad571bc"}
```
Response:
```
{"success": "true"}
```
### /lookup
Retrieve an address for a service.
Example request:
```
{"name": "flard_service"}
```
Response examples:
```
{"success": "true", "address": "321.123.321.123:4321"}
{"success": "false", "address": ""}
```
### /heartbeat
Inform the service registry that the client is still up, to avoid automatic deregistration.
Example request:
```
{"id": "1ccda9cb-0432-4306-965d-6e0fbad571bc"}
```
Response:
```
{"success": "true"}
```
## Further plans
- Create test suite for Go client.
- Add supported feature to Go client to register with port only, leaving address blank