Skip to content

Latest commit

 

History

History
162 lines (132 loc) · 4.83 KB

README.md

File metadata and controls

162 lines (132 loc) · 4.83 KB
Raw

Virgil Spring Boot Starter

OSS Lifecycle

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
      • <queue>
        • readName
        • readBinderName
        • [Optional] republishName
        • [Optional] republishBinderName
        • [Optional] republishBindingRoutingKey
    • binders
      • <binderName>
        • name
        • type: rabbit
        • rabbitProperties
          • [Optional] addresses
          • [Optional] host
          • [Optional] port
          • username
          • password
          • [Optional] virtual-host

Example with Single DLQ:

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:

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.<binderName>.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

alt text alt text

Visit actuator endpoints

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

Code of Conduct

This project is governed by the Contributor Covenant v 1.4.1.

License

This project uses the Apache 2.0 license.