https://github.com/mdcatapult/supervisor
Part of the Document Library micro service ecosystem. Co-ordinates all the consumer micro services.
https://github.com/mdcatapult/supervisor
cats mongodb pekko rabbitmq scala
Last synced: 3 months ago
JSON representation
Part of the Document Library micro service ecosystem. Co-ordinates all the consumer micro services.
- Host: GitHub
- URL: https://github.com/mdcatapult/supervisor
- Owner: mdcatapult
- License: apache-2.0
- Created: 2024-06-26T11:12:08.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-26T12:24:26.000Z (12 months ago)
- Last Synced: 2025-01-29T11:30:25.947Z (5 months ago)
- Topics: cats, mongodb, pekko, rabbitmq, scala
- Language: Scala
- Homepage:
- Size: 387 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Document Library Supervisor
The supervisor controls how documents are handled after they are ingested into the document library.
It decides which consumer should process a document next and publishes a message to the appropriate queue.
After all the other rules have been processed and assuming the `ANALYTICAL_SUPERVISOR` env var is `true` it will send the doc to the "analytical.supervisor" queue regardless of whether it has been processed previously by that consumer.
## Documentation
Please refer to the [documentation](docs/index.md) for more info about the supervisor.
## Runtime Configuration
The app allows runtime configuration via environment variables
* **MONGO_USERNAME** - login username for mongodb
* **MONGO_PASSWORD** - login password for mongodb
* **MONGO_HOST** - host to connect to
* **MONGO_PORT** - optional: port to connect to (default: 27017)
* **MONGO_DOCLIB_DATABASE** - the doclib database
* **MONGO_AUTHSOURCE** - optional: database to authenticate against (default: admin)
* **MONGO_DOCUMENTS_COLLECTION** - the documents collection
* **RABBITMQ_USERNAME** - login username for rabbitmq
* **RABBITMQ_PASSWORD** - login password for rabbitmq
* **RABBITMQ_HOST** - host to connect to
* **RABBITMQ_PORT** - optional: port to connect to (default: 5672)
* **RABBITMQ_VHOST** - optional: vhost to connect to (default: /)
* **RABBITMQ_DOCLIB_EXCHANGE** - optional: exchange that the consumer should be bound to
* **CONSUMER_QUEUE** - optional: name of the queue to consume (recommended: supervisor)
* **CONSUMER_CONCURRENCY** - optional: number of messages to handle concurrently (default: 1)
* **ANALYTICAL_SUPERVISOR** - `true` or `false` (default: `false`) whether docs should be queued onto the analytical supervisor after other processing has completed
## Testing
```bash
docker-compose up -d
sbt clean test it:test
```
## Dependency Scanning
https://github.com/albuch/sbt-dependency-check
The sbt-dependency-check plugin can be used to create a HTML report under `target/scala-x.x/dependency-check-report.html`
```bash
sbt dependencyCheck
```
### License
This project is licensed under the terms of the Apache 2 license, which can be found in the repository as `LICENSE.txt`