JBoss.orgCommunity Documentation
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
→ . 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:
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.
In the top, at the summary section the Type, Version and State of the server is shown.
By accessing the MONITOR tab it's possible to see a graph showing the availability of the server over time.
By accessing the INVENTORY tab a table presenting the installed components and deployable units is shown.
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 Yes in Detailed Discovery and run the discovery by clicking the button.
→ . SelectIn 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 , the following page will be shown:
Click the
button, a new browser window will be shown to upload the JAIN SLEE Deployable Unit. Click , select the Deployable Unit to be installed, click to confirm and close this browser window.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).
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
. 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 . A confirmation dialog be displayed. The success of the operation will be shown on the main view.
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:
Change Slee State Parameters
start - Changes SLEE State to RUNNING state.
stop - Changes SLEE State to STOPPED state.
shutdown - Completely shutsdown SLEE. Requires to be in STOPPED state.
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 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).
executes (ifFor monitoring purposes it is possible to have all JAIN SLEE Activity Contexts listed. This can be done with List all Activity Context operation, in OPERATIONS tab.
This action takes no parameters.
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 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).
executes (ifThe result is presented in the following form:
In order to clean dead Activities, it's possible to query Activity Context for their liveness. This can be done using Query Activity Context Liveness operation, in OPERATIONS tab.
This action takes no parameters.
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 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).
executes (ifIt is possible to switch the JAIN SLEE container logging configuration for better fitting the needs of the container. This can be done using Change Global Logging Profile operation, in OPERATIONS tab. It can be switched between three levels:
Logging Configuration Levels
DEFAULT: Regular logging, at INFO level, displaying most user-related messages;
DEBUG: More verbose logging, mostly using DEBUG/TRACE level, displaying message of interest for developers;
PRODUCTION: Low verbosity and async logging, mostly in WARN level, for systems in production so that logging does impact performance.
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 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).
executes (ifThis changes the whole container logging configuration, so it will affect also logging for other running applications in the container, besides JAIN SLEE.
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:
Logging Configuration Levels
CURRENT: will retrieve the logging configuration currently in use by the container (can be a custom one);
DEFAULT: will retrieve the DEFAULT logging configuration;
DEBUG: will retrieve the DEBUG logging configuration;
PRODUCTION: will retrieve the PRODUCTION logging configuration;
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.
Currently there's a limitation on 2000 characters for the logging files, so caution should be used not to pass this limit when editing.
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.
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 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).
executes (ifEditing the DEFAULT, DEBUG or PRODUCTION configurations does not apply them, even if they are currently being used. It only edits the configuration template. To edit the configuration being used, select the CURRENT configuration.
The JBoss Operations Network JAIN SLEE platform enables you to gather statistics on it's Event Router. With the View Event Router Statistics operation, in OPERATIONS tab it's possible to view them in a table form.
The statistics can be filtered by the following levels:
Event Router Statistics Filters
Global: Shows the container global statistics for all executors and event types (eg: container total number of events routed, activities mapped, etc.);
Executors: Shows the statistics per each executor (eg: activities mapped per executor, average routing time per executor, idle time per executor, etc.);
Event Types: Shows the statistics per each event type deployed (eg: average routing time per event type, number of events of that type routed, etc.);
Executors and Event Types: Shows the combined statistics of Executors with Event Types (eg: number of events of certain type router per each executor, average time for routing a certain event type by each executor, total time spent per each executor routing certain event types, etc.);
All: All the above together.
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 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).
executes (ifThe JBoss Operations Network JAIN SLEE platform provides congestion control mechanisms to prevent the server to become unresponsive under very high load.
The following parameters are available for configuration and the correspondent set operations (CC-Set<parameter>) can be found under OPERATIONS tab:
Congestion Control Parameters
MinFreeMemoryToTurnOn: The minimum memory (percentage) that should be available to turn on congestion control;
MinFreeMemoryToTurnOff: The minimum memory (percentage) that should be available to turn off congestion control;
PeriodBetweenChecks: The period in seconds to check if congestion control state should change. 0 means congestion control is off;
RefuseStartActivity: Defines if the start of activity should be refused, when congestion control is on;
RefuseFireEvent: Defines if the firing of an event should be refused, when congestion control is on;
As any operation on JBoss Operations Network, these operations can be scheduled for a later time, have a defined timeout and/or include additional notes.
Clicking on the 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).
executes (ifIn the top, at the summary section, some details regarding the Deployable Unit can be seen, such as the Type, Parent Component (JSLEE Server) and the date it was deployed on, in Description.
By accessing the MONITOR tab it's possible to see a graph showing the availability of the deployable unit over time.
For a deployable unit, availability refers to whether the DU was or not installed. It only works for deployable units with the same name.
The only operation available for Deployment Units is to view the IDs of the components that it contains, it can be done by executing the List Component IDs operation.
This action takes no parameters.
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 Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on it shows the result(s).
executes (ifThe result is presented in the following form:
In the top, at the summary section, some details regarding the Resource Adaptor can be seen, such as the Component ID (in Description), the Resource Adaptor Type it implements and its Parent Component (JSLEE Server).
By accessing the MONITOR tab it's possible to see a graph showing the availability of the Resource Adaptor over time.
Under the MONITOR tab it's also possible to view how many Entities from this RA have been active over time.
In the INVENTORY tab it's possible to View, Create and Remove Resource Adaptor Entities.
To create a RA Entity, select ResourceAdaptorEntity on the Create New: option box and click , the following page will be shown:
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 , which will present the following screen:
After adding the properties, click the
button and the new RA Entity will be created. The success of the operation will be shown in the main view.To remove a RA Entity, check it on the INVENTORY tab and click the on the button. A confirmation dialog be displayed. The success of the operation will be shown in the main view.
Under the CONFIGURATION tab Resource Adaptor properties can be defined, changed and or removed.
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).
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.
By accessing the MONITOR tab it's possible to see a graph showing the availability of the Resource Adaptor Entity over time.
Under the MONITOR tab it's also possible to view how many Activities this RA Entity is responsible for, over time.
In the INVENTORY tab it's possible to View, Create and Remove Resource Adaptor Entity Links.
To create a RA Entity Link, select ResourceAdaptorEntityLink on the Create New: option box and click , the following page will be shown:
Fill the Resource Name and Link Name with the desired new entity link name. Click the button and the new RA Entity will be created. The success of the operation will be shown in the main view.
To remove a RA Entity, check it on the INVENTORY tab and click the on the button. A confirmation dialog be displayed. The success of the operation will be shown in the main view.
Figure 3.24. Removing a Resource Adaptor Entity Link with JBoss Operations Network JAIN SLEE Plugin.
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:
Change Ra Entity State Parameters
Activate - Activate the RA Entity.
Deactivate - Deactivate the RA Entity.
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 Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on it shows the result(s).
executes (ifIt's possible to view the Activity Contexts owned by this RA Entity, with the operation named List Activity Context on the OPERATIONS tab.
This action takes no parameters.
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 Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on it shows the result(s).
executes (ifThe result is presented in the following form:
In the top, at the summary section, some details regarding the Resource Adaptor Entity Link can be seen, such as the Resource Adaptor Entity it belongs to (in Description).
By accessing the MONITOR tab it's possible to see a graph showing the availability of the Resource Adaptor Entity Link over time.
In the OPERATIONS tab, an operation to list all SBBs bound to a specific link is available, named List bound Sbbs.
This action takes no parameters.
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 Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on it shows the result(s).
executes (ifThe result is presented in the following form:
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).
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.
By accessing the MONITOR tab it's possible to see a graph showing the availability of the SBB over time.
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).
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.
By accessing the MONITOR tab it's possible to see a graph showing the availability of the Service over time.
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:
Change Service State Parameters
Activate - Activate the Service.
Deactivate - Deactivate the Service.
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 Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on it shows the result(s).
executes (ifIn the OPERATIONS tab, an operation to list all SBB Entities belonging to a specific service is available, named Retrieve Sbb Entities.
This action takes no parameters.
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 Immediately is selected) or schedules the operation. After being executed, it's shown in HISTORY, Completed Operations. Clicking on it shows the result(s).
executes (ifThe result is presented in the following form:
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.
In the SUMMARY tab, some of the metrics for the executors are shown along with the corresponding graphs. Also, latest Out-of-Bound metrics and Alerts are displayed.
By accessing the MONITOR tab it's possible to see a lot of metrics for each executor:
Activities Mapped: Total activities mapped for all the event router executors
Activities Mapped per Minute: Total activities mapped for all the event router executors
Average Event Routing Time: Average time spent to route one event (in ms)
Executed Tasks: Number of tasks executed, which is the sum of the events routed for each EventTypeID, and also the misc tasks executed
Executed Tasks per Minute: Same as above, per minute
Executing Time: Time spent on executing tasks, which is the sum of the time spent routing events for each EventTypeID, and also the time spent executing the misc tasks.
Executing Time per Minute: Same as above, per minute
Idle Time: Total time the executor was idle, i.e., not executing tasks
Idle Time per Minute: Same as above, per minute
Misc Tasks Executed: Number of misc tasks executed
Misc Tasks Executed per Minute: Same as above, per minute
Misc Tasks Executing Time: Time spent executing misc tasks.
Misc Tasks Executing Time per Minute: Same as above, per minute
This metrics can also be seen in a table, in the TABLES sub-menu, in MONITOR tab.
The "... per Minute" metrics are calculated by JBoss Operations Network so, they may not be accurate for container lifetime, ie, they are based on values gathered while JBoss Operations Network agent is running.
It is possible to enable and disable metrics and also set the collection interval by accessing the SCHEDULES sub-menu, in MONITOR tab.