https://github.com/indeedeng/virgil-spring-boot-starter
https://github.com/indeedeng/virgil-spring-boot-starter
rabbitmq spring-boot-admin
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/indeedeng/virgil-spring-boot-starter
- Owner: indeedeng
- License: apache-2.0
- Created: 2020-04-03T18:28:26.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-12T01:58:14.000Z (over 2 years ago)
- Last Synced: 2025-05-07T23:40:08.343Z (about 1 year ago)
- Topics: rabbitmq, spring-boot-admin
- Language: Java
- Homepage:
- Size: 1.82 MB
- Stars: 2
- Watchers: 4
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Virgil Spring Boot Starter
Virgil is a Spring Boot Starter that is developed as a Spring Boot Admin extension and serves as a generic message
manager. It supports RabbitMQ with actions such as count/display/republish/drop messages on the queue.
For future releases we will consider adding in additional actions such as download/etc along with Kafka support.
Virgil implements a collection of Actuator endpoints to support the queue actions, it also provides UI as Admin
extension to interact with those Actuator endpoints.
Name reference: https://en.wikipedia.org/wiki/Virgil
## Getting Started
```
compile 'com.indeed:virgil-spring-boot-starter'
```
### Build Virgil UI Component
#### Dev Build
```
gradle buildFrontEndDev
```
#### Prod Build
```
gradle buildFrontEndProd
```
### Setup Virgil In Your Project
#### List of settings you can configure in `application.yml`
* virgil
* queues
* \
* readName
* readBinderName
* [Optional] republishName
* [Optional] republishBinderName
* [Optional] republishBindingRoutingKey
* binders
* \
* name
* type: rabbit
* rabbitProperties
* [Optional] addresses
* [Optional] host
* [Optional] port
* username
* password
* [Optional] virtual-host
Example with Single DLQ:
```yaml
virgil:
queues:
virgilDlq:
readName: virgil-dlq
readBinderName: virgilExchange
republishName: virgil-queue
republishBinderName: virgilExchange
republishBindingRoutingKey: test.#
binders:
virgilExchange:
name: virgil-exchange
type: rabbit
rabbitProperties:
host: virgil-rabbit
port: 5672
username: guest
password: guest
virtual-host: /
```
Example with Many DLQs:
```yaml
virgil:
queues:
virgilDlq:
readName: virgil-dlq
readBinderName: virgilExchange
republishName: virgil-queue
republishBinderName: virgilExchange
republishBindingRoutingKey: test.#
virgilDlq2:
readName: virgil-queue
readBinderName: virgilExchange
republishName: virgil-dlq
republishBinderName: virgilExchange
republishBindingRoutingKey: dlq.#
binders:
virgilExchange:
name: virgil-exchange
type: rabbit
rabbitProperties:
host: virgil-rabbit
port: 5672
username: guest
password: guest
virtual-host: /
```
#### Configuration Details
* `binders..rabbitSetings`: if `addresses` is provided it will be used as priority over `host` and `port`.
If `addresses` is blank, `host` and `port` will be used. `Port` will default to `5672`.
* `queues.queue`: if `republishName` and `republishBinderName` is not present, we will disable `republish` option
per message
* If you are using Spring Cloud Stream:
* If you configure `spring.cloud.stream.rabbit.bindings.input.consumer.auto-bind-dlq=true` and
`spring.cloud.stream.bindings.input.group=myGroup`, the format of your `DLQ`
should be `input.myGroup.dlq`;
## Supported Functionality
#### V1
* One queue per application instance;
* RabbitMQ;
* Display total count of messages in queue;
* Parse out text based body to be displayed
* Pluggable MessageConverter allows you to replace default utf8 parser with custom message parser
* By registering a Bean with IMessageConverter as its return type
* Republish 1 message at a time from queue;
* Drop 1 or all messages at a time from queue;
* UI as Spring Boot Admin extension backed by Actuator endpoints;
#### V2
Stay tuned!
## UI Demo
## Visit actuator endpoints
* http://localhost:8080/private/actuator-endpoint-id
* e.g.:
* http://localhost:8080/private/virgil/get-queue-size
* http://localhost:8080/private/virgil/publish-message
* http://localhost:8080/private/virgil/drop-all-messages
* http://localhost:8080/private/virgil/drop-message
* http://localhost:8080/private/virgil/get-dlq-messages
## How To Contribute
If you’d like to contribute, please open an issue describing what you want to change and why, or comment on an existing issue. We’d love to have you.
## Project Maintainers
* [Richard Cen](https://github.com/RichardCen), Indeed Software Engineers
* [reedyrm](https://github.com/reedyrm), Indeed Software Engineers
## Code of Conduct
This project is governed by the [Contributor Covenant v 1.4.1](CODE_OF_CONDUCT.md).
## License
This project uses the [Apache 2.0](LICENSE) license.