Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koalazak/redis-registry
Service registry and discovery for Node.js on top of Redis
https://github.com/koalazak/redis-registry
discovery microservice microservices redis registry service
Last synced: 3 months ago
JSON representation
Service registry and discovery for Node.js on top of Redis
- Host: GitHub
- URL: https://github.com/koalazak/redis-registry
- Owner: koalazak
- License: mit
- Created: 2017-09-15T15:56:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-21T11:17:55.000Z (over 3 years ago)
- Last Synced: 2024-10-13T00:16:23.895Z (3 months ago)
- Topics: discovery, microservice, microservices, redis, registry, service
- Language: JavaScript
- Size: 16.6 KB
- Stars: 28
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# redis-registry
[](https://travis-ci.org/koalazak/redis-registry)
[](http://badge.fury.io/js/redis-registry)
Service registry and discovery for distributed systems on top of [redis](https://github.com/NodeRedis/node_redis) and node.js
## Install
```bash
npm install redis-registry
```
## Usage
Computer 1
``` js
const registry = require('redis-registry');
const redisConfig = {
host: '192.168.1.50',
port: 6379
}
const services = registry(redisConfig);
// Join the registry
services.join('my-service-name', {port:8080});
```
Computer 2
``` js
const registry = require('redis-registry');
const redisConfig = {
host: '192.168.1.50',
port: 6379
}
const services = registry(redisConfig);
// Do a lookup
services.lookup('my-service-name', function(err, service) {
console.log('Found the following service:');
console.log(service);
});
```
Running the above [example](https://github.com/koalazak/redis-registry/blob/master/example.js) will produce the following output
```
Found the following service:
{
name: 'my-service-name',
port: 8080,
hostname: '192.168.1.10',
host: '192.168.1.10:8080',
url: 'http://192.168.1.10:8080'
}
```
**Note**: If no hostname is passed to the `join` function, it will pickup the main interface IP as the hostname. If you need to use the IP of a non-primary interface, set the environment variable `REGISTRY_INTERFACE` to the name of the device of your choice (`eth1`, `en1`, etc)
## Full api
* `services = registry(redisConfig)` Create a new registry client
* `services.join(name, service, [cb])` Join the registry with a new service
* `services.leave([name], [cb])` Leave the registry.
* `services.lookup(name, cb)` Lookup a single service
* `services.list([name], cb)` List all services as an array. Omit the name to list all services
## Services
Services are just JSON documents. `redis-registry` will add a default `hostname` and a couple of other properties.
An example of a service document could be:
``` js
{
name: 'my-service',
port: 8080,
hostname: '192.168.1.10', // added by redis-registry
host: '192.168.1.10:8080', // added by redis-registry
url: 'http://192.168.1.10:8080' // added by redis-registry
}
```
These documents are saved in [redis](https://redis.io/) with a TTL of 10s.
Every 5s `redis-registry` will send an update for each service to the registry which resets the expiration counter keeping the service record.
If possible you should call `services.leave()` before exiting your service process. Otherwise your service will be garbage collected after (at most) 10s.
If your process goes down, it will automatically leave the registry (due to the TTL) and will not be discovered from other process.
## License
MIT