Overview

Landing page and Tabular data

After logging into WMT Angular, the landing page is the MonitorUsers view.

All tables present in all the views 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 By option present on the upper-right part of the screen is used to filter the tabular data based on the filtering column selected in the menu and the following text entered in the filter text box.

Figure 2: Filter Options

Refreshing of data

All data present in all of the different 'Monitor' and 'Configure' views are refreshed automatically. Data is fetched from the Server after every refresh interval. All tables get updated with the new values fetched.

Server Shutdown notification

During the interaction with the Server, if the server restarts or 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

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

Figure 4: Common configuration options

Status Information

Click the information button present at the upper-right part of the 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 5: Status information

Using Operations

In most of the views in the left navigation panel tabs, there will be various operations available under the Select Operation drop-down menu.

To use any one of these operations, select the required operation and click the Go button.

Figure 6: Operations drop-down

Angular WMT Views

Details of each tab in the left navigation panel of the WMT Angular dashboard is 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 if a JMX connection is made or if a JMS client 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 7: MonitorUsers View

ConfigureUsers

This view helps to modify users. In the Select Operation drop-down menu, there are operations such as Add User, Delete Selected Users, Change Password for User, and set Maximum Connections per user, Import Users, and Export Users. To use any one of these operations, select the required operations and click the Go button.

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


Figure 8: ConfigureUsers View

2. Groups

ConfigureGroups

The ConfigureGroups view contains information about all groups and its members. Groups can be added using Add Group and deleted using Delete Selected Groups. For modifying members of an existing group, use Add Members to Group and Remove Members from Group after selecting the required group.

The above operations are available in the Select Operation drop-down menu. Select the required operation and click the Go button.

Figure 9: ConfigureGroups view

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

Figure 10: Editing Group members

After selecting a group, if the selected operation is Remove Members from Group, an overlay panel containing all the existing members of the selected group is displayed. Click Remove to remove the selected members from the selected group.

Figure 11: Removing Group members

3. Topics

MonitorTopics

The MonitorTopics view contains the information about existing topics with a summary displayed on the top of the table. The 'Active Topics' mentioned in the summary 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 (present right above the table), 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.

Figure 12: MonitorTopics View

ConfigureTopics

This view allows all operations, to be performed on topics, such as CreateTopic and DeleteSelectedTopics. The Restart Topics operation restarts a specific Topic destination to apply the changes made to its parameter values. The Shutdown Topics operation shuts down 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 13: ConfigureTopics view

By using the Edit Topic Subsystem Properties operation present under the Select Operation drop-down menu, it is possible to view all topic subsystem properties and their corresponding values. When properties highlighted in Bold are modified, the changes need to be saved and the server must be restarted to apply the changes. If the changes are done at the destination level by using the Edit Topic Properties operation, restart of that particular topic alone is enough to apply the changes. The mouse can be hovered over the text box to view the description of any property. The Export Topics and Import Topics operations 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. 

Figure 14: Editing Topic properties

4. Queues

MonitorQueues

This view contains the information about existing queues with a summary displayed on the top of the table. The 'Active Queues' mentioned in the summary 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 Update Selected Queues or Update All Queues 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 Send Message operation will send persistent text messages to the queue(s) selected. The Corrupted Queues check box (present right above the table), 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 15: MonitorQueues view

The Browse Messages operation is handy in browsing messages on a selected Queue and view its properties. Select the required queue, select the Browse Messages operation and click Go to browse messages and its properties from the overlay panel that pops up.

Figure 16: Browse Messages operation

ConfigureQueues

This view allows all operations, to be performed on queues, such as CreateQueue and DeleteSelectedQueues. The Restart Queues operation restarts a specific Queue destination to apply the changes made to its parameter values. The Shutdown Queues operation shuts down the unwanted Queue destinations. 

The Edit Queue Properties operation 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.

Figure 17: ConfigureQueues view

By using the Edit Queue Subsystem Properties operation present under the Select Operation drop-down menu, it is possible to view all queue subsystem properties and their corresponding values. When properties highlighted in Bold are modified, the changes need to be saved and the server must be restarted to apply the changes. If the changes are done at the destination level by using the Edit Queue Properties operation, restart of that particular queue alone would be enough to apply the changes. The mouse can be hovered over the text box to view the description of any property. 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 the FioranoMQ server that is running.

5. ConnectionFactories

MonitorConnectionFactory

This view lists all the connection factories along with their important properties (such as ConnectUrl, AutoUpdate, Description, and Type), with a summary displayed on the top of the table.

Figure 18: MonitorConnectionFactory view

ConfigureConnectionFactory

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

Figure 19: ConfigureConnectionFactory view

The Export CF operation and the Import CF operation can be used to save Connection Factories to a standard file and to create all of them in a FioranoMQ Server that is running.

6. Policies

ConfigurePolicies

Policies allow users to change permissions on a specific destination for a specific principal.

If there are any permissions set on the Server, those details will be displayed in the table. If no permissions are present, a message "No restrictions on Policies" is displayed in the table.

Figure 20: The ConfigurePolicies view before adding any permission

If a user wants to modify any particular permission, then the user needs to use the Add Permission operation present in the Select Operations drop-down menu. An overlay panel is displayed with properties such as User Name, Destination Name, Positive Permissions, and Negative Permissions. After all the required values are provided, click the Add button. The modified permissions will be updated in the table.

Figure 21: Editing policies of a destination

ConfigureIPAccessList

The ConfigureIPAccessList 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 - The Add IPAddress operation, for adding a new IP Address set/range to the allowed list and the Remove IPAddress operation, for removing the IP Address entry from the list already available. While adding a new IP Address set/range, select the IP Type to add it as IPV4 or IPV6 address(es).

Figure 22: Adding IP address

7. AuditManager

Using the AuditManager 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. Use the Modify Audit Search Filter operation to perform the same.

Figure 23: Modify Audit Search Filter

ConfigureAuditPolicies

In the ConfiguringAuditPolicies 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 24: 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 De-activate Storage Policy operation needs to be invoked after selecting the storage policy which is to be deactivated.

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

ConfigureRoutes

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 25: Route added in the list

To add or delete a route from the Server, choose the Add Route operation or Delete Routes operation respectively from the Select Operation drop-down menu.

Figure 26: Adding Route

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

Figure 27: Route properties

9. Dashboard

MonitorPerformanceGraphs

The MonitorPerformanceGraphs view under 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 28: Displaying a graph of Time Vs Memory

10. DurableSubscriptions

MonitorDurableSubscription

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 displayed on the top of the table denoting the total number of Durable Subscriptions for the present 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 29: Monitor durable subscriptions

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

Figure 30: Browse Messages operation for durable subscription

ConfigureDurableSubscription

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

11. Connections

MonitorConnections

This view lists all types of connections along with their relevant properties, such as the 'ClientID' of the connection, the 'ClientAddress' which 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 of either creating Producers or Consumers, the 'CreationTime', the 'User' credentials used for creating this connection, the 'Protocol' used, the 'Total PSQSize' and the 'Max PSQSize'. It has three tabs, namely "Connections", "LPC" and "API keys".

A summary is displayed on the top of the table denoting the total number of connections, and then under each category, the total number of PTP/PUBSUB/Admin connections.


Figure 31: MonitorConnections view - Connections tab

Connections

Click any row representing a connection to display the following additional connection information pertaining to that connection:

• 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 32: Connection information

LPC

This tab lists all connections which use the LPC protocol.

Figure 33: MonitorConnections view - LPC tab

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 34: MonitorConnections view - API keys tab

ConfigureConnections

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.

12. Sockets

MonitorSockets

The MonitorSockets view contains information about all the sockets open within the Server at that instant. 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 35: MonitorSockets view

13. Logs

MonitorLogs

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

ConfigureLogs

This view lists all the loggers used in the FioranoMQ Server. Select any particular logger to change its level.

Figure 36: Changing the log level of a particular logger

14. JMX

ConfigureFMQServer

The ConfigureFMQServer view under JMX lists all the Mbeans along with their attributes and operations. Navigate to the specific Mbean and click on it to display its Attributes and Operations (briefed in the following sections). Click the Invoke button to invoke the particular attribute/operation.

Attributes

The Attributes tab lists all the attributes present in the Mbean along with their details such as AttributeName, Type, DefaultValue and isRestartRequired (whether a restart of the Server is required for changes to take effect) and an option to invoke these attributes.

Figure 37: Attributes tab

Operations

This tab lists all the operations present in the Mbean along with their details such as OperationName, Impact, ReturnType, and isRestartRequired (whether a restart of the Server is required for changes to take effect) and an option to invoke these operations.

Figure 38: Operations tab

15. AdvancedProperties

ConfigureAdvancedProperties

The ConfigureAdvancedProperties view under AdvancedProperties contains frequently used properties and their values. For example, the PORT_PROPERTIES tab contains the properties RMIBasedJMXServerPort and JettyServerPort. These two ports and the JMS Server listening port (which is represented by the property "SocketAcceptorPort" listed in the ConnectionManager__1 tab under the CONNECTIONMANAGER_PROPERTIES category) need to be unique for running multiple instances of the server on the same IPAddress. All of these values can be modified.

Figure 39: PORT_PROPERTIES tab in the AdvancedProperties view

16. Licenses

MonitorLicense

The MonitorLicense view displays information about all the licenses available. Selecting a license lists its corresponding license information below.

Figure 40: License information

17. SystemProperties

SystemProperties

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

Figure 41: System Properties