JBoss.orgCommunity Documentation

Chapter 3. Managing JBoss Communications JAIN SLEE with JBoss Operations Network

3.1. JBoss Operations Network JAIN SLEE Plugin Main View
3.2. Managing and Monitoring JAIN SLEE Container
3.2.1. View JAIN SLEE Server Version and State
3.2.2. Monitor JAIN SLEE Availability over time
3.2.3. View installed JAIN SLEE Components
3.2.4. Install/Uninstall JAIN SLEE Deployable Units
3.2.5. Start/Stop/Shutdown JBoss Communications JAIN SLEE Server
3.2.6. List All Activity Contexts
3.2.7. Query Activity Context Liveness
3.2.8. Change Container Logging Configuration
3.2.9. Edit Container Logging Configurations
3.2.10. View Event Router Statistics
3.2.11. Managing Congestion Control
3.3. Managing and Monitoring JAIN SLEE Deployable Units
3.3.1. View JAIN SLEE Deployable Unit Summary
3.3.2. Monitor JAIN SLEE DU Availability over time
3.3.3. List Component IDs
3.4. Managing and Monitoring JAIN SLEE Resource Adaptors
3.4.1. View JAIN SLEE Resource Adaptor Summary
3.4.2. Monitor JAIN SLEE RA Availability over time
3.4.3. Monitor JAIN SLEE RA Active Entities over time
3.4.4. View, Create and Remove Resource Adaptor Entities
3.4.5. Configure a Resource Adaptor
3.5. Managing and Monitoring JAIN SLEE Resource Adaptor Entities
3.5.1. View Resource Adaptor Entity Summary
3.5.2. Monitor JAIN SLEE RA Entity Availability over time
3.5.3. Monitor JAIN SLEE RA Entity Activities over time
3.5.4. View, Create and Remove Resource Adaptor Entity Links
3.5.5. Configure a Resource Adaptor Entity
3.5.6. Activate/Deactivate RA Entity
3.5.7. List Activity Context
3.6. Managing and Monitoring JAIN SLEE Resource Adaptor Entity Links
3.6.1. View Resource Adaptor Entity Link Summary
3.6.2. Monitor JAIN SLEE RA Entity Link Availability over time
3.6.3. List SBBs bound to RA Entity Link
3.7. Managing and Monitoring JAIN SLEE Service Building Blocks (SBBs)
3.7.1. View SBB Summary
3.7.2. Monitor JAIN SLEE SBB Availability over time
3.8. Managing and Monitoring JAIN SLEE Services
3.8.1. View Service Summary
3.8.2. Monitor JAIN SLEE Service Availability over time
3.8.3. Activate/Deactivate a JAIN SLEE Service
3.8.4. Retrieve SBB Entities
3.9. Monitoring JAIN SLEE Event Router Executors
3.9.1. View Event Router Executors Summary
3.9.2. Monitor Event Router Executors metrics

This section describes the main view of JBoss Operations Network JAIN SLEE Plugin.

In order to access this, go to the top menu and select ResourcesServers. A list should be presented, where JAIN SLEE server is present. Click it to access server details.

You should have something similar to the following figure:

Figure 3.1. JBoss Operations Network JAIN SLEE Plugin Main View.


As you can see in the left side menu you have the following components that can be managed by JBoss Operations Network:

  • Deployable Units

  • Resource Adaptors

  • SBBs

  • Services

Each one will be described and explained in it's own section.

Not a component of JAIN SLEE itself, but as a crucial part of it's core is the Event Router and it's Executors. This component is also described in it's own section.

By accessing the INVENTORY tab a table presenting the installed components and deployable units is shown.

Figure 3.4. JBoss Operations Network JAIN SLEE Plugin Inventory View.


Components deployed outside JBoss Operations Network

If components are installed outside JBoss Operations Network, after JBoss Operations Network Agent is started, the list of installed components will not be updated in a reasonable time.

For performance reasons, JBoss Operations Network servers childs (such as Deployable Units, Resource Adaptors, SBBs and Services in SLEE) are checked for changes every 24 hours.

To force a service discovery, there are two options:

  • In the JBoss Operations Network web app, right-click the root item (Platform) of the JAIN SLEE Server and select Execute OperationManual Autodiscovery. Select Yes in Detailed Discovery and run the discovery by clicking the SCHEDULE button.

  • In the JBoss Operations Network agent console, run a full discovery, by issuing the following command:

    > discovery -f

In the INVENTORY tab it's possible to Install/Uninstall JAIN SLEE Deployable Units.

In order to install a deployable unit, select DeployableUnits on the Create New: option box and click OK, the following page will be shown:

Figure 3.5. Installing a Deployable Unit with JBoss Operations Network JAIN SLEE Plugin.


Click the UPLOAD FILE... button, a new browser window will be shown to upload the JAIN SLEE Deployable Unit. Click Add..., select the Deployable Unit to be installed, click Upload to confirm and close this browser window.

Warning

You browser might ask you if you want to resend the information. Please accept it. Google Chrome browser may not support this operation!

Back on the main window for installing the DU, select either to do a persistent deploy (copy file to deploy folder) or not (simply call install on the DU).

Persistent vs JMX Deployment

When doing a persistent deployment, further installation actions are automatically performed by the JBoss Communications JAIN SLEE Deployer. If the DU is not deployed in a persistent way (JMX), component installation actions (such as Resource Adaptor entities creation, activation, Service activation) should be performed manually.

To confirm the deployment, click CREATE. The success of the operation should be displayed on the main view.

To uninstall a deployable unit, simply check the desired installed deployable unit on the INVENTORY tab and press DELETE. A confirmation dialog be displayed. The success of the operation will be shown on the main view.

Figure 3.6. Uninstalling a Deployable Unit with JBoss Operations Network JAIN SLEE Plugin.


Persistent vs JMX Undeployment

When undeploying a DU it's automatically detected either if it is to do a Persistent (file is deleted from the deploy folder!) or a non Persistent undeployment, where only the uninstall command is called on the DU, requiring prior uninstalling actions (eg: remove RA Links and Entities) to have already been performed.

Under the OPERATIONS tab, an operation for Changing the JAIN SLEE container state can be found: Change Slee State.

Clicking on the operation, a new pane opens so the parameters can be selected:

Figure 3.7. Changing JAIN SLEE State.


Change Slee State Parameters

Action (required)
  • start - Changes SLEE State to RUNNING state.

  • stop - Changes SLEE State to STOPPED state.

  • shutdown - Completely shutsdown SLEE. Requires to be in STOPPED state.

Note

As any operation on JBoss Operations Network, this operation can be scheduled for a later time, have a defined timeout and/or include additional notes.

Clicking on the SCHEDULE executes (if Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on its name shows the result(s).

It is possible to customize the above mentioned logging configurations, or also the currently in use container logging configuration. To perform this action, two operations should be executed:

First, to retrieve the current logging configuration, the Get Logging Profile Configuration operation, in OPERATIONS tab should be used. One of the following options should be selected:

After being executed, it's shown in HISTORY, Completed Operations. Clicking on its name shows the result, which is the actual logging configuration.

The result of the operation should be copied into your favourite XML editor and edited as desired.

When the editing is completed, the Update Logging Profile Configuration operation should be used to update the logging configuration contents.

Select the desired configuration to be updated from the similar list as presented above, and paste the edited contents in the Contents field of the operation.

Clicking on the SCHEDULE executes (if Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on its name shows the result(s).

By accessing the MONITOR tab it's possible to see a graph showing the availability of the deployable unit over time.

Figure 3.10. JBoss Operations Network JAIN SLEE Deployable Unit Availability View.


Deployable Unit Availability Feature

For a deployable unit, availability refers to whether the DU was or not installed. It only works for deployable units with the same name.

In the INVENTORY tab it's possible to View, Create and Remove Resource Adaptor Entities.

Figure 3.14. Resource Adaptor Entities Listing


To create a RA Entity, select ResourceAdaptorEntity on the Create New: option box and click OK, the following page will be shown:

Figure 3.15. Create New Resource Adaptor Entity


Fill the Resource Name and Entity Name with the desired new entity name. If desired, provide extra properties for the entity in the Properties table by clicking Add New, which will present the following screen:

Figure 3.16. Add Property to New Resource Adaptor Entity


After adding the properties, click the SUBMIT button and the new RA Entity will be created. The success of the operation will be shown in the main view.

In the top, at the summary section, some details regarding the Resource Adaptor Entity can be seen, such as the Resource Adaptor it belongs to (in Description), the current State and its Parent Component (Resource Adaptor).

Figure 3.19. Resource Adaptor Entity Summary View.


Change State/Metrics update interval

By default, State property (as other metric values) is updated every 10 minutes. To set it to a shorter value (minimum: 30 seconds) go to SCHEDULES sub-menu under MONITOR tab, check the desired option(s), enter the desired amount of time in the Collection Interval textbox, select the units (seconds, minutes, hours) and click SET.

Figure 3.20. Change Collection Interval value for measurements.


In the INVENTORY tab it's possible to View, Create and Remove Resource Adaptor Entity Links.

Figure 3.22. Resource Adaptor Entity Links Listing


To create a RA Entity Link, select ResourceAdaptorEntityLink on the Create New: option box and click OK, the following page will be shown:

Figure 3.23. Create New Resource Adaptor Entity Link


Fill the Resource Name and Link Name with the desired new entity link name. Click the SUBMIT button and the new RA Entity will be created. The success of the operation will be shown in the main view.

Under the CONFIGURATION tab Resource Adaptor Entity properties can be defined, changed and or removed.

Figure 3.25. Configuring a Resource Adaptor Entity with JBoss Operations Network JAIN SLEE Plugin.


In the OPERATIONS tab, an operation to Activate/Deactivate the RA Entity is available, named Change Ra Entity State.

Clicking on the operation, a new pane opens so the parameters can be selected:

Figure 3.26. Changing the Resource Adaptor Entity State.


Change Ra Entity State Parameters

Action (required)
  • Activate - Activate the RA Entity.

  • Deactivate - Deactivate the RA Entity.

Note

As any operation on JBoss Operations Network, this operation can be scheduled for a later time, have a defined timeout and/or include additional notes.

Clicking on the SCHEDULE executes (if Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on it shows the result(s).

In the top, at the summary section, some details regarding the SBB can be seen, such as the Component ID (in Description), the Version, the State Code (UP/DOWN) and its Parent Component (JSLEE Server).

Figure 3.31. SBB Summary View.


Change State/Metrics update interval

By default, State property (as other metric values) is updated every 10 minutes. To set it to a shorter value (minimum: 30 seconds) go to SCHEDULES sub-menu under MONITOR tab, check the desired option(s), enter the desired amount of time in the Collection Interval textbox, select the units (seconds, minutes, hours) and click SET.

Figure 3.32. Change Collection Interval value for measurements.


In the top, at the summary section, some details regarding the Service can be seen, such as the Component ID (in Description), the Version, the State and its Parent Component (JSLEE Server).

Figure 3.34. Service Summary View.


Change State/Metrics update interval

By default, State property (as other metric values) is updated every 10 minutes. To set it to a shorter value (minimum: 30 seconds) go to SCHEDULES sub-menu under MONITOR tab, check the desired option(s), enter the desired amount of time in the Collection Interval textbox, select the units (seconds, minutes, hours) and click SET.

Figure 3.35. Change Collection Interval value for measurements.


Under the OPERATIONS tab, an operation for changing the state of the service can be found: Change Service State.

Clicking on the operation, a new pane opens so the parameters can be selected:

Figure 3.37. Changing Service State.


Change Service State Parameters

Action (required)
  • Activate - Activate the Service.

  • Deactivate - Deactivate the Service.

Note

As any operation on JBoss Operations Network, this operation can be scheduled for a later time, have a defined timeout and/or include additional notes.

Clicking on the SCHEDULE executes (if Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on it shows the result(s).

Event Router Executors are the heart of the JAIN SLEE Core, they are responsible for executing critical tasks for the container.

In order to have a better view over the JAIN SLEE container health, a few metrics are made available in this section.

By accessing the MONITOR tab it's possible to see a lot of metrics for each executor:

This metrics can also be seen in a table, in the TABLES sub-menu, in MONITOR tab.

It is possible to enable and disable metrics and also set the collection interval by accessing the SCHEDULES sub-menu, in MONITOR tab.