Overview

Landing page and Tabular data

After logging into WMT Angular, the landing page displays the MonitorUsers section. All tables present in the view can be sorted in both ascending and descending order by clicking the corresponding column header.

Figure 1: Landing page displaying MonitorUsers View

Filtering

The Filter option present of the upper-right part of the screen is used to filter the tabular data based on the text entered in the filter text box.

Figure 2: Filter Options

Server Shutdown notification

During the interaction with the Server, if the server shuts down due to unknown reasons, the Angular WMT logs out the user with a message displaying "FioranoMQ server is down. Logging out....".

Figure 3: Server Disconnected Status

Common Configurations

Four operations in the Configurations drop-down present at the upper-right side of the page are listed below.

Figure 4: Server Disconnected Status

Angular WMT Views

Each tab in the left navigation panel of the WMT Angular dashboard are explained in detail in the following sections.

1. Users

MonitorUsers

This view contains all existing Users and their respective connection status. Users are set as connected to an 'admin' Connection or JMX Connection is made or if the JMS Application is started. This view also gives information about the maximum connection limit that is set for each user and the current number of connections created by the user.


Figure 4: Monitor Users View

ConfigureUsers

This view contains the function to modify users. The options available are Add User, Delete Selected Users, Change Password for User, and set Maximum Connections per user, Import Users, and Export Users. These options are present in the Select Operation drop-down menu. To use any one of the option, click the Go button after selecting the required option.

The Import Users and Export Users options help copying users to another FioranoMQ Server. Export option allows exporting of all data to a standard file present on any machine. (Mapping needs to be done if the file is present on another machine.) The data can be imported to any other server that starts with FioranoMQ. 


Figure 5: Configure Users View

2. Groups

Configure Groups view contains information about all groups and its members. Groups can be added using the Add Groups option and deleted using the Delete Selected Groups option. For modifying members of an existing group, use the Edit Members in Group option after selecting the required group. These options are available in the Select Operation drop-down menu. Select the operation from the options available and click the Go button.

Figure 6: GroupView

After selecting a group, if the selected operation is "Add Members to Group", an overlay panel containing all members which could be added is displayed. Select the members and click Add to add the selected member to the selected group.

Figure 7: Editing Group Members

After selecting a group, if the selected action is "Remove Members from Group", an overlay panel containing all the current members of the group is displayed. Select the members and click Remove to remove the selected members from the selected group.

3. Topics

Monitor Topics

This section contains the information about existing topics with the sum of each displayed on the top of the page. An Active Topic refers to a topic that contains either a publisher or a subscriber. The Select Operation drop down lists the operations that can be executed on each Topic destination selected. The Send Message operation will send persistent text messages to the topic(s) selected. The Corrupted Topics check box, if selected, displays all the corrupted topics in the MonitorTopics view; by default, the view displays all the Topics (Corrupted and Non-Corrupted Topics). The corrupted topics can be recovered and replayed using the Recover Selected Topics and Replay Messages from Topics operations respectively. More information on this feature can be found under the Handling data base corruption section. 

Figure 8: MonitorTopics View

Configure Topics

This section allows all operations to be performed on topics such as CreateTopic and DeleteSelectedTopics. The Restart Topics operation helps restart a specific Topic destination to apply the changes made to parameter values. The Shutdown Topics operation shuts the unwanted Topic destinations. 

The Edit Topic Properties operation can be used to edit all properties related to a topic destination, whereas, the Edit Topic Subsystem Properties operation can be used to modify similar properties at the global level for all Topics.

Figure 9: ConfigureTopics View

By selecting the EditTopicProperties options from the Select Action drop-down menu and clicking the Go button, it is possible to view all properties and their corresponding values. Values with a different background color need to be saved. Once saved, the Server needs to be restarted to make them take effect or if the changes are done at destination level Topic restart alone will get the changes effected. A description of the property that is selected is provided at the bottom of the browser. The mouse may be moved over the textbox to view the description of the property. Export Topics and Import Topics can be used to save topics to a standard file as well as to create all of them in a FioranoMQ server that is running. The operations - Import Topics and Export Topics can be used only by the 'admin' User.

Figure 10: Editing Topic Properties

4. Queues

Monitor Queues

This view contains the information about existing queues with the sum of each displayed at the top of the table. Here, the Active Queue refers to the queues which contain either a sender or receiver. DeliverableMessages and UndeletedMessages are not updated at regular intervals. To update these values select all the required queues or invoke UpdateSelectedQueues or UpdateAllQueues present in the Select Operation drop-down menu. Deliverable Messages count is the number of messages yet to be delivered from the Queue, and Undeleted Messages count denotes the number of messages yet to be acknowledged by the Consumer and deleted from the data base. 

The SendMessage operation will send persistent text messages to the queue(s) selected. The Corrupted Queues check box, if selected, displays all the corrupted queues in the MonitorQueues view; by default, the view displays all the Queues (Corrupted and Non-Corrupted Queues). The corrupted queues can be recovered and replayed using the Recover Selected Queues and Replay Messages from Queues operations respectively. The Purge Messages operation deletes all the messages in a selected Queue.

Figure 11: MonitorQueues View

The Browse Messages operation can be handy in browsing messages on a selected Queue and view its properties. 

Figure 12 : BrowseMessages operation

Configure Queues

This view allows all operations to be performed on queues such as CreateQueue and DeleteSelectedQueues. One can restart a specific Queue destination to get the parameter changes done on it to get effected using the Restart Queues operation. The Shutdown Queues operation shuts unwanted Queue destinations. 

The Edit Queue Properties can be used to edit all properties related to a queue destination, whereas, the Edit Queue Subsystem Properties operation can be used to modify similar properties at the global level for all Queues.

By using the EditQueueProperties operation present under the Select Operation drop-down menu, it is possible to view all properties and their corresponding values. Values with different background colour need to be saved. After saving, the Server needs to be restarted to apply the changes. If the changes are done at destination level, Queue restart alone will get the changes effected. Description of each property that is selected is provided at the bottom of the browser. Hover the mouse over the textbox to view the description of the property. You are notified if any property requires save configuration and server restart was modified. The Export Queues and Import Queues operations can be used to save queues to a standard file as well as to create all of them in a FioranoMQ Server that is running. Import Queues and Export Queues operations can be used only by the 'admin' User.

5. ConnectionFactories

The MonitorConnectionFactory operation lists all the connection factories along with their important properties (such as ConnectUrl, AutoUpdate, Type, Description), with a sum of each displayed at the top of the table.

The ConfigureConnectionFactory operation allows various operations to be performed such as Create CF, Delete Selected CF, Edit CF Properties on Connection Factories. The Edit CF Properties can be used to edit all the properties related to the selected connection factory. The Create CF option present under the Select Action drop-down list can be used to create new Connection Factories and the Delete Selected CF can be used to delete existing Connection Factories.

Export and Import CF can be used to save Connection Factories to a standard file and to create all of them in a FioranoMQ Server that is running. Import and Export CF can be used only by the 'admin' User.

6. Policies

ConfigurePolicies

Policies allow users to change permissions on a specific destination for a specific principal. By default, the view will show No restrictions on policies if the user had not modified any permission. If a user wants to modify any particular permission, then the user needs to use the Add Permissions option present in the Select Operations drop-down menu. A dialog box will appear with properties such as User Name, Destination Name, Positive Permissions, and Negative Permissions. After all required values are provided, click on Add button. The modified permissions will be updated in the table.

Figure 13: Editing policies of a destination

ConfigureIPAccessList

The IP Access List view lists down the IP addresses which are allowed to connect to the the FioranoMQ server. By default, all the IP addresses are accepted by FioranoMQ Server, which is denoted by *.*.*.* representation. The Select Operation drop-down has two operations - Add IPAddress, for adding a new IP Address set/range to the allowed list and Remove IPAddress, for removing the IP Address entry from the list already available. While adding a new IP Address set/range, it can be added as IPV4 or IPV6 address(es).

Figure 14: Adding IP address

7. Routes

A Route enables the transport of messages between destinations. A message arriving at one destination can be made available to another if a route exists between the two destinations.

ConfigureRoute

This view contains information about the properties of the route manager. These are the properties of the individual routes present on the server.

If there are any routes present on the Server, those details will be displayed in the table. If no routes are present, a message "No routes available in the Server" is displayed in the table.

Figure 15: Route

To Add or Delete a route from the Server, choose the appropriate operation from the Select Operation drop-down menu.

Figure 16: Adding Route

Select any of the routes present in the table to display the properties of the corresponding routes in the table.

Figure 17: Route Added

8. DashBoard

DashBoard gives a graphical representation of Time vs Threads/Connections/Memory in the x axis and y axis respectively. The entries in the y axis may be selected based on the requirement; selecting more than one of these options displays graphs one below the other.

Figure 20: Displaying a graph of Time Vs Memory

9. DurableSubscribers

Monitor DurableSubscriber

This view contains all existing durable subscribers listed along with other relevant information such as Subscription state, the Topic destination it is subscribing to, the deliverable number of messages for each durable Subscriber, the ClientId of the connection, and if it is a Shared Subscriber or not, and the number of active consumers under each Shared Subscriber.

A summary is present at the top of this window, denoting the total number of Durable Subscriptions for this instance of FioranoMQ Server. The Active Topics counter is updated based on the number of Topics having Active Durable Subscribers running. The Passive Topics counter is updated for Topics having Passive Durable Subscriptions.


Figure 21: Monitor durable subscriptions

The Select Operation drop down has a single operation - 'Browse Messages' on a Durable Subscriber. 

Figure 22: Browse messages for durable subscription

Configure DurableSubscription

This view contains all durable subscriber names in the form of subscriberID::clientID. Messages can be unsubscribed or purged messages for passive durable subscribers from this view. Any operations involving active durable subscribers throw a warning message.

10. Connections

Monitor Connections

This view lists all types of connections along with their relevant properties, such as the 'ClientID' of the connection, the 'ClientAddress' indicates the IP address from which this connection is created, 'Type' of connection whether it belongs to PTP or PUBSUB model or an MQTT Connection type, the 'Destinations' column gives the list of destinations that this connection is using in the form either creating Producers or Consumers, the 'CreationTime', the 'User' credentials used for creating this connection, and the 'Protocol' used, the 'Total PSQSize' and the 'Max PSQSize'. It has three tabs, namely "Connections", "LPC" and "API keys".

A summary is present at the top of this window denoting the total number of connections and the under each category, PTP/PUBSUB/Admin connections.


Figure 23: Monitor connections

Connections

Click on each Connection to display the following additional connection information:

• Build Number: The build number of the client connection
• CSPBaseDir: The CSP base directory used for this connection
• ClientID: The ClientID used by this connection
• ConnectionStarted: Boolean which indicates whether or not this connection has been started
• Destination List: The list of destinations that this connection is using
• Number of Browsers: The number of Browsers created under this connection
• Number of Consumers: The number of Consumers created under this connection
• Number of Producers: The number of Producers created under this Connection
• Runtime Connection Type: The type of client runtime used to create this connection
• Server Port: The server port to which this Connection is created.
• Session Count: The number of Sessions created under this Connection
• Version Number: The FioranoMQ Version number used by the Client Connection.
• SocketInfoList: The list of sockets used by this connection

Figure 24: Monitor connections - connection information

LPC

This tab lists all connections which use the LPC protocol.

Figure 25: Monitor connections - LPC

API keys

This tab lists all the API keys which are used for the purpose of invoking resource methods on the server side, from the application. Some additional information such as the last-use timestamp of the API key, the IP address and the user involved in the creation of the API key are shown. Note that the API key which is being used by this instance of the WMT Angular application is highlighted in green.

Figure 25: Monitor connections - API keys

Configure Connections

This view has two tabs namely "Connections" and "API keys". The Connections tab allows the disconnection of a connection based on the clientID. The "API keys" tab allows the revocation of the desired API keys. Note that the API key which is being used by this instance of the WMT Angular application is highlighted in green.

11. Sockets

MonitorSockets view contains information about all the sockets currently open within the Server. The sockets are created for each of the connections made to the server by the clients. The table gives information on Server ports, information about the client, the transport type, IP address of the Server, and whether SSL is enabled.

Figure 26: Monitor Sockets

12. Logs

Monitor Log

Allows the user to fetch details of logs, view log details, and clear log details.

Configure Logs

Lists all the loggers used in the FioranoMQ Server. Selecting any particular logger changes its level.

Figure 27: Changing the log level of a particular logger

13. JMX

This view lists all the Mbeans along with their attributes and operations.

When a particular Mbean is selected, a table containing the following two tabs gets displayed.

Attributes

The Attributes tab lists all the attributes of the Mbean along with their values, parameter types and whether a restart of the Server is required for changes to take effect.

Figure 28: Attribute View of JMX

Operations

This tab lists the operations present in that Mbean enabling the User to invoke these operations.

Figure 29: Operations View of JMX

14. AdvancedProperties

This view contains frequently used properties and their values. For example, the PORT_PRPERTIES tab contains the properties RMIBasedJMXServerPort and JettyServer port. These two ports and the JMS Server listening port (which is represented by the property "SocketAcceptorPort" under the category called ConnectionManager properties, under the tab called ConnectionManager__1) need to be unique for running multiple instances of the server on the same IPAddress. All of these values can be modified.

Figure 30: PORT_PRPERTIES tab in the AdvancedProperties View

15. Licenses

MonitorLicense displays information of about all the licenses available. The License Filename list-box lists the available licenses. Selecting a license displays its corresponding license information in the table:

Figure 31: Licenses

16. SystemProperties

SystemProperties view lists all the relevant properties of the system on which the FioranoMQ Server is hosted. These values cannot be modified through the WMT Angular.

Figure 32: System Properties

Status Information

This tab lists the system properties and the corresponding values.

Click the information button present at the upper-right part of the SystemProperties page to view information such as the name of the logged in user, the access mode, time and date of FioranoMQ Server startup,  FioranoMQ product version number, build number, and the JVM version indicates whether the server JVM is 32 or 64 bits. 

Figure 33: Status information

17. Audit Manager

Using the Audit Manager view it is possible to configure the Audit Storage Policies as well as monitor the audit events recorded in the Server.

MonitorAuditEvents

In this view, the audit events that are recorded in the System can be monitored. To enable this, the 'Audit Filter' set for the current view needs to be changed. The figure below shows how to modify the view:

Figure 34: Modify Audit Search Filter

ConfigureAuditPolicies

In the Configuring Audit Policies view, the various kinds of Storage Policies which are responsible for generating Audit events are configured. In order to do this, the Modify Audit Storage Policy operation needs to be invoked after selecting one of the Storage Policies listed in the table inside the view. The storage policy will then need to be configured.

Figure 35: ConfigureAuditPolicies > Modify Audit Storage Policy

The recording of Audit events can be stopped by configuring the same storage policy that is used for enabling Audit Events. In order to do this, the action 'De-activate Storage Policy' needs to be invoked after selecting the Storage Policy which is to be de-activated.