/solace-queue-browser-extension

View the payload of a message from the console inline

Primary LanguageJavaScriptMIT LicenseMIT

Contributor Covenant

Solace-browser-extension

View the message content of a queued message directly on the Messages Queued page.

Overview

This extension was built to prove that the payload of messages can be viewed inline. If you want to add new features or make improvements, feel free to add a pull request!

Getting started quickly

Installing the Extension

  1. Clone or download this repository to a folder on your device.
  2. If downloaded, unzip the package.
  3. Go to chrome://extensions/
  4. At the top right, turn on Developer mode.
  5. Click Load unpacked and select the unzipped solace-queue-browser-extension-main folder.

Getting Connected

  1. Click on the extensions icon in the top right corner and then click the newly installed Emixa Solace message view Extension.

    • A new page should open prompting for an encryption key.
    • This key will be used to securely encrypt the connections you save locally.

    image

  2. Enter a key and click save.

  3. To create a connection, click the green New Connection button.

  4. Now on the right side of the page, start filling in the required connection detail fields.

  5. To obtain these credentials, open Solace Cluster Manager and select the Service you want to connect with.

  6. For Username and Password, please refer to the official Creating a Client Username documentation.

  7. For the Message VPN, navigate to Manage -> SEMP - REST API.

    • Here you will find the Message VPN Name. Copy this value.

  8. For the Host name, navigate to Connect -> Connect with JavaScript -> Solace JavaScript API.

    • Here you will find Host URIs.
    • Find a URI that looks similar to this wss://mr-connection-abcd1234.messaging.solace.cloud:443 and copy the mr-connection-abcd1234 value.

  9. Click save.

    • Clicking save will automatically make an attempt to connect to the Message VPN.
    • The result will be displayed in the top right hand corner.

Displaying Messages

  1. Open Cluster Manager and select the Service whose queued messages you would like to see.

  2. Navigate to Manage -> Message VPN -> Queues.

  3. Click a queue from the list and then click the Messages Queued tab.

  4. In the top-right corner of the window there is a green button Find Messages.

  5. image

  6. Messages will be displayed inline.

    image

  7. If you have toggled ON Display User Properties, you will also see the User Properties of each message displayed next to the queue message.

    image

Documentation

See also a thread on https://solace.community/discussion/comment/2103#Comment_2103 Please note that the use of this extension is at your own risk.

Resources

For more information try these resources:

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See the list of contributors who participated in this project.

License

See the LICENSE file for details.