Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sajov/feathers-opossum
A circuit breaker for Feathers services
https://github.com/sajov/feathers-opossum
circuit-breaker feathers-opossum feathers-services
Last synced: 3 months ago
JSON representation
A circuit breaker for Feathers services
- Host: GitHub
- URL: https://github.com/sajov/feathers-opossum
- Owner: sajov
- License: mit
- Created: 2020-01-12T19:44:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T11:48:36.000Z (over 1 year ago)
- Last Synced: 2024-03-17T14:02:51.675Z (4 months ago)
- Topics: circuit-breaker, feathers-opossum, feathers-services
- Language: JavaScript
- Homepage:
- Size: 977 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-feathersjs - feathers-opossum - A circuit breaker for Feathers services (Plugins / Scaling)
README
# feathers-opossum
[](https://travis-ci.org/sajov/feathers-opossum)
[](https://coveralls.io/github/sajov/feathers-opossum?branch=master)
[](https://david-dm.org/sajov/feathers-opossum)
[](https://snyk.io/test/npm/feathers-opossum)
[feathers-opossum](https://github.com/sajov/feathers-opossum) is a [circuit breaker](https://martinfowler.com/bliki/CircuitBreaker.html) for Feathers services. It implements the [opossum](https://github.com/nodeshift/opossum) module.
```
npm install feathers-opossum --save
```
## API
### `service(Service, serviceOptions, opossumOptions)`
Example:
```javascript
const service = require('service');
const opossumService = require('feathers-opossum');
const options = {
opossum: {
timeout: 3000,
errorThresholdPercentage: 50,
resetTimeout: 30000
},
fallback: () => {
return 'Sorry, out of service right now';
},
events: {
fallback: result => reportFallbackEvent(result),
}
methods: ['find', 'get']
};
const circuitedService = opossumService(service, {id:'_id', paginate: {max:10 }, options);
app.use('/may-fail', circuitedService);
```
Options:
- `Service` (**required**) - The main service
- `opossum.timeout` (optional, default: 3000) - If our function takes longer than trigger a failure
- `opossum.errorThresholdPercentage` (optional, default: 50) - When this ratio on requests fail, trip the circuit
- `opossum.resetTimeout` (optional, default: 30000) - After this try again.
- `fallback` - A fallback function that will be executed in the event of failure.
- `events` - [Opossum event](https://github.com/nodeshift/opossum#events) listener.
Options per Service Method:
```javascript
const options = {
find: {
opossum: {
timeout: 5000,
errorThresholdPercentage: 50,
resetTimeout: 30000
}
fallback: () => {
return 'Sorry, out of service right now';
},
events: {
fallback: result => reportFallbackEvent(result),
}
},
get: {
opossum: {
timeout: 1000,
errorThresholdPercentage: 50,
resetTimeout: 30000
}
fallback: () => {
return 'Sorry, out of service right now';
},
events: {
fallback: result => reportFallbackEvent(result),
}
}
};
```
## Changelog
**1.0.0**
- implement opossum events
- add event test
**0.1.0**
- publish
...
## License
Copyright (c) 2020
Licensed under the [MIT license](LICENSE).