Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 1.75 KB

README.md

File metadata and controls

39 lines (31 loc) · 1.75 KB
Raw

SQS Insight

This tool provides an insight into AWS SQS Queues or ElasticMQ Queues. ElasticMQ is a nice Project to Mock Queues locally, as it provides the same API interface as SQS, but unfortunately does not ship with a GUI.

Setup

Clone this repo, then cd into it and run npm install to install required dependencies.

Otherwise, you also may install it via npm install finanzcheck/sqs-insight.

Configure

Copy config/config.json to config/config_local.json and change it to meet your needs. The following fields are mandatory:

  • port - the port to bind the GUI to
  • rememberMessages - How many messages should be stored? <-- This fixes the problem, that a queue consumer is not aware of messages, that were handled by other consumers
  • endpoints - An array of Objects defining the sqs api endpoints for the queues you want to get an insight into. Each Object needs to have the following keys defined:
{
    "key": "notValidKey",
    "secretKey": "notValidSecret",
    "region": "eu-central-1",
    "url": "http://sqs.amazonaws.com/my-user/my-queue"
}
  • dynamicEndpoints - An array of Objects defining SQS servers for dynamically adding queues to the endpoints list. Each objects needs to have the following keys defined: (url can be omitted if using AWS SQS)
{
    "key": "notValidKey",
    "secretKey": "notValidSecret",
    "region": "us-east-1",
    "url": "http://sqs.amazonaws.com/"
}

Start

run npm start, node index.js in development or NODE_ENV=production node index.js to run it in production mode.

Access the GUI

Open http://localhost:3000 in your browser, or change the port to the one you set in config_local.