JBoss Operations Network 2.4

Resource Monitoring and Operations Reference

a complete reference for monitoring metrics, operations, and configuration options

Edition 1

Logo

Red Hat Engineering Content Services

Legal Notice

Copyright © 2010 Red Hat, Inc..
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack Logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
July 29, 2010 

Abstract

This is a reference for all monitoring checks available for the default resources handled in JBoss Operations Network 2.4, as well as available resource operations.
Preface
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. We need feedback
3. Document History
1. Managed Platforms
1.1. AIX Platform
1.2. FreeBSD Platform
1.3. HP-UX Platform
1.4. Java Platform
1.5. Linux Platform
1.6. Mac OS X Platform
1.7. Solaris Platform
1.8. Windows Platform
1.9. Services Managed on Platforms
1.9.1. CPU Service
1.9.2. File System Service
1.9.3. Network Adapter Service
1.9.4. Process Service
2. Managed Servers
2.1. Configuring Apache for Monitoring
2.1.1. Configuring the Response Time Module for Apache 1.3
2.1.2. Configuring the Response Time Module for Apache 2.x
2.1.3. Configuring the Apache SNMP Module
2.2. Apache HTTP Server
2.2.1. Apache Virtual Host Service
2.2.2. Mod JK Service
2.3. ESB Service
2.3.1. Deployment
2.3.2. Services
2.3.3. Gateways
2.3.4. Listeners
2.3.5. Actions
2.4. ESB 5 Service
2.4.1. Deployment
2.4.2. Services
2.4.3. Gateways
2.4.4. Listeners
2.4.5. Actions
2.5. Hibernate Statistics Service
2.5.1. Hibernate Entity Service
2.6. IIS Server
2.6.1. VHost Service
2.7. JBoss AS 4.x
2.7.1. ConnectionFactory Service
2.7.2. Datasource Service
2.7.3. EJB3 Entity Tree Cache Service
2.7.4. EJB3 Session Bean Service
2.7.5. Embedded Tomcat Server
2.7.6. Enterprise Application (EAR) Service
2.7.7. Entity EJB Service
2.7.8. JBossMessaging Service
2.7.9. JBossMQ Service
2.7.10. Message Driven EJB Service
2.7.11. Script Service
2.7.12. Stateful Session EJB Service
2.7.13. Stateless Session EJB Service
2.7.14. Web Application (WAR) Service
2.8. JBoss AS 5.x
2.8.1. EJB2 JAR Service
2.8.2. EJB2 Entity Bean (Embedded) Service
2.8.3. EJB2 Message-Driven Bean (Embedded) Service
2.8.4. EJB2 Stateful Session Bean (Embedded) Service
2.8.5. EJB2 Stateless Session Bean (Embedded) Service
2.8.6. EJB3 JAR Service
2.8.7. EJB3 Message-Driven Bean (Embedded) Service
2.8.8. EJB3 Stateful Session Bean (Embedded) Service
2.8.9. EJB3 Stateless Session Bean (Embedded) Service
2.8.10. Embedded EJB2 JAR Service
2.8.11. Embedded EJB3 JAR Service
2.8.12. Embedded Resource Adapter Archive (RAR) Service
2.8.13. Embedded Web Application (WAR) Service
2.8.14. Enterprise Application (EAR) Service
2.8.15. JBoss Messaging Service
2.8.16. JBoss Web Service
2.8.17. Local Tx Datasource Service
2.8.18. No Tx ConnectionFactory Service
2.8.19. No Tx Datasource Service
2.8.20. Resource Adapter Archive (RAR) Service
2.8.21. Script Service
2.8.22. Service Binding Manager Service
2.8.23. Tx ConnectionFactory Service
2.8.24. Web Application (WAR) Service
2.8.25. XA Datasource Service
2.9. JBossCacheSubsystem Server
2.9.1. JBossCache Service
2.10. JBoss Cache Service 3
2.10.1. Data Container Service
2.10.2. Interceptor Service
2.10.3. Lock Manager Service
2.10.4. RegionManager Service
2.10.5. RPC Manager Service
2.10.6. Transaction Table Service
2.10.7. Tx Interceptor Service
2.11. JMX Server
2.11.1. java.util.logging Service
2.11.2. Operating System Service
2.11.3. Threading Service
2.11.4. VM Class Loading System Service
2.11.5. VM Compilation System Service
2.11.6. VM Memory System Service
2.12. JMS Manager Service
2.12.1. JMS Connection Factory Service
2.12.2. JMS Queue Service
2.12.3. JMS Topic Service
2.13. Postgres Server
2.13.1. Database Service
2.13.2. User Service
2.14. RHQ Agent Server
2.14.1. Environment Setup Script Service
2.14.2. Java Service Wrapper Launcher Service
2.14.3. Launcher Script Service
2.14.4. Measurement Subsystem Service
2.14.5. Plugin Container Service
2.15. Tomcat Server
2.15.1. Tomcat Connector Service
2.15.2. Tomcat User Database Service
2.15.3. Tomcat Virtual Host Service

Preface

1. Document Conventions

This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.
In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later include the Liberation Fonts set by default.

1.1. Typographic Conventions

Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows.
Mono-spaced Bold
Used to highlight system input, including shell commands, file names and paths. Also used to highlight keys and key combinations. For example:
To see the contents of the file my_next_bestselling_novel in your current working directory, enter the cat my_next_bestselling_novel command at the shell prompt and press Enter to execute the command.
The above includes a file name, a shell command and a key, all presented in mono-spaced bold and all distinguishable thanks to context.
Key combinations can be distinguished from an individual key by the plus sign that connects each part of a key combination. For example:
Press Enter to execute the command.
Press Ctrl+Alt+F2 to switch to a virtual terminal.
The first example highlights a particular key to press. The second example highlights a key combination: a set of three keys pressed simultaneously.
If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in mono-spaced bold. For example:
File-related classes include filesystem for file systems, file for files, and dir for directories. Each class has its own associated set of permissions.
Proportional Bold
This denotes words or phrases encountered on a system, including application names; dialog box text; labeled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:
Choose SystemPreferencesMouse from the main menu bar to launch Mouse Preferences. In the Buttons tab, select the Left-handed mouse check box and click Close to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand).
To insert a special character into a gedit file, choose ApplicationsAccessoriesCharacter Map from the main menu bar. Next, choose SearchFind… from the Character Map menu bar, type the name of the character in the Search field and click Next. The character you sought will be highlighted in the Character Table. Double-click this highlighted character to place it in the Text to copy field and then click the Copy button. Now switch back to your document and choose EditPaste from the gedit menu bar.
The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in proportional bold and all distinguishable by context.
Mono-spaced Bold Italic or Proportional Bold Italic
Whether mono-spaced bold or proportional bold, the addition of italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example:
To connect to a remote machine using ssh, type ssh username@domain.name at a shell prompt. If the remote machine is example.com and your username on that machine is john, type ssh john@example.com.
The mount -o remount file-system command remounts the named file system. For example, to remount the /home file system, the command is mount -o remount /home.
To see the version of a currently installed package, use the rpm -q package command. It will return a result as follows: package-version-release.
Note the words in bold italics above — username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system.
Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example:
Publican is a DocBook publishing system.

1.2. Pull-quote Conventions

Terminal output and source code listings are set off visually from the surrounding text.
Output sent to a terminal is set in mono-spaced roman and presented thus:
books        Desktop   documentation  drafts  mss    photos   stuff  svn
books_tests  Desktop1  downloads      images  notes  scripts  svgs
Source-code listings are also set in mono-spaced roman but add syntax highlighting as follows:
package org.jboss.book.jca.ex1;

import javax.naming.InitialContext;

public class ExClient
{
   public static void main(String args[]) 
       throws Exception
   {
      InitialContext iniCtx = new InitialContext();
      Object         ref    = iniCtx.lookup("EchoBean");
      EchoHome       home   = (EchoHome) ref;
      Echo           echo   = home.create();

      System.out.println("Created Echo");

      System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
   }
}

1.3. Notes and Warnings

Finally, we use three visual styles to draw attention to information that might otherwise be overlooked.

Note

Notes are tips, shortcuts or alternative approaches to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a trick that makes your life easier.

Important

Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring a box labeled 'Important' will not cause data loss but may cause irritation and frustration.

Warning

Warnings should not be ignored. Ignoring warnings will most likely cause data loss.

2. We need feedback

To see all outstanding issues regarding this guide, please visit: https://jira.jboss.org/jira/browse/JOPR
If you find a typographical error in the Managed Resources Guide, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA: https://jira.jboss.org/jira/browse/JOPR against the component Documentation.
If you do have a suggestion for improving the documentation, try and be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.

3. Document History

Revision History
Revision 1-6.4002013-10-31Rüdiger Landmann
Rebuild with publican 4.0.0
Revision 1-62012-07-18Anthony Towns
Rebuild for Publican 3.0
Revision 2.4-0July 29, 2010Ella Deon Lackey
Initial release of JBoss Operations Network 2.4

Chapter 1. Managed Platforms

JBoss Operations Network 2.4 uses plug-ins to support all of its resource types. Each platform that can be monitored, configured, and managed through JBoss ON has a corresponding agent plug-in that enables JBoss ON to manage it. the list products and projects. Other platforms, servers, and applications can be monitored through JBoss ON by writing custom plug-ins to allow JBoss ON to detect and control them. For more information on writing agent plug-ins, see the JBoss Operations Network Plug-in Writing Guide.

1.1. AIX Platform

Overview

Table 1.1. Overview

Description: IBM AIX Operating System
Singleton: no
Plugin: Platforms

Parent Resource Types

none

Child Resource Types

Connection Properties

none

Metrics

Table 1.2. Metrics

Name Type Description Internal Name
Free Memory measurement The total free system memory Native.MemoryInfo.free
Used Memory measurement The total used system memory Native.MemoryInfo.used
Total Memory measurement The total system memory Native.MemoryInfo.total
Free Swap Space measurement The total free system swap Native.SwapInfo.free
Used Swap Space measurement The total used system swap Native.SwapInfo.used
Total Swap Space measurement The total system swap Native.SwapInfo.total
Idle measurement Idle percentage of all CPUs CpuPerc.idle
System Load measurement Percentage of all CPUs running in system mode CpuPerc.sys
User Load measurement Percentage of all CPUs running in user mode CpuPerc.user
Wait Load measurement Percentage of all CPUs waiting on I/O CpuPerc.wait
Hostname trait Name that this platform is known as Trait.hostname
OS Name trait Name that the operating system is known as Trait.osname
OS Version trait Version of the operating system Trait.osversion
Architecture trait Hardware architecture of the platform Trait.sysarch

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 1.3. Metrics

Name Description
Manual Autodiscovery Run an immediate discovery to search for resources
View Process List View running processes on this system

Package Types

none

1.2. FreeBSD Platform

Overview

Table 1.4. Overview

Description: FreeBSD Operating System
Singleton: no
Plugin: Platforms

Parent Resource Types

none

Child Resource Types

Connection Properties

none

Metrics

Table 1.5. Metrics

Name Type Description Internal Name
Free Memory measurement The total free system memory Native.MemoryInfo.free
Used Memory measurement The total used system memory Native.MemoryInfo.used
Total Memory measurement The total system memory Native.MemoryInfo.total
Free Swap Space measurement The total free system swap Native.SwapInfo.free
Used Swap Space measurement The total used system swap Native.SwapInfo.used
Total Swap Space measurement The total system swap Native.SwapInfo.total
Idle measurement Idle percentage of all CPUs CpuPerc.idle
System Load measurement Percentage of all CPUs running in system mode CpuPerc.sys
User Load measurement Percentage of all CPUs running in user mode CpuPerc.user
Wait Load measurement Percentage of all CPUs waiting on I/O CpuPerc.wait
Hostname trait Name that this platform is known as Trait.hostname
OS Name trait Name that the operating system is known as Trait.osname
OS Version trait Version of the operating system Trait.osversion
Architecture trait Hardware architecture of the platform Trait.sysarch

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 1.6. Metrics

Name Description
Manual Autodiscovery Run an immediate discovery to search for resources
View Process List View running processes on this system

Package Types

none

1.3. HP-UX Platform

Overview

Table 1.7. Overview

Description: Hewlett-Packard HP-UX Operating System
Singleton: no
Plugin: Platforms

Parent Resource Types

none

Child Resource Types

Connection Properties

none

Metrics

Table 1.8. Metrics

Name Type Description Internal Name
Free Memory measurement The total free system memory Native.MemoryInfo.free
Used Memory measurement The total used system memory Native.MemoryInfo.used
Total Memory measurement The total system memory Native.MemoryInfo.total
Free Swap Space measurement The total free system swap Native.SwapInfo.free
Used Swap Space measurement The total used system swap Native.SwapInfo.used
Total Swap Space measurement The total system swap Native.SwapInfo.total
Idle measurement Idle percentage of all CPUs CpuPerc.idle
System Load measurement Percentage of all CPUs running in system mode CpuPerc.sys
User Load measurement Percentage of all CPUs running in user mode CpuPerc.user
Wait Load measurement Percentage of all CPUs waiting on I/O CpuPerc.wait
Hostname trait Name that this platform is known as Trait.hostname
OS Name trait Name that the operating system is known as Trait.osname
OS Version trait Version of the operating system Trait.osversion
Architecture trait Hardware architecture of the platform Trait.sysarch

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 1.9. Metrics

Name Description
Manual Autodiscovery Run an immediate discovery to search for resources
View Process List View running processes on this system

Package Types

none

1.4. Java Platform

Overview

Table 1.10. Overview

Description: Platform with 100% Java capability but not natively supported
Singleton: no
Plugin: Platforms

Parent Resource Types

none

Child Resource Types

Connection Properties

none

Metrics

Table 1.11. Metrics

Name Type Description Internal Name
Hostname trait Name that this platform is known as Trait.hostname
OS Name trait Name that the operating system is known as Trait.osname
OS Version trait Version of the operating system Trait.osversion
Architecture trait Hardware architecture of the platform Trait.sysarch

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 1.12. Metrics

Name Description
Manual Autodiscovery Run an immediate discovery to search for resources
View Process List View running processes on this system

Package Types

none

1.5. Linux Platform

Overview

Table 1.13. Overview

Description: Linux Operating System
Singleton: no
Plugin: Platforms

Parent Resource Types

none

Child Resource Types

Connection Properties

Table 1.14. 

Name Description Required Internal Name
Enable Content Discovery If true, attempts will be made to discover installed packages on this platform yes enableContentDiscovery
Enable Internal Yum Server If true, an internal yum server will be started in order to process yum content requests made on the local machine. yes enableInternalYumServer
Yum server port The port the plugin will listen on in order to process yum requests. This is ignored if the internal yum server is not enabled. yes yumPort
Metadata Cache Timeout The time, in seconds, that the package metadata will always be considered valid. After the cache has lived this long or longer, the cache will be checked to see if it is stale, and if so, will be refreshed. no metadataCacheTimeout
Logs yes logs

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 1.15. Metrics

Name Type Description Internal Name
Free Memory measurement The total free system memory Native.MemoryInfo.free
Used Memory measurement The total used system memory Native.MemoryInfo.used
Total Memory measurement The total system memory Native.MemoryInfo.total
Free Swap Space measurement The total free system swap Native.SwapInfo.free
Used Swap Space measurement The total used system swap Native.SwapInfo.used
Total Swap Space measurement The total system swap Native.SwapInfo.total
Idle measurement Idle percentage of all CPUs CpuPerc.idle
System Load measurement Percentage of all CPUs running in system mode CpuPerc.sys
User Load measurement Percentage of all CPUs running in user mode CpuPerc.user
Wait Load measurement Percentage of all CPUs waiting on I/O CpuPerc.wait
Hostname trait Name that this platform is known as Trait.hostname
OS Name trait Name that the operating system is known as Trait.osname
OS Version trait Version of the operating system Trait.osversion
Architecture trait Hardware architecture of the platform Trait.sysarch
Distribution Name trait name of the Linux distribution distro.name
Distribution Version trait version of the Linux distribution distro.version

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 1.16. Metrics

Name Description
Manual Autodiscovery Run an immediate discovery to search for resources
View Process List View running processes on this system
Clean Yum Metadata Cache Deletes all cached package metadata

Package Types

Table 1.17. Package Types

Name Category Description
RPM File Deployable Red Hat installable package

1.6. Mac OS X Platform

Overview

Table 1.18. Overview

Description: Mac OS X Operating System
Singleton: no
Plugin: Platforms

Parent Resource Types

none

Child Resource Types

Connection Properties

none

Metrics

Table 1.19. Metrics

Name Type Description Internal Name
Free Memory measurement The total free system memory Native.MemoryInfo.free
Used Memory measurement The total used system memory Native.MemoryInfo.used
Total Memory measurement The total system memory Native.MemoryInfo.total
Free Swap Space measurement The total free system swap Native.SwapInfo.free
Used Swap Space measurement The total used system swap Native.SwapInfo.used
Total Swap Space measurement The total system swap Native.SwapInfo.total
Idle measurement Idle percentage of all CPUs CpuPerc.idle
System Load measurement Percentage of all CPUs running in system mode CpuPerc.sys
User Load measurement Percentage of all CPUs running in user mode CpuPerc.user
Wait Load measurement Percentage of all CPUs waiting on I/O CpuPerc.wait
Hostname trait Name that this platform is known as Trait.hostname
OS Name trait Name that the operating system is known as Trait.osname
OS Version trait Version of the operating system Trait.osversion
Architecture trait Hardware architecture of the platform Trait.sysarch

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 1.20. Metrics

Name Description
Manual Autodiscovery Run an immediate discovery to search for resources
View Process List View running processes on this system

Package Types

none

1.7. Solaris Platform

Overview

Table 1.21. Overview

Description: SUN Solaris Operating System
Singleton: no
Plugin: Platforms

Parent Resource Types

none

Child Resource Types

Connection Properties

none

Metrics

Table 1.22. Metrics

Name Type Description Internal Name
Free Memory measurement The total free system memory Native.MemoryInfo.free
Used Memory measurement The total used system memory Native.MemoryInfo.used
Total Memory measurement The total system memory Native.MemoryInfo.total
Free Swap Space measurement The total free system swap Native.SwapInfo.free
Used Swap Space measurement The total used system swap Native.SwapInfo.used
Total Swap Space measurement The total system swap Native.SwapInfo.total
Idle measurement Idle percentage of all CPUs CpuPerc.idle
System Load measurement Percentage of all CPUs running in system mode CpuPerc.sys
User Load measurement Percentage of all CPUs running in user mode CpuPerc.user
Wait Load measurement Percentage of all CPUs waiting on I/O CpuPerc.wait
Hostname trait Name that this platform is known as Trait.hostname
OS Name trait Name that the operating system is known as Trait.osname
OS Version trait Version of the operating system Trait.osversion
Architecture trait Hardware architecture of the platform Trait.sysarch

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 1.23. Metrics

Name Description
Manual Autodiscovery Run an immediate discovery to search for resources
View Process List View running processes on this system

Package Types

none

1.8. Windows Platform

Overview

Table 1.24. Overview

Description: Microsoft Windows Operating System
Singleton: no
Plugin: Platforms

Parent Resource Types

none

Child Resource Types

Connection Properties

Table 1.25. 

Name Description Required Internal Name
Enable Content Discovery If true, attempts will be made to discover installed packages on this platform yes enableContentDiscovery
Event Tracking Enabled Enables the collection of Windows events into the event subsystem yes eventTrackingEnabled
Regular Expression A regular expression that if not-null must be matched by the event detail for the message to be accepted no regularExpression
Minimum Severity The minimum severity event that will be collected yes minimumSeverity

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 1.26. Metrics

Name Type Description Internal Name
Free Memory measurement The total free system memory Native.MemoryInfo.free
Used Memory measurement The total used system memory Native.MemoryInfo.used
Total Memory measurement The total system memory Native.MemoryInfo.total
Free Swap Space measurement The total free system swap Native.SwapInfo.free
Used Swap Space measurement The total used system swap Native.SwapInfo.used
Total Swap Space measurement The total system swap Native.SwapInfo.total
Idle measurement Idle percentage of all CPUs CpuPerc.idle
System Load measurement Percentage of all CPUs running in system mode CpuPerc.sys
User Load measurement Percentage of all CPUs running in user mode CpuPerc.user
Wait Load measurement Percentage of all CPUs waiting on I/O CpuPerc.wait
Hostname trait Name that this platform is known as Trait.hostname
OS Name trait Name that the operating system is known as Trait.osname
OS Version trait Version of the operating system Trait.osversion
Architecture trait Hardware architecture of the platform Trait.sysarch

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 1.27. Metrics

Name Description
Manual Autodiscovery Run an immediate discovery to search for resources
View Process List View running processes on this system

Package Types

Table 1.28. Package Types

Name Category Description
Installed Software Deployable Installed Windows Software

1.9. Services Managed on Platforms

1.9.1. CPU Service

Overview

Table 1.29. Overview

Description:
Singleton: no
Plugin: Platforms

Parent Resource Types

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.30. Metrics

Name Type Description Internal Name
Idle measurement Idle percentage of this CPU CpuPerc.idle
System Load measurement Percentage of this CPU running in system mode CpuPerc.sys
User Load measurement Percentage of this CPU running in user mode CpuPerc.user
Wait Load measurement Percentage of this CPU waiting on I/O CpuPerc.wait
User Time measurement The total system CPU user time Cpu.user
User Time per Minute measurement The total system CPU user time Cpu.user
Nice Time measurement The total system CPU nice time Cpu.nice
Nice Time per Minute measurement The total system CPU nice time Cpu.nice
System Time measurement The total system CPU kernel time Cpu.sys
System Time per Minute measurement The total system CPU kernel time Cpu.sys
Idle Time measurement The total system CPU idle time Cpu.idle
Idle Time per Minute measurement The total system CPU idle time Cpu.idle
Wait Time measurement The total system CPU I/O wait time Cpu.wait
Wait Time per Minute measurement The total system CPU I/O wait time Cpu.wait
Vendor trait Vendor of this CPU CpuTrait.vendor
CPU Model trait Model of this CPU CpuTrait.model
CPU Speed trait Speed of this CPU in Mhz CpuTrait.mhz
Cache size trait Cache Size of this CPU CpuTrait.cacheSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

1.9.2. File System Service

Overview

Table 1.31. Overview

Description:
Singleton: no
Plugin: Platforms

Parent Resource Types

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.32. Metrics

Name Type Description Internal Name
Free Space measurement The total free bytes on filesystem fileSystemUsage.free
Used Percentage measurement The percentage of disk used fileSystemUsage.usePercent
Capacity trait The total size of the filesystem fileSystemUsage.total
Volume Type trait The filesystem's generic type name fileSystem.typeName
Drive Type trait The filesystem's operating system-specific type name fileSystem.sysTypeName
name trait The name of this device fileSystem.devName
Free Files measurement The number of free file nodes on the filesystem fileSystemUsage.freeFiles
Flags trait The filesystem's flags fileSystem.flags
Used measurement The total bytes used on the filesystem fileSystemUsage.used
Disk Reads measurement The number of physical disk reads fileSystemUsage.diskReads
Disk Reads per Minute measurement The number of physical disk reads fileSystemUsage.diskReads
Disk Writes measurement The number of physical disk writes fileSystemUsage.diskWrites
Disk Writes per Minute measurement The number of physical disk writes fileSystemUsage.diskWrites
Disk Read Bytes measurement The number of physical disk bytes read fileSystemUsage.diskReadBytes
Disk Read Bytes per Minute measurement The number of physical disk bytes read fileSystemUsage.diskReadBytes
Disk Write Bytes measurement The number of physical disk bytes written fileSystemUsage.diskWriteBytes
Disk Write Bytes per Minute measurement The number of physical disk bytes written fileSystemUsage.diskWriteBytes
Disk Queue measurement The number of I/Os currently in progress fileSystemUsage.diskQueue

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

1.9.3. Network Adapter Service

Overview

Table 1.33. Overview

Description:
Singleton: no
Plugin: Platforms

Parent Resource Types

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.34. Metrics

Name Type Description Internal Name
Inet4Address trait IP address of the network adaptor Trait.net4.address
Interface Flags trait Flag constants for network related ops Trait.interfaceFlags
Bytes Received measurement The total number of bytes received across this network interface since it started rxBytes
Bytes Received per Minute measurement The total number of bytes received across this network interface since it started rxBytes
Packets Received measurement The total number of packets received across this network interface since it started rxPackets
Packets Received per Minute measurement The total number of packets received across this network interface since it started rxPackets
Bytes Transmitted measurement The total number of bytes transmitted across this network interface since it started txBytes
Bytes Transmitted per Minute measurement The total number of bytes transmitted across this network interface since it started txBytes
Packets Transmitted measurement The total number of packets transmitted across this network interface since it started txPackets
Packets Transmitted per Minute measurement The total number of packets transmitted across this network interface since it started txPackets
Receive Errors measurement 'errors' statistic for received packets across this network interface since it started rxErrors
Receive Errors per Minute measurement 'errors' statistic for received packets across this network interface since it started rxErrors
Receive Packets Dropped measurement 'dropped' statistic for received packets across this network interface since it started rxDropped
Receive Packets Dropped per Minute measurement 'dropped' statistic for received packets across this network interface since it started rxDropped
Receive Overrurns measurement 'overruns' statistic for received packets across this network interface since it started rxOverruns
Receive Overrurns per Minute measurement 'overruns' statistic for received packets across this network interface since it started rxOverruns
Receive Frame measurement 'frame' statistic for received packets across this network interface since it started rxFrame
Receive Frame per Minute measurement 'frame' statistic for received packets across this network interface since it started rxFrame
Transmit Errors measurement 'errors' statistic for transmitted packets across this network interface since it started txErrors
Transmit Errors per Minute measurement 'errors' statistic for transmitted packets across this network interface since it started txErrors
Transmit Packets Dropped measurement 'dropped' statistic for transmitted packets across this network interface since it started txDropped
Transmit Packets Dropped per Minute measurement 'dropped' statistic for transmitted packets across this network interface since it started txDropped
Transmit Overruns measurement 'overruns' statistic for transmitted packets across this network interface since it started txOverruns
Transmit Overruns per Minute measurement 'overruns' statistic for transmitted packets across this network interface since it started txOverruns
Transmit Collisions measurement 'collisions' statistic for transmitted packets across this network interface since it started txCollisions
Transmit Collisions per Minute measurement 'collisions' statistic for transmitted packets across this network interface since it started txCollisions
Transmit Carrier measurement 'carrier' statistic for transmitted packets across this network interface since it started txCarrier
Transmit Carrier per Minute measurement 'carrier' statistic for transmitted packets across this network interface since it started txCarrier

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

1.9.4. Process Service

Overview

Table 1.35. Overview

Description: A generic process monitoring service to track native process information based on a pid file or process query
Singleton: no
Plugin: Platforms

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 1.36. 

Name Description Required Internal Name
Type Choice of using a pid file or a PIQL query to find the process to monitor yes type
Pid File Fully qualified path to the pid file for the process to monitor no pidFile
Piql Process Information Query Language for process to monitor no piql
Full Process Tree If true, the entire process tree will be monitored yes fullProcessTree

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 1.37. Metrics

Name Type Description Internal Name
User Time measurement The aggregate amount of CPU user time spent by all processes Process.cpu.user
User Time per Minute measurement The aggregate amount of CPU user time spent by all processes Process.cpu.user
Kernel Time measurement The aggregate amount of CPU kernel time spent by all processes Process.cpu.sys
Kernel Time per Minute measurement The aggregate amount of CPU kernel time spent by all processes Process.cpu.sys
CPU Percentage measurement The percentage of CPU currently being used by all processes Process.cpu.percent
Physical Memory measurement The aggregate amount of resident memory used by all processes Process.memory.resident
Virtual Memory measurement The aggregate amount of virtual memory used by all processes Process.memory.size
Open File Descriptors measurement The aggregate number of file descriptors open by all processes Process.fileDescriptor.total

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

Chapter 2. Managed Servers

2.1. Configuring Apache for Monitoring
2.1.1. Configuring the Response Time Module for Apache 1.3
2.1.2. Configuring the Response Time Module for Apache 2.x
2.1.3. Configuring the Apache SNMP Module
2.2. Apache HTTP Server
2.2.1. Apache Virtual Host Service
2.2.2. Mod JK Service
2.3. ESB Service
2.3.1. Deployment
2.3.2. Services
2.3.3. Gateways
2.3.4. Listeners
2.3.5. Actions
2.4. ESB 5 Service
2.4.1. Deployment
2.4.2. Services
2.4.3. Gateways
2.4.4. Listeners
2.4.5. Actions
2.5. Hibernate Statistics Service
2.5.1. Hibernate Entity Service
2.6. IIS Server
2.6.1. VHost Service
2.7. JBoss AS 4.x
2.7.1. ConnectionFactory Service
2.7.2. Datasource Service
2.7.3. EJB3 Entity Tree Cache Service
2.7.4. EJB3 Session Bean Service
2.7.5. Embedded Tomcat Server
2.7.6. Enterprise Application (EAR) Service
2.7.7. Entity EJB Service
2.7.8. JBossMessaging Service
2.7.9. JBossMQ Service
2.7.10. Message Driven EJB Service
2.7.11. Script Service
2.7.12. Stateful Session EJB Service
2.7.13. Stateless Session EJB Service
2.7.14. Web Application (WAR) Service
2.8. JBoss AS 5.x
2.8.1. EJB2 JAR Service
2.8.2. EJB2 Entity Bean (Embedded) Service
2.8.3. EJB2 Message-Driven Bean (Embedded) Service
2.8.4. EJB2 Stateful Session Bean (Embedded) Service
2.8.5. EJB2 Stateless Session Bean (Embedded) Service
2.8.6. EJB3 JAR Service
2.8.7. EJB3 Message-Driven Bean (Embedded) Service
2.8.8. EJB3 Stateful Session Bean (Embedded) Service
2.8.9. EJB3 Stateless Session Bean (Embedded) Service
2.8.10. Embedded EJB2 JAR Service
2.8.11. Embedded EJB3 JAR Service
2.8.12. Embedded Resource Adapter Archive (RAR) Service
2.8.13. Embedded Web Application (WAR) Service
2.8.14. Enterprise Application (EAR) Service
2.8.15. JBoss Messaging Service
2.8.16. JBoss Web Service
2.8.17. Local Tx Datasource Service
2.8.18. No Tx ConnectionFactory Service
2.8.19. No Tx Datasource Service
2.8.20. Resource Adapter Archive (RAR) Service
2.8.21. Script Service
2.8.22. Service Binding Manager Service
2.8.23. Tx ConnectionFactory Service
2.8.24. Web Application (WAR) Service
2.8.25. XA Datasource Service
2.9. JBossCacheSubsystem Server
2.9.1. JBossCache Service
2.10. JBoss Cache Service 3
2.10.1. Data Container Service
2.10.2. Interceptor Service
2.10.3. Lock Manager Service
2.10.4. RegionManager Service
2.10.5. RPC Manager Service
2.10.6. Transaction Table Service
2.10.7. Tx Interceptor Service
2.11. JMX Server
2.11.1. java.util.logging Service
2.11.2. Operating System Service
2.11.3. Threading Service
2.11.4. VM Class Loading System Service
2.11.5. VM Compilation System Service
2.11.6. VM Memory System Service
2.12. JMS Manager Service
2.12.1. JMS Connection Factory Service
2.12.2. JMS Queue Service
2.12.3. JMS Topic Service
2.13. Postgres Server
2.13.1. Database Service
2.13.2. User Service
2.14. RHQ Agent Server
2.14.1. Environment Setup Script Service
2.14.2. Java Service Wrapper Launcher Service
2.14.3. Launcher Script Service
2.14.4. Measurement Subsystem Service
2.14.5. Plugin Container Service
2.15. Tomcat Server
2.15.1. Tomcat Connector Service
2.15.2. Tomcat User Database Service
2.15.3. Tomcat Virtual Host Service

2.1. Configuring Apache for Monitoring

JBoss Operations Network uses SNMP to monitor an Apache server for things like availability. JBoss ON can also monitor URLs hosted by the Apache server and return response time metrics for each URL.
For JBoss Operations Network to gather metrics about the Apache web server or its URL, the appropriate module (SNMP or Response Time) must be configured in the Apache server. Both JBoss ON modules are Apache Dynamically Shared Object (DSO), so the general implementation for these modules is similar to deploying other Apache modules:
  1. Make sure the Apache server was compiled with DSO support.
  2. Compile and install the module.
  3. Configure the Apache server to use the module.
  4. Restart the Apache server.

2.1.1. Configuring the Response Time Module for Apache 1.3

To collect response time metrics for each URL for an Apache server, the Response Time module must be configured on that Apache server.

IMPORTANT

To use the Response Time module, the Apache server needs to have been compiled with shared object support. For Red Hat Enterprise Linux systems and EWS servers, this is enabled by default.
To verify that the Apache server was compiled with shared object support, use the apachectl -l command to list the compiled modules and look for the mod_so.c module:
[root@server ~]# apachectl -l
Compiled in modules:
  core.c
  prefork.c
  http_core.c
  mod_so.c
When compiling Apache from source, use the --enable-so option:
$ ./configure --enable-so
$ make install
  1. Download the Apache binaries from the JBoss ON UI.
    1. Log into the JBoss ON UI.
      https://server.example.com:7080
      
    2. In the Administration tab in the top menu, click the Downloads item.
    3. Scroll to Connector Downloads, and click the connector-apache.zip link to download the Apache connectors.
  2. Unzip the Apache connectors in a directory that is accessible to the JBoss ON agent.
    unzip connector-apache.zip
    
  3. Compile the Response Time module.

    NOTE

    apxs must be installed, and make must be installed and in the user PATH.
    cd apacheMOduleRoot/apache-rt/sources
    
    ./build_apache_module.sh 1.3 apache_install_directory/bin/apxs
    
  4. Then, install the Response Time module on the Apache server.
    cp apache1.3/.libs/mod_rt.so apache_install_directory/modules
    
  5. Open the httpd.conf file. For example, on Red Hat Enterprise Linux:
    vim apache_install_directory/conf/httpd.conf
    
  6. Enable the module in the Apache's httpd.conf file by appending this line to the end of the file:
    LoadModule  rt_module  modules/mod_rt.so
    
  7. Configure response time logging.
    To configure response time logging for the main Apache server, add the following line at the top level of the file:
    RTLog  logs/myhost.com80_rt.log
    
    To configure response time logging for a virtual host, add the following line within the <VirtualHost> block:
    RTLog  logs/myhost.com8080_rt.log
    
    Make sure the response time log file name is different for the main server and each virtual host. Consider using the the host and port from the ServerName directive be used to form the file name, such as host_port_rt.log.
  8. Restart the Apache server:
    apache_install_directory/bin/apachectl restart
    
  9. To confirm that the Response Time module was installed successfully, check that the response time log files configured in the RTLog directive now exist.

2.1.2. Configuring the Response Time Module for Apache 2.x

To collect response time metrics for each URL for an Apache server, the Response Time module must be configured on that Apache server.

IMPORTANT

To use the Response Time module, the Apache server needs to have been compiled with shared object support. For Red Hat Enterprise Linux systems and EWS servers, this is enabled by default.
To verify that the Apache server was compiled with shared object support, use the apachectl -l command to list the compiled modules and look for the mod_so.c module:
[root@server ~]# apachectl -l
Compiled in modules:
  core.c
  prefork.c
  http_core.c
  mod_so.c
When compiling Apache from source, on 2.0.x versions, use the --enable-so option:
$ ./configure --enable-so
$ make install
For Apache 2.2.x versions, use the --enable-module=so option:
$ ./configure --enable-module=so
$ make install
  1. Download the Apache binaries from the JBoss ON UI.
    1. Log into the JBoss ON UI.
      https://server.example.com:7080
      
    2. In the Administration tab in the top menu, click the Downloads item.
    3. Scroll to Connector Downloads, and click the connector-apache.zip link to download the Apache connectors.
  2. Unzip the Apache connectors.
    unzip connector-apache.zip
    
  3. Compile the Response Time module.

    NOTE

    apxs must be installed, and make must be installed and in the user PATH.
    cd apacheMOduleRoot/apache-rt/sources
    chmod +x build_apache_module.sh
    ./build_apache_module.sh 2.x apache_install_directory/bin/apxs
  4. Then, install the Response Time module on the Apache server. On Red Hat Enterprise Linux:
    cp apache2.x/.libs/mod_rt.so apache_install_directory/modules
    For Solaris:
    cp apache2.x/.libs/mod_rt.so APACHE_2.x_INSTALL_DIR/modules
    For Windows, run the following command:
    xcopy /e JON_AGENT_INSTALL_DIR\product_connectors\apache-rt\binaries \x86-winnt-apache2.0\* apache_install_directory
  5. Open the httpd.conf file. For example, on Red Hat Enterprise Linux:
    vim apache_install_directory/conf/httpd.conf
    
  6. Enable the module in the Apache's httpd.conf file by appending this line to the end of the file:
    LoadModule  rt_module  modules/mod_rt.so
    LogFormat  "%S"  rt_log
    
    When setting the log format, the variable %S has a capital S.
  7. To configure response time logging for the main Apache server, add the following line at the top level of the file:
    CustomLog  logs/myhost.com80_rt.log  rt_log
    
    
    To configure response time logging for a virtual host, add the following line somewhere within the <VirtualHost> block:
    CustomLog  logs/myhost.com8080_rt.log  rt_log
    
    
    Make sure the response time log file name is different for the main server and each virtual host. Consider using the the host and port from the ServerName directive be used to form the file name, such as host_port_rt.log.
  8. Restart the Apache server:
    apache_install_directory/bin/apachectl restart
    
  9. To confirm that the Response Time module was installed successfully, check that the response time log files configured via the CustomLog directive now exist.

2.1.3. Configuring the Apache SNMP Module

To discover an Apache server's virtual hosts and collect metrics for them, the SNMP module must be configured on that Apache server.
Apache 1.3, 2.0, and 2.2 are supported on Red Hat Enterprise Linux. Only Apache 2.0 is supported on Windows.

IMPORTANT

To use the Response Time module, the Apache server needs to have been compiled with shared object support. For Red Hat Enterprise Linux systems and EWS servers, this is enabled by default.
To verify that the Apache server was compiled with shared object support, use the apachectl -l command to list the compiled modules and look for the mod_so.c module:
[root@server ~]# apachectl -l
Compiled in modules:
  core.c
  prefork.c
  http_core.c
  mod_so.c
When compiling Apache from source, on 2.0.x versions, use the --enable-so option:
$ ./configure --enable-so
$ make install
For Apache 2.2.x versions, use the --enable-module=so option:
$ ./configure --enable-module=so
$ make install
  1. Download the Apache binaries from the JBoss ON UI.
    1. Log into the JBoss ON UI.
      https://server.example.com:7080
      
    2. In the Administration tab in the top menu, click the Downloads item.
    3. Scroll to Connector Downloads, and click the connector-apache.zip link to download the Apache connectors.
  2. Unzip the Apache connectors in a directory that is accessible to the JBoss ON agent.
    unzip connector-apache.zip
    
  3. Each Apache version and platform has its own package that contains the Apache-SNMP connectors. Unzip the Apache connectors in a directory that is accessible to the JBoss ON agent. Binaries are available for Red Hat Enterprise Linux 32-bit and 64-bit and Windows.
    For example, on Red Hat Enterprise Linux 32-bit:
    cd apacheModuleRoot/apache-snmp/binaries/
    tar xjvf snmp_module-x86-linux-apache#.tar.bz2
    
    # is the Apache server version number.

    NOTE

    Apache connectors can be compiled for other platforms, like Solaris, from the source files in apacheMOduleRoot/apache-snmp/sources. For example:
    cd JON_AGENT_INSTALL_DIR/product_connectors/apache-snmp/sources
    ./build_apache_snmp.sh APACHE_VERSION APACHE_2.x_INSTALL_DIR/bin/apxs
    To compile the Apache-SNMP connector, apxs, perl, make, and automake must all be installed and in user PATH.
  4. Install the module:
    cd apacheModuleRoot/apache-snmp/binaries/snmp_module_#
    cp module/* apache_install_directory/modules
    cp conf/* apache_install_directory/conf
    mkdir apache_install_directory/var
    
  5. Open the httpd.conf file. For example, on Red Hat Enterprise Linux:
    vim apache_install_directory/conf/httpd.conf
    
  6. Add lines for the Apache server to load the SNMP module. The lines are similar, but not identical, between Apache versions.
    For Apache 1.3 on Red Hat Enterprise Linux:
    LoadModule  snmp_agt_module  modules/libsnmp_agt.so
    AddModule  covalent-snmp-v13.c
    SNMPConf  conf
    SNMPVar  var
    
    For Apache 2.0 and 2.2 on Red Hat Enterprise Linux:
    LoadModule snmpcommon_module modules/libsnmpcommon.so
    LoadModule snmpagt_module modules/libsnmpmonagt.so
    		
    SNMPConf   conf
    SNMPVar    var
    
    For Apache 2.0 on Windows:
    xcopy /e JON_AGENT_INSTALL_DIR\product_connectors\apache-snmp\binaries\x86-winnt-apache2.0\* APACHE_2.0_INSTALL_DIR
  7. For Apache 2.0 and 2.2. Enable the module by adding these lines to the httpd.conf on both Red Hat Enterprise Linux and Windows:
    LoadModule snmpcommon_module modules/snmpcommon.so
    LoadModule snmpagt_module modules/snmpmonagt.so
    		
    SNMPConf   conf
    SNMPVar    var
    
  8. Make sure the main Apache configuration section, as well as each <VirtualHost> configuration block, contains a ServerName directive with a port. The SNMP module uses this directive to uniquely identify the main server and each virtual host, so each ServerName directive must contain a unique value. For example:
    ServerName main.example.com:80
    ...
    		
    <VirtualHost vhost1.example.com:80>
    ServerName vhost1.example.com:80
    ...
    </VirtualHost>
    
  9. To monitor more than one Apache instance on the same machine, make sure the agentaddress property in apache_install_directory/conf/snmpd.conf has a different value for each instance. See the snmpd.conf documentation for a description of this property's syntax.
  10. Restart the Apache server. For example:
    apache_installation_dir/bin/Apache -k restart
    
  11. Verify that the SNMP module was properly installed. If the module is loaded, then there will be lines referencing the SNMP module in the errors log:
    grep SNMP apache_installation_dir/logs/error_log
    
    [Wed Mar 19 09:54:34 2008] [notice] Apache/2.0.63 (Unix) CovalentSNMP/2.3.0 configured -- resuming normal operations
    [Wed Mar 19 09:54:35 2008] [notice] SNMP: CovalentSNMP/2.3.0 started (user '1000' - SNMP address '1610' - pid '26738')
    
    

2.2. Apache HTTP Server

Overview

Table 2.1. Overview

Description: an Apache HTTP Server instance
Singleton: no
Plugin: Apache

Parent Resource Types

Child Resource Types

Autodiscovery Process Scans

Table 2.2. Metrics

Name Query
HttpdOnUnix process|basename|match=httpd.*,process|basename|nomatch|parent=httpd.*
HttpdOnWindows process|basename|match=(?i)httpd.exe,process|basename|match|parent=(?i)httpd.exe
Apache2OnUnix process|basename|match=apache2,process|basename|nomatch|parent=apache2
ApacheOnWindows process|basename|match=(?i)Apache.exe,process|basename|match|parent=(?i)Apache.exe

Connection Properties

Table 2.3. 

Name Description Required Internal Name
Enable augeas support Enable augeas support yes augeasEnabled
Augeas Module Name the name of the Augeas module/lens to use for loading and updating this resource's configuration yes augeasModuleName
Httpd config file Location of the Apache main configuration file. yes configurationFilesInclusionPatterns
Virtual Hosts Configuration Placement How should the new virtual host definitions be put in the configuration yes vhostCreationPolicy
Path To Contain Virtual Hosts Files If the new virtual hosts should be created in standalone files, this mask determines where to create those files. The '*' in the path is replaced by the name of the virtual host. If the path is relative, it is considered relative to server root. yes vhostFilesMask
Error Log File Path The absolute path to the error log file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'logs/error_log' on UNIX or 'logs\error.log' on Windows. no errorLogFilePath
Error Log Events Enabled A flag indicating whether or not generation of Events for new error log entries is enabled. yes errorLogEventsEnabled
Error Log Minimum Severity The minimum severity of error log entry Events that should be collected. If not specified, there is no minimum severity (i.e. all events will be collected). no errorLogMinimumSeverity
Error Log Includes Pattern A regular expression against which an error log entry's detail is matched to determine if an Event should be fired for that entry. If not specified, no filtering of log entries will be done based on their detail. no errorLogIncludesPattern
Server Root the absolute path of the Apache server root directory yes serverRoot
Executable Path the path to the Apache executable - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default value is 'bin/httpd' on UNIX or 'bin\Apache.exe' on Windows no executablePath
Control Script Path the path to the Apache control script - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'bin/apachectl' on UNIX or the Apache executable on Windows no controlScriptPath
Config File the path to the httpd.conf file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'conf/httpd.conf' on UNIX yes configFile
URL the http or https URL that will be used to check availability for this Apache server; if not set, availablity will be determined based on whether plugin can connect to the Apache server's SNMP agent no url
SNMP Agent Host the host name or IP address of the Apache SNMP agent (typically '127.0.0.1') yes snmpAgentHost
SNMP Agent Port the TCP port of the Apache SNMP agent (typically '1610') yes snmpAgentPort
SNMP Agent Community the SNMP community of the Apache SNMP agent (typically 'public') yes snmpAgentCommunity
Restart After Configuration Update If set to true, each configuration update of the server or any underlying virtual host or directory is followed by the restart of the Apache instance so that the configuration changes are applied immediately. If set to false, you have to manually restart the server (for example using the restart operation in the operations tab) once all the configuration updates are finished. yes restartAfterConfigurationUpdate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.4. Metrics

Name Type Description Internal Name
Number of Concurrent Connections measurement Number of Concurrent Connections applInboundAssociations
Server Built trait the date and time this Apache server's binary was compiled serverBuilt
Start Time trait the date and time this Apache server was last started wwwServiceStartTime
Time to ping the server for availability measurement Time it took to ping the server for availability over http; this includes DNS lookup time. rhq_avail_ping_time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.5. 

Name Description Required Internal Name
Listen yes Listen
Name Virtual Host A required directive if you want to configure name-based virtual hosts. Although the value can be hostname it is recommended that you always use an IP address. IPv6 addresses must be enclosed in square brackets. To receive requests on all interfaces, you can set the value to *. Note that the IP address of a name-based virtual host must exactly match the value of this property. The address may be optionally followed by the port specification to further limit the directive effect. no NameVirtualHost

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.6. Metrics

Name Description
Start Starts this Apache server, or returns an error if it is already running. The control script used is specified in the Connection Properties.
Stop Stops this Apache server, or returns an error if it is not running. The control script used is specified in the Connection Properties.
Restart Restarts the Apache server by sending its process a SIGHUP. If the server is not running, it is started. This command automatically checks the server's configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties. Only supported on UNIX platforms.
Start with SSL Support Starts this Apache server with support for SSL. The control script used is specified in the Connection Properties. Only supported on Apache 1.3.
Restart Gracefully Gracefully restarts the Apache server by sending it a SIGUSR1. If the daemon is not running, it is started. This differs from a normal restart in that currently open connections are not aborted. A side effect is that old log files will not be closed immediately. This means that if used in a log rotation script, a substantial delay may be necessary to ensure that the old log files are closed before processing them. This command automatically checks the configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties.
Check Configuration File Syntax Run a configuration file syntax test. It parses the configuration files and either reports Syntax Ok or detailed information about the particular syntax error. The control script used is specified in the Connection Properties. Only supported on UNIX platforms.
Install mod_jk configuration Tries to install a mod_jk configuration in httpd.conf if none is detected. This includes a workers.properties file and urimap file

Package Types

none

2.2.1. Apache Virtual Host Service

Overview

Table 2.7. Overview

Description:
Singleton: no
Plugin: Apache

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.8. 

Name Description Required Internal Name
Response Time Log File the full path to the log file containing response-time stats for this virtual host no responseTimeLogFile
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
URL the http or https URL that will be used to check availability for this virtual host yes url

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.9. Metrics

Name Type Description Internal Name
Host trait the host name or IP address of this virtual host wwwServiceName
Port trait the TCP port of this virtual host wwwServiceProtocol
Administrator trait the administrator of this virtual host wwwServiceContact
Total Number of Requests measurement The number of inbound requests on the service wwwSummaryInRequests
Total Number of Requests per Minute measurement The number of inbound requests on the service wwwSummaryInRequests
Total Number of Bytes Received measurement The number of bytes received by the service wwwSummaryInLowBytes
Total Number of Bytes Received per Minute measurement The number of bytes received by the service wwwSummaryInLowBytes
Total Number of Responses measurement The number of outbound requests on the service wwwSummaryOutResponses
Total Number of Responses per Minute measurement The number of outbound requests on the service wwwSummaryOutResponses
Total Number of Bytes Sent measurement The number of bytes sent by the service wwwSummaryOutLowBytes
Total Number of Bytes Sent per Minute measurement The number of bytes sent by the service wwwSummaryOutLowBytes
Number of GET Requests measurement The number of inbound GET requests on the service wwwRequestInRequests.GET
Number of GET Requests per Minute measurement The number of inbound GET requests on the service wwwRequestInRequests.GET
Number of HEAD Requests measurement The number of inbound HEAD requests on the service wwwRequestInRequests.HEAD
Number of HEAD Requests per Minute measurement The number of inbound HEAD requests on the service wwwRequestInRequests.HEAD
Number of POST Requests measurement The number of inbound POST requests on the service wwwRequestInRequests.POST
Number of POST Requests per Minute measurement The number of inbound POST requests on the service wwwRequestInRequests.POST
Number of PUT Requests measurement The number of inbound PUT requests on the service wwwRequestInRequests.PUT
Number of PUT Requests per Minute measurement The number of inbound PUT requests on the service wwwRequestInRequests.PUT
Bytes Received for GET Requests measurement The number of bytes received by GET requests on the service wwwRequestInBytes.GET
Bytes Received for GET Requests per Minute measurement The number of bytes received by GET requests on the service wwwRequestInBytes.GET
Bytes Received for HEAD Requests measurement The number of bytes received by HEAD requests on the service wwwRequestInBytes.HEAD
Bytes Received for HEAD Requests per Minute measurement The number of bytes received by HEAD requests on the service wwwRequestInBytes.HEAD
Bytes Received for POST Requests measurement The number of bytes received by POST requests on the service wwwRequestInBytes.POST
Bytes Received for POST Requests per Minute measurement The number of bytes received by POST requests on the service wwwRequestInBytes.POST
Bytes Received for PUT Requests measurement The number of bytes received by PUT requests on the service wwwRequestInBytes.PUT
Bytes Received for PUT Requests per Minute measurement The number of bytes received by PUT requests on the service wwwRequestInBytes.PUT
Number of 200 Responses measurement The number of 200 responses generated by this service wwwResponseOutResponses.200
Number of 200 Responses per Minute measurement The number of 200 responses generated by this service wwwResponseOutResponses.200
Number of 301 Responses measurement The number of 301 responses generated by this service wwwResponseOutResponses.301
Number of 301 Responses per Minute measurement The number of 301 responses generated by this service wwwResponseOutResponses.301
Number of 302 Responses measurement The number of 302 responses generated by this service wwwResponseOutResponses.302
Number of 302 Responses per Minute measurement The number of 302 responses generated by this service wwwResponseOutResponses.302
Number of 401 Responses measurement The number of 401 responses generated by this service wwwResponseOutResponses.401
Number of 401 Responses per Minute measurement The number of 401 responses generated by this service wwwResponseOutResponses.401
Number of 403 Responses measurement The number of 403 responses generated by this service wwwResponseOutResponses.403
Number of 403 Responses per Minute measurement The number of 403 responses generated by this service wwwResponseOutResponses.403
Number of 404 Responses measurement The number of 404 responses generated by this service wwwResponseOutResponses.404
Number of 404 Responses per Minute measurement The number of 404 responses generated by this service wwwResponseOutResponses.404
Number of 500 Responses measurement The number of 500 responses generated by this service wwwResponseOutResponses.500
Number of 500 Responses per Minute measurement The number of 500 responses generated by this service wwwResponseOutResponses.500
Bytes Sent for 200 Responses measurement The number of bytes sent for 200 responses generated by this service wwwResponseOutBytes.200
Bytes Sent for 200 Responses per Minute measurement The number of bytes sent for 200 responses generated by this service wwwResponseOutBytes.200
Bytes Sent for 301 Responses measurement The number of bytes sent for 301 responses generated by this service wwwResponseOutBytes.301
Bytes Sent for 301 Responses per Minute measurement The number of bytes sent for 301 responses generated by this service wwwResponseOutBytes.301
Bytes Sent for 302 Responses measurement The number of bytes sent for 302 responses generated by this service wwwResponseOutBytes.302
Bytes Sent for 302 Responses per Minute measurement The number of bytes sent for 302 responses generated by this service wwwResponseOutBytes.302
Bytes Sent for 401 Responses measurement The number of bytes sent for 401 responses generated by this service wwwResponseOutBytes.401
Bytes Sent for 401 Responses per Minute measurement The number of bytes sent for 401 responses generated by this service wwwResponseOutBytes.401
Bytes Sent for 403 Responses measurement The number of bytes sent for 403 responses generated by this service wwwResponseOutBytes.403
Bytes Sent for 403 Responses per Minute measurement The number of bytes sent for 403 responses generated by this service wwwResponseOutBytes.403
Bytes Sent for 404 Responses measurement The number of bytes sent for 404 responses generated by this service wwwResponseOutBytes.404
Bytes Sent for 404 Responses per Minute measurement The number of bytes sent for 404 responses generated by this service wwwResponseOutBytes.404
Bytes Sent for 500 Responses measurement The number of bytes sent for 500 responses generated by this service wwwResponseOutBytes.500
Bytes Sent for 500 Responses per Minute measurement The number of bytes sent for 500 responses generated by this service wwwResponseOutBytes.500
HTTP Response Time calltime The minimum, maximum, and average response times for HTTP requests serviced by this virtual host ResponseTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.10. 

Name Description Required Internal Name
Error Log Sets the name of the file to which the server will log any errors it encounters. If the file-path is not absolute then it is assumed to be relative to the ServerRoot. If the file-path begins with a pipe (|) then it is assumed to be a command to spawn to handle the error log. Using syslog instead of a filename enables logging via syslogd(8) if the system supports it. The default is to use syslog facility local7, but you can override this by using the syslog:facility syntax where facility can be one of the names usually documented in syslog(1). no ErrorLog
Request logs Configure the logging of requests to the server. yes CustomLog
Server Name Sets the request scheme, hostname and port that the server uses to identify itself. This is used when creating redirection URLs. If no ServerName is specified, then the server attempts to deduce the hostname by performing a reverse lookup on the IP address. If no port is specified in the ServerName, then the server will use the port from the incoming request. For optimal reliability and predictability, you should specify an explicit hostname and port using the ServerName directive. If you are using name-based virtual hosts, the ServerName inside a <VirtualHost> section specifies what hostname must appear in the request's Host: header to match this virtual host. no ServerName
Server Alias yes ServerAlias
Server Admin The email address or URL to contact the server administrator in case of errors. This address is used in various Apache generated error messages. no ServerAdmin
Document Root This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document. If the directory-path is not absolute then it is assumed to be relative to the ServerRoot. The DocumentRoot should be specified without a trailing slash. yes DocumentRoot
Add Default Charset This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. no AddDefaultCharset
Alias The Alias directive allows documents to be stored in the local filesystem other than under the DocumentRoot. With " Alias /image /ftp/pub/image", a request for http://myserver/image/foo.gif would cause the server to return the file /ftp/pub/image/foo.gif. Only complete path segments are matched, so the above alias would not match a request for http://myserver/imagefoo.gif. Note that you may need to specify additional <Directory> sections which cover the destination of aliases. In particular, if you are creating an Alias to a directory outside of your DocumentRoot, you may need to explicitly permit access to the target directory. yes Alias
Default Type There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. no DefaultType
Directory Index Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. no DirectoryIndex
Error Document In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. yes ErrorDocument
Timeout The TimeOut directive defines the length of time Apache will wait for I/O in various circumstances. no Timeout
Options The Options directive controls which server features are available in a particular directory. no Options
Use Canonical Name With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. no UseCanonicalName
Use Canonical Physical Port In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. no UseCanonicalPhysicalPort

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

none

Package Types

none

2.2.1.1. Directory Service

Overview

Table 2.11. Overview

Description:
Singleton: no
Plugin: Apache

Parent Resource Types
Child Resource Types
Connection Properties

Table 2.12. 

Name Description Required Internal Name
Directive Index yes directiveIndex
Regular Expression Does the name of this directory denote a regular expression? yes regexp

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties

Table 2.13. 

Name Description Required Internal Name
IfModule Conditions List of modules which must be loaded to use directive configuration. yes IfModules
Order The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two. no Order
Allow The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface. no Allow
Deny The arguments for the Deny directive are identical to the arguments for the Allow directive. no Deny
Allow Override no AllowOverride
Add Default Charset This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. no AddDefaultCharset
Default Type There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. no DefaultType
Directory Index Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. no DirectoryIndex
Error Document In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. yes ErrorDocument
Options The Options directive controls which server features are available in a particular directory. no Options
Use Canonical Name With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. no UseCanonicalName
Use Canonical Physical Port In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. no UseCanonicalPhysicalPort

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
2.2.1.1.1. IfModule Parameters Service
Overview

Table 2.14. Overview

Description:
Singleton: no
Plugin: Apache

Parent Resource Types
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties

Table 2.15. 

Name Description Required Internal Name
IfModule Conditions List of modules which must be loaded to use directive configuration. yes IfModules
Order The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two. no Order
Allow The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface. no Allow
Deny The arguments for the Deny directive are identical to the arguments for the Allow directive. no Deny
Allow Override no AllowOverride
Add Default Charset This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. no AddDefaultCharset
Default Type There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. no DefaultType
Directory Index Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. no DirectoryIndex
Error Document In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. yes ErrorDocument
Options The Options directive controls which server features are available in a particular directory. no Options
Use Canonical Name With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. no UseCanonicalName
Use Canonical Physical Port In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. no UseCanonicalPhysicalPort

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

2.2.1.2. IfModule Service

Overview

Table 2.16. Overview

Description:
Singleton: no
Plugin: Apache

Parent Resource Types
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties

Table 2.17. 

Name Description Required Internal Name
IfModule Conditions List of modules which must be loaded to use directive configuration. yes IfModules
Order The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two. no Order
Allow The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface. no Allow
Deny The arguments for the Deny directive are identical to the arguments for the Allow directive. no Deny
Allow Override no AllowOverride
Add Default Charset This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. no AddDefaultCharset
Default Type There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. no DefaultType
Directory Index Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. no DirectoryIndex
Error Document In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. yes ErrorDocument
Options The Options directive controls which server features are available in a particular directory. no Options
Use Canonical Name With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. no UseCanonicalName
Use Canonical Physical Port In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. no UseCanonicalPhysicalPort

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

2.2.2. Mod JK Service

Overview

Table 2.18. Overview

Description: Management of mod_jk
Singleton: yes
Plugin: Apache

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.19. 

Name Description Required Internal Name
Path to workers.properties The path to the file containing worker properties. If this is a relative path, it will be looked up in the server root of the parent Apache server no workerFile
Path to the uriworkers file The path to the file containing uri to worker mappings. If this is a relative path, it will be looked up in the server root of the parent Apache server no uriWorkerFile

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

2.3. ESB Service

Overview

Table 2.20. Overview

Description: Overall metrics for JBoss ESB.
Singleton: yes
Plugin: JBossESB

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.21. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Naming Provider URL The JNP URL with which to connect to the JBoss Application Server instance (e.g. jnp://127.0.0.1:1099). yes namingURL
Principal The name of the principal (i.e. user) to authenticate. no principal
Credentials The credentials (i.e. password) that should be used to authenticate the principal. no credentials
JBoss Home Directory The absolute path to the directory where JBossAS is installed (e.g. /opt/jboss-4.2.2.GA). yes jbossHomeDir
Configuration Path The path to the configuration directory under which this instance operates (e.g. /opt/jboss-4.2.2.GA/server/default); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}. yes configurationPath
Configuration Set The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {configurationPath}. no configurationSet

Metrics

Table 2.22. Metrics

Name Type Description Internal Name
Message Count (Successful) measurement Overall Successful Message Count. SuccessfulMessageCount
Message Count (Total) measurement Total Message Count. TotalMessageCount
Message Counts (Failed) measurement Failed Message Count. FailedMessageCount
Processed Bytes measurement Overall Bytes Processed. ProcessedBytes
LastSuccessfulMessageDate trait Last Successful Message Date. LastSuccessfulMessageDate
Last Failed Message Date trait Last Failed Message Date. LastFailedMessageDate

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.23. Metrics

Name Description
Reset Counts Reset the overall counter.

Table 2.24. Package Types

Name Category Description
Jar Library Deployable Library Jar files deployed in JBoss AS.

2.3.1. Deployment

Overview

Table 2.25. Overview

Description: Metrics for Deployments.
Singleton: no
Plugin: JBossESB

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.26. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Deployment The deployment name. yes deployment
Extension yes extension

Metrics

Table 2.27. Metrics

Name Type Description Internal Name
Deployment Type trait Type of deployment. Name
.esb State String trait Current state of the ESB. StateString
.esb State trait Numeric value of the state of the ESB deployment. State

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.28. Operations

Name Description
Start deployment Start the deployment.
Stop deployment Stop the deployment.

Table 2.29. Package Types

Name Category Description
ESB Package Deployable

2.3.2. Services

Overview

Table 2.30. Overview

Description: Services.
Singleton: no
Plugin: JBossESB

Note

Services are the services available within a deployment.

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.31. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Deployment The deployment name. yes deployment
Service Name The service name. yes serviceName
Category Name The service category name. yes categoryName

Metrics

Table 2.32. Metrics

Name Type Description Internal Name
Message Count trait Type of deployment. Name
Message Count (avg) trait Current state of the ESB. StateString
Overall Bytes trait Numeric value of the state of the ESB deployment. State
Overall Bytes Processed trait Numeric value of the state of the ESB deployment. State
Overall Bytes Failed trait Numeric value of the state of the ESB deployment. State
Overall Service Time Processed trait Numeric value of the state of the ESB deployment. State

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.33. Operations

Name Description
Reset the message counter Reset the message counter.

Package Types

none

2.3.3. Gateways

Overview

Table 2.34. Overview

Description: Gateways.
Singleton: no
Plugin: JBossESB

Note

Gateway configuration shows the config of the listener.

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.35. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Service Category The service category of the listener. yes serviceCategory
Listener Name The name of the listener. yes listenerName
Deployment Name The name of deployment. yes deploymentName

Metrics

Table 2.36. Metrics

Name Type Description Internal Name
Lifecycle State trait Lifecycle State. LifeCycleState
Maximum Number of Threads trait Maximum number of threads. maxThreads
Service Category trait Service Category. target-service-category
Service Description trait Service Description. target-service-description
Service Name trait Service Name. target-service-name

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.37. Operations

Name Description
Start listener Start the listener.
Stop listener Stop the listener.

Table 2.38. Package Types

Name Category Description
ESB Package Deployable

2.3.4. Listeners

Overview

Table 2.39. Overview

Description: Listeners.
Singleton: no
Plugin: JBossESB

Note

Listener configuration shows the config of the listener.

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.40. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Service Category The service category of the listener. yes serviceCategory
Listener Name The name of the listener. yes listenerName
Deployment Name The name of deployment. yes deploymentName

Metrics

Table 2.41. Metrics

Name Type Description Internal Name
MEP trait Type of deployment. mep
Lifecycle State trait Lifecycle State. LifeCycleState
Maximum Number of Threads trait Maximum number of threads. maxThreads
Start Date trait Start Date. StartDate
Service Category trait Service Category. service-category
Service Description trait Service Description. service-description
Service Name trait Service Name. service-name

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.42. Operations

Name Description
Start listener Start the listener.
Stop listener Stop the listener.

Package Types

none

2.3.5. Actions

Overview

Table 2.43. Overview

Description: Actions.
Singleton: no
Plugin: JBossESB

Note

Actions are the actions executed within a service.

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.44. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Action Name The action name. yes actionName

Metrics

Table 2.45. Metrics

Name Type Description Internal Name
Message Count measurement overallMessagesCount
Message Count (avg) measurement overallMessagesCountMinute
Messages Failed measurement failedProcessedCount
Messages Failed (avg) measurement failedProcessedCountMinute
Messages Successfully Processed measurement successProcessedCount
Messages Successfully Processed (avg) measurement successProcessedCountMinute
Overall Bytes measurement overallBytesProcessed
Overall Bytes Processed measurement bytesSuccessful
Overall Bytes Failed measurement overallBytesFailed
Processing Time measurement processingTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.4. ESB 5 Service

Overview

Table 2.46. Overview

Description: Overall metrics for JBoss ESB 5.
Singleton: yes
Plugin: JBossESB5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.47. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Naming Provider URL The JNP URL with which to connect to the JBoss Application Server instance (e.g. jnp://127.0.0.1:1099). yes namingURL
Principal The name of the principal (i.e. user) to authenticate. no principal
Credentials The credentials (i.e. password) that should be used to authenticate the principal. no credentials
JBoss Home Directory The absolute path to the directory where JBossAS is installed (e.g. /opt/jboss-4.2.2.GA). yes jbossHomeDir
Configuration Path The path to the configuration directory under which this instance operates (e.g. /opt/jboss-4.2.2.GA/server/default); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}. yes configurationPath
Configuration Set The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {configurationPath}. no configurationSet

Metrics

Table 2.48. Metrics

Name Type Description Internal Name
Message Count (Successful) measurement Overall Successful Message Count. SuccessfulMessageCount
Message Count (Total) measurement Total Message Count. TotalMessageCount
Message Counts (Failed) measurement Failed Message Count. FailedMessageCount
Processed Bytes measurement Overall Bytes Processed. ProcessedBytes
LastSuccessfulMessageDate trait Last Successful Message Date. LastSuccessfulMessageDate
Last Failed Message Date trait Last Failed Message Date. LastFailedMessageDate

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.49. Metrics

Name Description
Reset Counts Reset the overall counter.

Table 2.50. Package Types

Name Category Description
Jar Library Deployable Library Jar files deployed in JBoss AS.

2.4.1. Deployment

Overview

Table 2.51. Overview

Description: Metrics for Deployments.
Singleton: no
Plugin: JBossESB5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.52. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Deployment The deployment name. yes deployment
Extension yes extension

Metrics

Table 2.53. Metrics

Name Type Description Internal Name
Deployment Type trait Type of deployment. Name
.esb State String trait Current state of the ESB. StateString
.esb State trait Numeric value of the state of the ESB 5 deployment. State

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.54. Operations

Name Description
Start deployment Start the deployment.
Stop deployment Stop the deployment.

Table 2.55. Package Types

Name Category Description
ESB Package Deployable

2.4.2. Services

Overview

Table 2.56. Overview

Description: Services.
Singleton: no
Plugin: JBossESB5

Note

Services are the services available within a deployment.

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.57. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Deployment The deployment name. yes deployment
Service Name The service name. yes serviceName
Category Name The service category name. yes categoryName

Metrics

Table 2.58. Metrics

Name Type Description Internal Name
Message Count trait Type of deployment. Name
Message Count (avg) trait Current state of the ESB. StateString
Overall Bytes trait Numeric value of the state of the ESB 5 deployment. State
Overall Bytes Processed trait Numeric value of the state of the ESB 5 deployment. State
Overall Bytes Failed trait Numeric value of the state of the ESB 5 deployment. State
Overall Service Time Processed trait Numeric value of the state of the ESB 5 deployment. State

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.59. Operations

Name Description
Reset the message counter Reset the message counter.

Package Types

none

2.4.3. Gateways

Overview

Table 2.60. Overview

Description: Gateways.
Singleton: no
Plugin: JBossESB5

Note

Gateway configuration shows the config of the listener.

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.61. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Service Category The service category of the listener. yes serviceCategory
Listener Name The name of the listener. yes listenerName
Deployment Name The name of deployment. yes deploymentName

Metrics

Table 2.62. Metrics

Name Type Description Internal Name
Lifecycle State trait Lifecycle State. LifeCycleState
Maximum Number of Threads trait Maximum number of threads. maxThreads
Service Category trait Service Category. target-service-category
Service Description trait Service Description. target-service-description
Service Name trait Service Name. target-service-name

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.63. Operations

Name Description
Start listener Start the listener.
Stop listener Stop the listener.

Table 2.64. Package Types

Name Category Description
ESB Package Deployable

2.4.4. Listeners

Overview

Table 2.65. Overview

Description: Listeners.
Singleton: no
Plugin: JBossESB5

Note

Listener configuration shows the config of the listener.

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.66. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Service Category The service category of the listener. yes serviceCategory
Listener Name The name of the listener. yes listenerName
Deployment Name The name of deployment. yes deploymentName

Metrics

Table 2.67. Metrics

Name Type Description Internal Name
MEP trait Type of deployment. mep
Lifecycle State trait Lifecycle State. LifeCycleState
Maximum Number of Threads trait Maximum number of threads. maxThreads
Start Date trait Start Date. StartDate
Service Category trait Service Category. service-category
Service Description trait Service Description. service-description
Service Name trait Service Name. service-name

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.68. Operations

Name Description
Start listener Start the listener.
Stop listener Stop the listener.

Package Types

none

2.4.5. Actions

Overview

Table 2.69. Overview

Description: Actions.
Singleton: no
Plugin: JBossESB5

Note

Actions are the actions executed within a service.

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.70. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Action Name The action name. yes actionName

Metrics

Table 2.71. Metrics

Name Type Description Internal Name
Message Count measurement overallMessagesCount
Message Count (avg) measurement overallMessagesCountMinute
Messages Failed measurement failedProcessedCount
Messages Failed (avg) measurement failedProcessedCountMinute
Messages Successfully Processed measurement successProcessedCount
Messages Successfully Processed (avg) measurement successProcessedCountMinute
Overall Bytes measurement overallBytesProcessed
Overall Bytes Processed measurement bytesSuccessful
Overall Bytes Failed measurement overallBytesFailed
Processing Time measurement processingTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.5. Hibernate Statistics Service

Overview

Table 2.72. Overview

Description: Statistics for Hibernate
Singleton: no
Plugin: Hibernate

Configuring Hibernate to Collect Statistics
Some minimal configuration is required for a Hibernate instance to collect statistcs. All of the statistics available to a Hibernate server are defined in org.hibernate.stat.Statistics. This can be done by adding XML-based configuration files to the instance or by deploying the mbean programmatically on the instance.
Configuring Hibernate to collect monitoring statistics requires an additional file in the instance's META-INF and an extra entry in the persistence.xml file.
  1. The first step is to create a file that defines the managed bean which is used to collect the hibernate statistics. Basically, this means naming the mbean and calling a session factory that reports the statistics. In this example, the file is called hibernate-service.xml; this can be named anything. The mbean definition must meet two configuration requirements:
    • The mbean defined in the file must be unique within the Hibernate instance.
    • The session factor given in the mbean definition must be referenced in the persistence.xml file.
    For example:
    <?xml version="1.0" encoding="UTF-8"?>
        <server>
          <mbean code="org.hibernate.jmx.StatisticsService"
                    name="Hibernate:application=MyExampleApp,type=statistics">
                    <attribute name="SessionFactoryJNDIName">exampleAppSF</attribute>
                    <depends>jboss:service=Naming</depends>
           </mbean>
       </server>
  2. Next, define the given session factory in the instance's persistence.xml file. This is the sessions factory that the mbean uses to report the statistics; therefore, the hibernate.generate_statistics property must be set to true. For example:
    <persistence-unit name="exampleAppDB">
       <provider>org.hibernate.ejb.HibernatePersistence</provider>
       <jta-data-source>java:/exampleAppDatasource</jta-data-source>
       <properties>
          <property name="hibernate.dialect" value="org.hibernate.dialect.OracleDialect"/>
          <property name="hibernate.hbm2ddl.auto" value="update"/>
          <property name="hibernate.show_sql" value="true"/>
          <property name="hibernate.format_sql" value="true"/>
          <property name="hibernate.generate_statistics" value="true"/>
          <property name="hibernate.session_factory_name" value="exampleAppSF"/>
          <property name="jboss.entity.manager.factory.jndi.name" value="java:/exampleAppEntityManagerFactory"/>
       </properties>
    </persistence-unit>
Alternatively, Hibernate statistics collection can be configured programmatically.
In order to monitor Hibernate statistics via JON, the Hibernate Session Manager MBean must be deployed to an object name of the format _"Hibernate:application=%application%,type=statistics"_, and statistics must be enabled.
Some example code is provided below to register the Hibernate Session MBean within an EJB3 application.
 public static void enableHibernateStatistics(EntityManager entityManager)
 {
    try
    {
       StatisticsService mBean = new StatisticsService();
       SessionFactory sessionFactory = getHibernateSession(entityManager).getSessionFactory();
       mBean.setSessionFactory(sessionFactory);
       ObjectName objectName = new ObjectName(HIBERNATE_STATISTICS_MBEAN_OBJECTNAME);
       MBeanServer jbossMBeanServer = getJBossMBeanServer();
       jbossMBeanServer.registerMBean(mBean, objectName);
       sessionFactory.getStatistics().setStatisticsEnabled(true);
    }
    catch (InstanceAlreadyExistsException iaee)
    {
       LOG.info("Duplicate MBean registration ignored: " + HIBERNATE_STATISTICS_MBEAN_OBJECTNAME);
    }
    catch (Exception e)
    {
       LOG.warn("Couldn't register Hibernate statistics MBean.", e);
    }
 }

 private static Session getHibernateSession(EntityManager entityManager) {
    Session session;
    if (entityManager.getDelegate() instanceof EntityManagerImpl) {
        EntityManagerImpl entityManagerImpl = (EntityManagerImpl) entityManager.getDelegate();
        session = entityManagerImpl.getSession();
    } else {
        session = (Session) entityManager.getDelegate();
    }
    return session;
 }

 private static MBeanServer getJBossMBeanServer() {
    List<MBeanServer> servers = MBeanServerFactory.findMBeanServer(null);
    MBeanServer jbossServer = null;
    for (MBeanServer server : servers) {
        if ("jboss".equals(server.getDefaultDomain())) {
            jbossServer = server;
        }
    }
    if (jbossServer == null) {
        jbossServer = ManagementFactory.getPlatformMBeanServer();
    }
    return jbossServer;
 }

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.73. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Application the Hibernate application name yes application

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.74. Metrics

Name Type Description Internal Name
Entity Insert Count measurement The global number of entity inserts since the statistics were reset EntityInsertCount
Entity Insert Count per Minute measurement The global number of entity inserts since the statistics were reset EntityInsertCount
Query Execution Max Time measurement The amount of time taken by the slowest recorded query since the statistics were reset QueryExecutionMaxTime
Entity Update Count measurement The global number of entity updates since the statistics were reset EntityUpdateCount
Entity Update Count per Minute measurement The global number of entity updates since the statistics were reset EntityUpdateCount
Collection Update Count measurement The global number of collections updated since the statistics were reset CollectionUpdateCount
Collection Update Count per Minute measurement The global number of collections updated since the statistics were reset CollectionUpdateCount
Entity Load Count measurement The global number of entity loads since the statistics were reset EntityLoadCount
Entity Load Count per Minute measurement The global number of entity loads since the statistics were reset EntityLoadCount
Entity Fetch Count measurement The global number of entity fetches since the statistics were reset EntityFetchCount
Entity Fetch Count per Minute measurement The global number of entity fetches since the statistics were reset EntityFetchCount
Entity Delete Count measurement The global number of entity deletes since the statistics were reset EntityDeleteCount
Entity Delete Count per Minute measurement The global number of entity deletes since the statistics were reset EntityDeleteCount
Collection Recreate Count measurement The global number of collections recreated since the statistics were reset CollectionRecreateCount
Collection Recreate Count per Minute measurement The global number of collections recreated since the statistics were reset CollectionRecreateCount
Query Execution Count measurement The global number of queries executed since the statistics were reset QueryExecutionCount
Query Execution Count per Minute measurement The global number of queries executed since the statistics were reset QueryExecutionCount
Flush Count measurement The global number of flushes executed by sessions (either implicit or explicit) since the statistics were reset FlushCount
Flush Count per Minute measurement The global number of flushes executed by sessions (either implicit or explicit) since the statistics were reset FlushCount
Collection Load Count measurement The global number of collections loaded since the statistics were reset CollectionLoadCount
Collection Load Count per Minute measurement The global number of collections loaded since the statistics were reset CollectionLoadCount
Successful Transaction Count measurement The global number of transactions known to have been successful since the statistics were reset SuccessfulTransactionCount
Successful Transaction Count per Minute measurement The global number of transactions known to have been successful since the statistics were reset SuccessfulTransactionCount
Query Cache Hit Count measurement The global number of cached queries successfully retrieved from cache since the statistics were reset QueryCacheHitCount
Query Cache Hit Count per Minute measurement The global number of cached queries successfully retrieved from cache since the statistics were reset QueryCacheHitCount
Collection Remove Count measurement The global number of collections removed since the statistics were reset CollectionRemoveCount
Collection Remove Count per Minute measurement The global number of collections removed since the statistics were reset CollectionRemoveCount
Connect Count measurement The global number of connections asked by the sessions (the actual number of connections used may be much smaller depending whether you use a connection pool or not) since the statistics were reset ConnectCount
Connect Count per Minute measurement The global number of connections asked by the sessions (the actual number of connections used may be much smaller depending whether you use a connection pool or not) since the statistics were reset ConnectCount
Start Time trait The time when the statistics collection started or were last reset StartTime
Second Level Cache Put Count measurement The global number of cacheable entities/collections put in the cache since the statistics were reset SecondLevelCachePutCount
Second Level Cache Put Count per Minute measurement The global number of cacheable entities/collections put in the cache since the statistics were reset SecondLevelCachePutCount
Query Cache Put Count measurement The global number of cacheable queries put in cache since the statistics were reset QueryCachePutCount
Query Cache Put Count per Minute measurement The global number of cacheable queries put in cache since the statistics were reset QueryCachePutCount
Session Open Count measurement The global number of sessions closed since the statistics were reset SessionOpenCount
Session Open Count per Minute measurement The global number of sessions closed since the statistics were reset SessionOpenCount
Transaction Count measurement The global number of transactions known to have completed since the statistics were reset TransactionCount
Transaction Count per Minute measurement The global number of transactions known to have completed since the statistics were reset TransactionCount
Collection Fetch Count measurement The global number of collections fetched since the statistics were reset CollectionFetchCount
Collection Fetch Count per Minute measurement The global number of collections fetched since the statistics were reset CollectionFetchCount
Session Close Count measurement The global number of sessions closed since the statistics were reset SessionCloseCount
Session Close Count per Minute measurement The global number of sessions closed since the statistics were reset SessionCloseCount
Query Cache Miss Count measurement The global number of cached queries *not* found in cache since the statistics were reset QueryCacheMissCount
Query Cache Miss Count per Minute measurement The global number of cached queries *not* found in cache since the statistics were reset QueryCacheMissCount
Second Level Cache Miss Count measurement The global number of cacheable entities/collections not found in the cache and loaded from the database since the statistics were reset SecondLevelCacheMissCount
Second Level Cache Miss Count per Minute measurement The global number of cacheable entities/collections not found in the cache and loaded from the database since the statistics were reset SecondLevelCacheMissCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.75. Metrics

Name Description
Clear Statistics Clear the collected statistics and begin collecting again
View Queries View statistical information about queries executed by Hibernate

Package Types

none

2.5.1. Hibernate Entity Service

Overview

Table 2.76. Overview

Description: A Hibernate persistent entity
Singleton: no
Plugin: Hibernate

Parent Resource Types

Child Resource Types

none

Connection Properties

none

Metrics

Table 2.77. Metrics

Name Type Description Internal Name
Load Count measurement The number of times this entity was loaded since the statistics were reset loadCount
Update Count measurement The number of times this entity was updated since the statistics were reset updateCount
Insert Count measurement The number of times this entity was inserted since the statistics were reset insertCount
Delete Count measurement The number of times this entity was deleted since the statistics were reset deleteCount
Fetch Count measurement The number of times this entity was fetched since the statistics were reset fetchCount
Optimistic Lock Failure Count measurement The number of StaleObjectStateExceptions for this entity that occurred since the statistics were reset optimisticFailureCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.6. IIS Server

Overview

Table 2.78. Overview

Description: IIS Web Server
Singleton: no
Plugin: IIS

Parent Resource Types

Child Resource Types

Autodiscovery Process Scans

none

Connection Properties

none

Metrics

Table 2.79. Metrics

Name Type Description Internal Name
Bytes Sent measurement Shows the rate that data bytes are sent by the Web service. Bytes Sent/sec
Bytes Sent per Minute measurement Shows the rate that data bytes are sent by the Web service. Bytes Sent/sec
Bytes Received measurement Shows the rate that data bytes are received by the Web service. Bytes Received/sec
Bytes Received per Minute measurement Shows the rate that data bytes are received by the Web service. Bytes Received/sec
Total Files Sent measurement Shows the total number of files sent by the Web service (counted since service startup). Total Files Sent
Total Files Sent per Minute measurement Shows the total number of files sent by the Web service (counted since service startup). Total Files Sent
Total Files Received measurement Shows the total number of files received by the Web service (counted since service startup). Total Files Received
Total Files Received per Minute measurement Shows the total number of files received by the Web service (counted since service startup). Total Files Received
Total Files Transferred measurement Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup). Total Files Transferred
Total Files Transferred per Minute measurement Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup). Total Files Transferred
Current Anonymous Users measurement Shows the number of users who currently have an anonymous connection using the Web service. Current Anonymous Users
Current NonAnonymous Users measurement Shows the number of users who currently have a non-anonymous connection using the Web service. Current NonAnonymous Users
Total Anonymous Users measurement Shows the total number of users who established an anonymous connection with the Web service (counted since service startup). Total Anonymous Users
Total Anonymous Users per Minute measurement Shows the total number of users who established an anonymous connection with the Web service (counted since service startup). Total Anonymous Users
Total Non Anonymous Users measurement Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup). Total NonAnonymous Users
Total Non Anonymous Users per Minute measurement Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup). Total NonAnonymous Users
Maximum Anonymous Users measurement Shows the maximum number of users who established concurrent anonymous connections using the Web service (counted since service startup). Maximum Anonymous Users
Maximum Non Anonymous Users measurement Shows the maximum number of users who established concurrent non-anonymous connections using the Web service (counted since service startup). Maximum NonAnonymous Users
Current Connections measurement Shows the current number of connections established with the Web service. Current Connections
Maximum Connections measurement Shows the maximum number of simultaneous connections established with the Web service. Maximum Connections
Total Logon Attempts measurement Shows the number of logons that have been attempted using the Web service (counted since service startup). Total Logon Attempts
Total Logon Attempts per Minute measurement Shows the number of logons that have been attempted using the Web service (counted since service startup). Total Logon Attempts
Total GET Requests measurement Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms. Total Get Requests
Total GET Requests per Minute measurement Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms. Total Get Requests
Total POST Requests measurement Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests. Total Post Requests
Total POST Requests per Minute measurement Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests. Total Post Requests
Total HEAD Requests measurement Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed. Total Head Requests
Total HEAD Requests per Minute measurement Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed. Total Head Requests
Total PUT Requests measurement Shows the number of HTTP requests using the PUT method (counted since service startup). Total Put Requests
Total PUT Requests per Minute measurement Shows the number of HTTP requests using the PUT method (counted since service startup). Total Put Requests
Total DELETE Requests measurement Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals. Total Delete Requests
Total DELETE Requests per Minute measurement Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals. Total Delete Requests
Total TRACE Requests measurement Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes. Total Trace Requests
Total TRACE Requests per Minute measurement Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes. Total Trace Requests
Total Other Request Methods measurement Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications. Total Other Request Methods
Total Other Request Methods per Minute measurement Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications. Total Other Request Methods
Total Method Requests measurement Shows the number of all HTTP requests (counted since service startup). Total Method Requests
Total Method Requests per Minute measurement Shows the number of all HTTP requests (counted since service startup). Total Method Requests
Total CGI Requests measurement Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup. Total CGI Requests
Total CGI Requests per Minute measurement Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup. Total CGI Requests
Total ISAPI Extension Requests measurement Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup. Total ISAPI Extension Requests
Total ISAPI Extension Requests per Minute measurement Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup. Total ISAPI Extension Requests
Total Not Found Errors measurement Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup. Total Not Found Errors
Total Not Found Errors per Minute measurement Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup. Total Not Found Errors
Total Locked Errors measurement Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup. Total Locked Errors
Total Locked Errors per Minute measurement Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup. Total Locked Errors
Current CGI Requests measurement Shows the current number of CGI requests that are simultaneously being processed by the Web service. Current CGI Requests
Current CGI Requests per Minute measurement Shows the current number of CGI requests that are simultaneously being processed by the Web service. Current CGI Requests
Current ISAPI Extension Requests measurement Shows the current number of Extension requests that are simultaneously being processed by the Web service. Current ISAPI Extension Requests
Maximum CGI Requests measurement Shows the maximum number of CGI requests simultaneously processed by the Web service. Maximum CGI Requests
Maximum ISAPI Extension Requests measurement Shows the maximum number of Extension requests simultaneously processed by the Web service. Maximum ISAPI Extension Requests
Total Blocked Async I/ O Requests measurement Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup). Total Blocked Async I/O Requests
Total Blocked Async I/ O Requests per Minute measurement Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup). Total Blocked Async I/O Requests
Total Allowed Async I/ O Requests measurement Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted. Total Allowed Async I/O Requests
Total Allowed Async I/ O Requests per Minute measurement Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted. Total Allowed Async I/O Requests
Total Rejected Async I/ O Requests measurement Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup). Total Rejected Async I/O Requests
Total Rejected Async I/ O Requests per Minute measurement Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup). Total Rejected Async I/O Requests
Current Blocked Async I/ O Requests measurement Shows current requests that are temporarily blocked due to bandwidth throttling settings. Current Blocked Async I/O Requests
Measured Async I/ O Bandwidth Usage measurement Shows the measured bandwidth of asynchronous I/O averaged over a minute. Measured Async I/O Bandwidth Usage
Total Connection Attempts (all instances) measurement Shows the number of connections that have been attempted using the Web service (counted since service startup). This counter is for all instances listed. Total Connection Attempts (all instances)
Total Connection Attempts (all instances) per Minute measurement Shows the number of connections that have been attempted using the Web service (counted since service startup). This counter is for all instances listed. Total Connection Attempts (all instances)
Service Uptime measurement The amount of time this service has been up for Service Uptime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.80. Metrics

Name Description
Start Starts IIS and, if necessary, dependent services
Stop Shuts down IIS

Package Types

none

2.6.1. VHost Service

Overview

Table 2.81. Overview

Description: IIS VHost
Singleton: no
Plugin: IIS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.82. 

Name Description Required Internal Name
Site Name yes siteName
Hostname yes hostname
Port yes port
Ip Address yes ipAddress
Doc Root yes docRoot
Ssl yes ssl
Log Directory yes logDirectory
Log Format The format log entries are written in. This is a per-site, general option of the W3C Extended Log File Format. Format must contain the following tokens - 'date' ,'time' , 'c-ip', 'cs-uri-stem', 'sc-status', and 'time-taken' - but can include others. Tokens must *not* have quotes around them, and should be space-delimited. yes responseTimeLogFormat
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.83. Metrics

Name Type Description Internal Name
Bytes Sent measurement Shows the rate that data bytes are sent by the Web service. Bytes Sent/sec
Bytes Sent per Minute measurement Shows the rate that data bytes are sent by the Web service. Bytes Sent/sec
Bytes Received measurement Shows the rate that data bytes are received by the Web service. Bytes Received/sec
Bytes Received per Minute measurement Shows the rate that data bytes are received by the Web service. Bytes Received/sec
Total Files Sent measurement Shows the total number of files sent by the Web service (counted since service startup). Total Files Sent
Total Files Sent per Minute measurement Shows the total number of files sent by the Web service (counted since service startup). Total Files Sent
Total Files Received measurement Shows the total number of files received by the Web service (counted since service startup). Total Files Received
Total Files Received per Minute measurement Shows the total number of files received by the Web service (counted since service startup). Total Files Received
Total Files Transferred measurement Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup). Total Files Transferred
Total Files Transferred per Minute measurement Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup). Total Files Transferred
Current Anonymous Users measurement Shows the number of users who currently have an anonymous connection using the Web service. Current Anonymous Users
Current NonAnonymous Users measurement Shows the number of users who currently have a non-anonymous connection using the Web service. Current NonAnonymous Users
Total Anonymous Users measurement Shows the total number of users who established an anonymous connection with the Web service (counted since service startup). Total Anonymous Users
Total Anonymous Users per Minute measurement Shows the total number of users who established an anonymous connection with the Web service (counted since service startup). Total Anonymous Users
Total Non Anonymous Users measurement Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup). Total NonAnonymous Users
Total Non Anonymous Users per Minute measurement Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup). Total NonAnonymous Users
Maximum Anonymous Users measurement Shows the maximum number of users who established concurrent anonymous connections using the Web service (counted since service startup). Maximum Anonymous Users
Maximum Non Anonymous Users measurement Shows the maximum number of users who established concurrent non-anonymous connections using the Web service (counted since service startup). Maximum NonAnonymous Users
Current Connections measurement Shows the current number of connections established with the Web service. Current Connections
Maximum Connections measurement Shows the maximum number of simultaneous connections established with the Web service. Maximum Connections
Total Logon Attempts measurement Shows the number of logons that have been attempted using the Web service (counted since service startup). Total Logon Attempts
Total Logon Attempts per Minute measurement Shows the number of logons that have been attempted using the Web service (counted since service startup). Total Logon Attempts
Total GET Requests measurement Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms. Total Get Requests
Total GET Requests per Minute measurement Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms. Total Get Requests
Total POST Requests measurement Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests. Total Post Requests
Total POST Requests per Minute measurement Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests. Total Post Requests
Total HEAD Requests measurement Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed. Total Head Requests
Total HEAD Requests per Minute measurement Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed. Total Head Requests
Total PUT Requests measurement Shows the number of HTTP requests using the PUT method (counted since service startup). Total Put Requests
Total PUT Requests per Minute measurement Shows the number of HTTP requests using the PUT method (counted since service startup). Total Put Requests
Total DELETE Requests measurement Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals. Total Delete Requests
Total DELETE Requests per Minute measurement Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals. Total Delete Requests
Total TRACE Requests measurement Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes. Total Trace Requests
Total TRACE Requests per Minute measurement Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes. Total Trace Requests
Total Other Request Methods measurement Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications. Total Other Request Methods
Total Other Request Methods per Minute measurement Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications. Total Other Request Methods
Total Method Requests measurement Shows the number of all HTTP requests (counted since service startup). Total Method Requests
Total Method Requests per Minute measurement Shows the number of all HTTP requests (counted since service startup). Total Method Requests
Total CGI Requests measurement Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup. Total CGI Requests
Total CGI Requests per Minute measurement Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup. Total CGI Requests
Total ISAPI Extension Requests measurement Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup. Total ISAPI Extension Requests
Total ISAPI Extension Requests per Minute measurement Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup. Total ISAPI Extension Requests
Total Not Found Errors measurement Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup. Total Not Found Errors
Total Not Found Errors per Minute measurement Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup. Total Not Found Errors
Total Locked Errors measurement Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup. Total Locked Errors
Total Locked Errors per Minute measurement Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup. Total Locked Errors
Current CGI Requests measurement Shows the current number of CGI requests that are simultaneously being processed by the Web service. Current CGI Requests
Current CGI Requests per Minute measurement Shows the current number of CGI requests that are simultaneously being processed by the Web service. Current CGI Requests
Current ISAPI Extension Requests measurement Shows the current number of Extension requests that are simultaneously being processed by the Web service. Current ISAPI Extension Requests
Maximum CGI Requests measurement Shows the maximum number of CGI requests simultaneously processed by the Web service. Maximum CGI Requests
Maximum ISAPI Extension Requests measurement Shows the maximum number of Extension requests simultaneously processed by the Web service. Maximum ISAPI Extension Requests
Total Blocked Async I/ O Requests measurement Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup). Total Blocked Async I/O Requests
Total Blocked Async I/ O Requests per Minute measurement Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup). Total Blocked Async I/O Requests
Total Allowed Async I/ O Requests measurement Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted. Total Allowed Async I/O Requests
Total Allowed Async I/ O Requests per Minute measurement Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted. Total Allowed Async I/O Requests
Total Rejected Async I/ O Requests measurement Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup). Total Rejected Async I/O Requests
Total Rejected Async I/ O Requests per Minute measurement Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup). Total Rejected Async I/O Requests
Current Blocked Async I/ O Requests measurement Shows current requests that are temporarily blocked due to bandwidth throttling settings. Current Blocked Async I/O Requests
Measured Async I/ O Bandwidth Usage measurement Shows the measured bandwidth of asynchronous I/O averaged over a minute. Measured Async I/O Bandwidth Usage
HTTP Response Time calltime the minimum, maximum, and average response times for HTTP requests serviced by this virtual host ResponseTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.7. JBoss AS 4.x

Overview

Table 2.84. Overview

Description: JBoss Application Server
Singleton: no
Plugin: JBossAS

Binding to IP addresses
When starting JBossAS instances that need to be monitored using remote JMX (i.e. JNP), it is necessary for the java.rmi.server.hostname System property to be set to the same value as the server's JNP address (which is set to the jboss.bind.address System property by default). Due to bugs in JBossAS (for more information please see JBAS-4736 and JBAS-4955), java.rmi.server.hostname will default to 127.0.0.1, unless JBossAS is started using -b, in which case java.rmi.server.hostname will default to the bind address specified as the argument to -b.
Therefore, you must start your JBossAS instances by using either -b:
        run -b 12.34.56.78 ...
or by explicitly specifying a value for java.rmi.server.hostname via -D or -P, e.g.:
        run -Djboss.bind.address=12.34.56.78 -Djava.rmi.server.hostname=12.34.56.78 ...
Otherwise, you will not be able to manage the instance via JON.

Important

Using -b is the recommended way to specify the bind address, since, in addition to setting jboss.bind.address and java.rmi.server.hostname, it will also set other JGroups-related System properties to the specified address.
Monitoring of EJB 2.x EJBs
The issue here is that JBossAS changed the way it creates the MBean names of the deployed EJBs from the JNDI names / EJB names (this happened around version 4.0.3.sp1). Basically the <jndi-name>, or <local-jndi-name> if <jndi-name> is not present, from jboss.xml is used.
So the workaround is to set the <jndi-name> to the ejb-name in your application. As this probably breaks client code, you will want to setup a naming reference that restores the original hierarchy. For example, if you have in jboss.xml:
           <session>
           <ejb-name>Ability</ejb-name>
           <local-jndi-name>flower.AbilityLocal</local-jndi-name>
You might change this to:
           <session>
           <ejb-name>Ability</ejb-name>
           <local-jndi-name>Ability</local-jndi-name>
And then add an MBean flowsys-naming-alias-service.xml:
           <mbean code="org.jboss.naming.NamingAlias"
                  name=":service=naming-alias">
              <attribute name="ToName">flower.AbilityLocal</attribute>
              <attribute name="FromName">Ability</attribute>
           </mbean>
After you have done this, go into the inventory of the respective beans, edit the configuration and then click OK.
The naming alias ensures that clients of the Ability EJB can still find the bean in JNDI at the original location. Naming aliases appear in JNDIView (within JMX-Console) as LinkRef.

Parent Resource Types

Child Resource Types

Autodiscovery Process Scans

Table 2.85. Metrics

Name Query
JBoss4 process|basename|match=^java.*,arg|org.jboss.Main|match=.*

Connection Properties

Table 2.86. 

Name Description Required Internal Name
Naming Provider URL The JNP URL with which to connect to the JBoss Application Server instance (e.g. jnp://127.0.0.1:1099). yes namingURL
Principal The name of the principal (i.e. user) to authenticate. no principal
Credentials The credentials (i.e. password) that should be used to authenticate the principal. no credentials
JBoss Home Directory The absolute path to the directory where JBossAS is installed (e.g. /opt/jboss-4.2.2.GA). yes jbossHomeDir
Configuration Path The path to the configuration directory under which this instance operates (e.g. /opt/jboss-4.2.2.GA/server/default); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}. yes configurationPath
Configuration Set The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {configurationPath}. no configurationSet
Script Prefix A prefix applied to script execution commands. Typically a sudo for applicable platforms. The prefix is applied verbatim. As such, a sudo user must be configured appropriately. Ignored if not set. no scriptPrefix
Start Script The path to the script used by the 'Start' operation to start this JBossAS server (e.g. /opt/jboss-4.2.2.GA/bin/run.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/run.sh' on UNIX or 'bin\run.bat' on Windows. no startScript
Shutdown Script The path to the script used by the 'Shutdown' operation to shutdown this JBossAS server (e.g. /opt/jboss-4.2.2.GA/bin/shutdown.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/shutdown.sh' on UNIX or 'bin\shutdown.bat' on Windows. no shutdownScript
Shutdown Method The method used to execute the Shutdown operation; defaults to 'JMX MBean'. no shutdownMethod
Binding Address The host or IP address used by all JBoss services as the binding address (e.g. 10.11.14.233); specify 0.0.0.0 to tell JBossAS to bind to all available network interfaces; defaults to '127.0.0.1'. no bindingAddress
JAVA_HOME Path The absolute path to a JRE or JDK installation directory containing the JVM that should be used to start and shutdown the JBossAS instance; defaults to the home directory of the RHQ agent JRE. no javaHomePath
Log Event Sources yes logEventSources
Snapshot Config Enabled If true, take a snapshot of the configuration yes snapshotConfigEnabled
Snapshot Config Directory The directory containing the configuration files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path. yes snapshotConfigDirectory
Snapshot Config Regex If defined, this regular expression must match a configuration file name if that file is to be captured in the snapshot. If not defined, all configuration files will be captured. no snapshotConfigRegex
Snapshot Config Recursive If true, the snapshot will include files located in subdirectories under the config directory. yes snapshotConfigRecursive
Snapshot Log Enabled If true, take a snapshot of the log files yes snapshotLogEnabled
Snapshot Log Directory The directory containing the log files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path. yes snapshotLogDirectory
Snapshot Log Regex If defined, this regular expression must match a log file name if that file is to be captured in the snapshot. If not defined, all log files will be captured. no snapshotLogRegex
Snapshot Log Recursive If true, the snapshot will include files located in subdirectories under the log directory. yes snapshotLogRecursive
Snapshot Data Enabled If true, take a snapshot of the data files yes snapshotDataEnabled
Snapshot Data Directory The directory containing the data files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path. yes snapshotDataDirectory
Snapshot Data Regex If defined, this regular expression must match a data file name if that file is to be captured in the snapshot. If not defined, all data files will be captured. no snapshotDataRegex
Snapshot Data Recursive If true, the snapshot will include files located in subdirectories under the data directory. yes snapshotDataRecursive
Snapshot Additional Files List Additional files to be included in the snapshot report yes snapshotAdditionalFilesList
Type The type of the connection. yes type
Shutdown MBean Name Name of the MBean to use when shutting down this server through JMX. yes shutdownMbeanName
Shutdown MBean Operation Name of the operation to invoke when shutting down this server through JMX. Note that only operations with no parameter or with one int parameter are supported. If the operation requires an int parameter, '0' will be supplied. yes shutdownMbeanOperation
Availability Check Period The amount of time, in seconds, that must elapse between availability checks to see if the server is up. If set, the availability checks will be performed asynchronously thus allowing slow-responding servers to avoid being falsely reported as down. no availabilityCheckPeriod
JBoss AS JVM Name The name of the JBoss AS JVM resource. no childJmxServerName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.87. Metrics

Name Type Description Internal Name
Partition Name trait the name of the cluster partition this app server instance belongs to partitionName
Version Name trait the code name for the this app server instance's major version (AS 3.2 = WonderLand, AS 4.0 = Zion, AS 4.2 = Trinity, EAP 4.x = EAP, SOA 4.x = SOA) jboss.system:type=Server:VersionName
Build Date trait the date this app server was built jboss.system:type=Server:BuildDate
Start Date trait the date and time this app server instance was started jboss.system:type=Server:StartDate
Active Thread Count measurement The current number of active threads for this app server instance jboss.system:type=ServerInfo:ActiveThreadCount
Active Thread Group Count measurement The current number of active thread groups for this app server instance jboss.system:type=ServerInfo:ActiveThreadGroupCount
JVM Free Memory measurement An approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytes jboss.system:type=ServerInfo:FreeMemory
JVM Max Memory measurement The maximum amount of memory that the app server JVM will attempt to use, measured in bytes; if there is no inherent limit then the value Long.MAX_VALUE will be returned jboss.system:type=ServerInfo:MaxMemory
JVM Total Memory measurement The total amount of memory currently available in the app server JVM for current and future objects, measured in bytes jboss.system:type=ServerInfo:TotalMemory
Total Transactions measurement Total number of transactions since last restart jboss:service=TransactionManager:TransactionCount
Total Transactions per Minute measurement Total number of transactions since last restart jboss:service=TransactionManager:TransactionCount
Transactions Committed measurement Number of transactions commited since last restart jboss:service=TransactionManager:CommitCount
Transactions Committed per Minute measurement Number of transactions commited since last restart jboss:service=TransactionManager:CommitCount
Transactions Rolledback measurement Number of transactions commited since last restart jboss:service=TransactionManager:RollbackCount
Transactions Rolledback per Minute measurement Number of transactions commited since last restart jboss:service=TransactionManager:RollbackCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.88. Metrics

Name Description
Start Start this application server. The script used is specified in the Operations group of connection properties.
Shutdown Shutdown this application server via script or JMX depending on the settings in the Operations and Advanced groups of connection properties.
Restart Shutdown and then start this application server.

Package Types

Table 2.89. Package Types

Name Category Description
Cumulative Patch Deployable Automatically installable application server patches
Jar Library Deployable Library Jar files deployed in JBoss AS

2.7.1. ConnectionFactory Service

Overview

Table 2.90. Overview

Description:
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.91. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this Connection Factory yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.92. Metrics

Name Type Description Internal Name
Available Connection Count measurement Number of available connections. AvailableConnectionCount
Connection Count measurement Connection Count ConnectionCount
Connection Created Count measurement Connection Created Count ConnectionCreatedCount
Connection Destroyed Count measurement Connection Destroyed Count ConnectionDestroyedCount
In Use Connection Count measurement Mumber of connections currently in use. InUseConnectionCount
Max Connections In Use Count measurement Maximum number of maximum connections that have been in use. MaxConnectionsInUseCount
Max Size measurement Max Size MaxSize
Min Size measurement Min Size MinSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.93. 

Name Description Required Internal Name
Connection Factory Type Connection Factory Type (Tx or no Tx) yes type
JNDI Name The JNDI Name under which the DataSource wrapper will be bound. yes jndi-name
User Name This element specifies the default username used when creating a new connection. The actual username may be overridden by the application code getConnection parameters or the connection creation context JAAS Subject. no user-name
Password This element specifies the default password used when creating a new connection. The actual password may be overridden by the application code getConnection parameters or the connection creation context JAAS Subject. no password
Minimum Pool Size Indicates the minimum number of connections the pool should hold. no min-pool-size
Maximum Pool Size Indicates the maximum number of connections the pool should hold. no max-pool-size
Application Managed Security Specifying this element indicates that connections in the pool should be distinguished by application code supplied parameters, such as from getConnection(user, pw). This requires that you set a security domain which will populate a security-domain-and-application tag. If it is missing this resource will not be created or saved. no application-managed-security
Security Domain/Security Domain and Application Indicates Subjects from security domain are used to distinguish connections in this pool. If Application Managed Security is set to true, then this will create a security-domain tag. If it is set to false or unset, then this property will populate a security-domain-and-application tag. no security-domain
Adapter Display Name used to identify the RAR deployment matching the display-name in the ra.xml no adapter-display-name
Depends The depends element specifies the JMX ObjectName string of a service that the connection manager services depend on. The connection manager service will not be started until the dependent services have been started. no depends
Rar Name This is the name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar. yes rar-name
Connection Definition This is the connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. yes connection-definition
Type Mappings This element declares a default type mapping for this datasource. The type mapping should match a type-mapping/name element from standardjbosscmp-jdbc.xml. no type-mapping
Use Java Context Indicates if the JNDI name should be prefixed with java:. no use-java-context
Transaction Type Whether to use local or xa transactions. If nothing is specified, the default of local will be used. no transaction-type
No Tx Separate Pools The presence of this element indicates that two connection pools are required to isolate connections used with JTA transaction from those used without a JTA transaction. The pools are lazily constructed on first use. Its use case is for Oracle (and possibly other vendors) XA implementations that don't like using an XA connection with and without a JTA transaction. no no-tx-separate-pools
Track Connection By Transaction Whether the connection should be locked into the transaction. no track-connection-by-tx
isSameRM Override Value Allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRMXAResource returns true or false. The default is not to override the return value. no isSameRM-override-value
Use Strict Minimum Whether on not to use strict minumum. no use-strict-min
Prefill Prefill the Pool with Connection objects, or lazy load objects in the pool no prefill
Blocking Timeout in Milliseconds Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. If nothing is specified the default of 30000 milliseconds is used. no blocking-timeout-millis
Idle Timeout Maximum time in minutes a connection can be idle before it is closed. no idle-timeout-minutes
XA Resource Timeout Maximum time in minutes an XA Resource can be idle before it is removed. no xa-resource-timeout
New Connection SQL Specify an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Check Valid Connection SQL Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Config Property Configuration Properties no config-property

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

none

Package Types

none

2.7.2. Datasource Service

Overview

Table 2.94. Overview

Description:
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.95. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this datasource yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.96. Metrics

Name Type Description Internal Name
Total Connections measurement Total Number of Connections for the Connection Pool, both active and in-active. ConnectionCount
Available Connections measurement Number of available connections in the connection pool in-active and waiting. AvailableConnectionCount
Active Connections measurement Number of Connections currently supporting clients. InUseConnectionCount
Connections Created measurement Number of Connections created since the Connection Pool was created. ConnectionCreatedCount
Connections Created per Minute measurement Number of Connections created since the Connection Pool was created. ConnectionCreatedCount
Connections Destroyed measurement Number of Connections destroyed since the Connection Pool was created. ConnectionDestroyedCount
Connections Destroyed per Minute measurement Number of Connections destroyed since the Connection Pool was created. ConnectionDestroyedCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.97. 

Name Description Required Internal Name
Type yes type
JNDI Name The JNDI name under which the DataSource wrapper will be bound. yes jndi-name
Driver Class The fully qualified name of the JDBC driver or datasource class. Not used for XA-Datasources. yes driver-class
Connection Url The JDBC driver connection URL string. Needed for Tx and Non-Tx datasources. yes connection-url
User Name no user-name
Password no password
Min Pool Size no min-pool-size
Max Pool Size no max-pool-size
Transaction Isolation The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. no transaction-isolation
Blocking Timeout Millis Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. If nothing is specified the default of 30000 milliseconds is used. no blocking-timeout-millis
Idle Timeout Minutes Indicates the maximum time in minutes a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes of any pool. If nothing is specified the default of 15 minutes is used. no idle-timeout-minutes
Prepared Statement Cache Size The number of prepared statements per connection in an LRU cache. no prepared-statement-cache-size
Valid Connection Checker Class Name An org.jboss.resource.adapter.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Use Java Context Indicates if the JNDI name should be prefixed with java: which causes the DataSource to only be accessible from within the JBoss server vm. The default is Yes. no use-java-context
Security Domain Indicates Subjects (from security domain) are used to distinguish connections in the pool. The content of the security domain is the name of the JAAS security manager that will handle authentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. Must be specified if either Container Based or Container and Application Based authentication types are specified. no security-domain
New Connection Sql Specify an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Exception Sorter Class Name An org.jboss.resource.adapter.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred message. no exception-sorter-class-name
Check Valid Connection Sql Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Track Statements Whether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/returned to the prepared statement cache. The default is Yes, but no warnings. no track-statements
XA Datasource Class The datasource class for XA connections. no xa-datasource-class
Connection Property no connection-property
No Tx Separate Pools Whether to use separate pools for connections retrieved in a transaction and those retrieved outside a transaction. The default is Yes. no no-tx-separate-pools
Application Managed Security no application-managed-security
Security Domain And Application no security-domain-and-application
Track Connection By Tx Whether the connection should be "locked" to the transaction, returning it to the pool at the end of the transaction. The default is No. no track-connection-by-tx
Is Same RM Override Value Allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false. The default is not to override the return value. no isSameRM-override-value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.98. Metrics

Name Description
Flush Resets the connection pool for this datasource. Performs the following steps: 1) all idle connections are immediately closed, 2) any in use connections are closed when the application finishes with them, and 3) new connections are created.

Package Types

none

2.7.3. EJB3 Entity Tree Cache Service

Overview

Table 2.99. Overview

Description: The entity cache
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.100. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.101. Metrics

Name Type Description Internal Name
Number Of Locks Held measurement The number of entities locked for update / replication across the (clustered) tree cache NumberOfLocksHeld
Number Of Nodes measurement The total number of entities currently cached across the (clustered) tree cache NumberOfNodes

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.7.3.1. EJB3 Entity Tree Cache Interceptor Service

Overview

Table 2.102. Overview

Description: The entity cache interceptor
Singleton: no
Plugin: JBossAS

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.103. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.104. Metrics

Name Type Description Internal Name
Hit Miss Ratio measurement Returns the hit/miss ratio for the cache. This ratio is defined as hits/(hits + misses). HitMissRatio
Read Write Ratio measurement Returns the read/write ratio for the cache. This ratio is defined as (hits + misses)/stores. ReadWriteRatio
Hits measurement Returns the number of requests made to this cache which it could answer without interrogating the underlying data store Hits
Misses measurement Returns the number of requests made to this cache which required interrogating the underlying data store Misses
Evictions measurement Returns the number of elements purged from this cache in accordance with its specific eviction policy Evictions
Number Of Locks Held measurement The number of elements locked by this interceptor for update / replication across the (clustered) tree cache NumberOfLocksHeld
Number Of Nodes measurement The total number of entities currently cached across the (clustered) tree cache NumberOfNodes
Average Write Time measurement The average time it takes to insert or update elements for the cache AverageWriteTime
Time Since Reset measurement The amount of time since this cache was reset / cleared TimeSinceReset
Average Read Time measurement The average time it takes to read elements for the cache, includes AverageReadTime
Stores measurement Number of store / writes into this cache made by this interceptor Stores
Number Of Attributes measurement The total number of attributes (properties of an entity) currently cached across the (clustered) tree cache NumberOfAttributes
Elapsed Time measurement The amount of time since this cache was created ElapsedTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none

2.7.4. EJB3 Session Bean Service

Overview

Table 2.105. Overview

Description: An EJB3 Stateless or Stateful Session Bean
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.106. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this bean yes name
Ear yes ear
Jar yes jar

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.107. Metrics

Name Type Description Internal Name
Current Count measurement The total number of currently pooled instances of this EJB3 Session Bean CurrentSize
Create Count measurement The number of instances of this EJB3 Session Bean that have been created since server start CreateCount
Create Count per Minute measurement The number of instances of this EJB3 Session Bean that have been created since server start CreateCount
Remove Count measurement The number of instances of this EJB3 Session Bean that have been removed since server start RemoveCount
Remove Count per Minute measurement The number of instances of this EJB3 Session Bean that have been removed since server start RemoveCount
Available Count measurement The number of pooled instances of this EJB3 Session Bean in the method-ready state AvailableCount
Max Size measurement The maximum number of instances that are allowed to be pooled MaxSize
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB; NOTE: this metric is only available if JBoss EJB3 RC9 Patch 1 or later is being used (a capable version of EJB3 is included with JBossAS 4.2.0.GA or later) MethodInvocationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.108. Metrics

Name Description
View Method Stats View method execution statistics for the EJB; NOTE: this operation is only available if JBoss EJB3 RC9 Patch 1 or later is being used (a capable version of EJB3 is included with JBossAS 4.2.0.GA or later)

Package Types

none

2.7.5. Embedded Tomcat Server

Overview

Table 2.109. Overview

Description: Tomcat Web Application Container embedded in a JBossAS Server
Singleton: yes
Plugin: JBossAS

Parent Resource Types

Child Resource Types

Autodiscovery Process Scans

none

Connection Properties

none

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

2.7.5.1. Connector Service

Overview

Table 2.110. Overview

Description:
Singleton: no
Plugin: JBossAS

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.111. 

Name Description Required Internal Name
Object Name yes objectName
Port Port this connector listens on. yes port
Address Address this connector listens on. yes address
Scheme The scheme of the protocol used by this connector (e.g. jk, ajp, http, https). yes schema
Name Template yes nameTemplate
Description Template yes descriptionTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.112. Metrics

Name Type Description Internal Name
Maximum Request Time measurement Maximum time it took to process a request jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:maxTime
Request count measurement Total number of requests processed since last restart. jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:requestCount
Request count per Minute measurement Total number of requests processed since last restart. jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:requestCount
Error count measurement Number of errors while processing since last restart. jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:errorCount
Error count per Minute measurement Number of errors while processing since last restart. jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:errorCount
Threads Active measurement Threads Active jboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:currentThreadsBusy
Threads Allocated measurement Threads Allocated jboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:currentThreadCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none

2.7.5.2. VHost Service

Overview

Table 2.113. Overview

Description: A virtual host in the web container
Singleton: no
Plugin: JBossAS

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.114. 

Name Description Required Internal Name
Object Name yes objectName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.115. Metrics

Name Type Description Internal Name
Aliases trait The aliases for this virtual host jboss.web:type=Host,host=%name%:aliases

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none

2.7.6. Enterprise Application (EAR) Service

Overview

Table 2.116. Overview

Description: Enterprise Application
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.117. 

Name Description Required Internal Name
Name The name of this EAR yes name
Filename yes filename
Object Name yes objectName
Name Template yes nameTemplate
Extension yes extension
Description Template yes descriptionTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.118. Metrics

Name Type Description Internal Name
Path trait The absolute path of this EAR file or directory Application.path
Exploded? trait Whether this EAR is deployed exploded (i.e. as a directory) Application.exploded

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.119. Metrics

Name Description
Revert Tries to revert this enterprise application from a saved backup in the same directory and with a name ending in .bak

Package Types

Table 2.120. Package Types

Name Category Description
EAR File Deployable

2.7.6.1. Embedded Web Application (WAR) Service

Overview

Table 2.121. Overview

Description: Web Application embedded inside of an Enterprise Application
Singleton: no
Plugin: JBossAS

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.122. 

Name Description Required Internal Name
Name The name of this WAR yes name
Filename yes filename
Object Name yes objectName
Context Root this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR no contextRoot
Virtual Host The (virtual) host that this application is running on. If no virtual host is set, this defaults to 'localhost' no vHost
Jboss Web Name the objectName for the jboss.web WebModule that will be used to fire operations no jbossWebName
Response Time Log File the full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Name Template yes nameTemplate
Extension yes extension
Description Template yes descriptionTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.123. Metrics

Name Type Description Internal Name
Path trait the absolute path of this WAR file or directory Application.path
Exploded? trait whether this WAR is deployed exploded (i.e. as a directory) Application.exploded
Context Root trait this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR ContextRoot
HTTP Response Time calltime the minimum, maximum, and average response times for HTTP requests serviced by this webapp ResponseTime
Min. Servlet Resp. Time measurement Minimum response time of a servlet Servlet.MinResponseTime
Avg. Servlet Resp. Time measurement Average response time of a servlet Servlet.AvgResponseTime
Max. Servlet Resp. Time measurement Maximum response time of a servlet Servlet.MaxResponseTime
Total processing time measurement Total processing time of the webapp Servlet.TotalTime
Total processing time per Minute measurement Total processing time of the webapp Servlet.TotalTime
Requests served measurement Number of requests served by servlets Servlet.NumRequests
Requests served per Minute measurement Number of requests served by servlets Servlet.NumRequests
Errors while processing measurement Number of errors while processing Servlet.NumErrors
Errors while processing per Minute measurement Number of errors while processing Servlet.NumErrors
Currently Active Sessions measurement Number active sessions for the webapp right now Session.activeSessions
Maximum number of Active Sessions measurement Maximum number of active sessions for the webapp Session.maxActive
Sessions created measurement Number of sessions created for the webapp Session.sessionCounter
Sessions created per Minute measurement Number of sessions created for the webapp Session.sessionCounter
Expired Sessions measurement Number of expired sessions for the webapp Session.expiredSessions
Expired Sessions per Minute measurement Number of expired sessions for the webapp Session.expiredSessions
Rejected Sessions measurement Number of sessions rejected for the webapp Session.rejectedSessions
Rejected Sessions per Minute measurement Number of sessions rejected for the webapp Session.rejectedSessions
Session Average alive time measurement Average alive time of a Sessions Session.sessionAverageAliveTime
Max Session alive time measurement Maximum alive time of a Sessions Session.sessionMaxAliveTime
Vhost trait Virtual hosts this app runs on Vhost.name

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations

Table 2.124. Metrics

Name Description
Start starts this webapp; NOTE: this operation is *not* supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006)
Stop stops this webapp; NOTE: this operation is *not* supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006)
Reload reloads this webapp; NOTE: if the webapp is not in the started state, this operation will fail

Package Types
none

2.7.7. Entity EJB Service

Overview

Table 2.125. Overview

Description: An EJB 1.x or 2.x Entity Bean
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.126. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this ejb yes name
J 2ee Application yes j2eeApplication
Ejb Jar yes ejbJar

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.127. Metrics

Name Type Description Internal Name
Create Calls measurement The number of instances of this EJB 1.x or 2.x Entity Bean that have been created since server start {stats.createCount.count}
Create Calls per Minute measurement The number of instances of this EJB 1.x or 2.x Entity Bean that have been created since server start {stats.createCount.count}
Remove Calls measurement The number of instances of this EJB 1.x or 2.x Entity Bean that have been removed since server start {stats.removeCount.count}
Remove Calls per Minute measurement The number of instances of this EJB 1.x or 2.x Entity Bean that have been removed since server start {stats.removeCount.count}
Method-Ready Beans measurement The number of pooled instances of this EJB 1.x or 2.x Entity Bean in the method-ready state {stats.methodReadyCount.current}
Pooled Beans measurement The total number of currently pooled instances of this EJB 1.x or 2.x Entity Bean {stats.pooledCount.current}
Cache Size measurement The total number of currently cached instances of this EJB 1.x or 2.x Entity Bean {{jboss.j2ee:jndiName=%name%,plugin=cache,service=EJB}CacheSize}
Passivated Count measurement The number of pooled instances of this EJB 1.x or 2.x Entity Bean in the passivated state {{jboss.j2ee:jndiName=%name%,plugin=cache,service=EJB}PassivatedCount}
Passivated Count per Minute measurement The number of pooled instances of this EJB 1.x or 2.x Entity Bean in the passivated state {{jboss.j2ee:jndiName=%name%,plugin=cache,service=EJB}PassivatedCount}
Current Size measurement The total number of currently pooled instances of this EJB 1.x or 2.x Entity Bean {{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}PoolSize}
Max Size measurement The maximum number of instances that are allowed to be pooled {{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}MaxPoolSize}

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.7.8. JBossMessaging Service

Overview

Table 2.128. Overview

Description: The JBoss Messaging subsystem
Singleton: yes
Plugin: JBossAS

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.129. 

Name Description Required Internal Name
Object Name yes objectName
Name yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.130. Metrics

Name Type Description Internal Name
Version of the Provider trait The version of JBoss Messaging in use jboss.messaging:service=ServerPeer:ProviderVersion

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.7.8.1. JBM JMS Queue Service

Overview

Table 2.131. Overview

Description:
Singleton: no
Plugin: JBossAS

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.132. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this queue yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.133. Metrics

Name Type Description Internal Name
Messages in Queue measurement The number of messages in the queue. MessageCount
Consumer Count measurement The number of ClientConsumers waiting for a message. ConsumerCount
Scheduled Message Count measurement The number of scheduled messages in the Queue ScheduledMessageCount
Created programmatically trait Was this Queue created dynamically CreatedProgrammatically
Delivering Count measurement The number of messages currently being delivered DeliveringCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 2.134. 

Name Description Required Internal Name
Server Peer The ObjectName of the server peer this destination was deployed on. yes ServerPeer
Dead Letter Queue The DLQ for this queue, overrides the default DLQ on the server peer. no DLQ
Expiry Queue By default, JBoss Messaging silently removes expired JMS message from its destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMessaging destination. no ExpiryQueue
JNDI Name The location in JNDI to which the queue object will be bound. If this is not set it will be bound under the queue context using the name of the queue. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples. no JNDIName
Clustered Is this a clustered destination? no Clustered
Max Delivery Attempts The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely) no MaxDeliveryAttempts
Redelivery Delay The length of time in milliseconds to wait before a message is redelivered after a nack no RedeliveryDelay
Message Counter History Day Limit Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count. no MessageCounterHistoryDayLimit
Maximum Queue Size The maximum number of messages this queue can hold before they are dropped (-1 = infinite) no MaxSize
Full Size The in-memory message limit, can only be set when queue is stopped no FullSize
Page Size The paging size, can only be set when queue is stopped no PageSize
Down Cache Size The write-cache size, can only be set when queue is stopped no DownCacheSize
Security Configurations This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. yes SecurityConfig
Queue Name Name of the queue to be used in the JMX object name. yes MBeanName
JNDI Binding Binding path of this Queue in JNDI. yes JNDIBinding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 2.135. Metrics

Name Description
Remove All Messages Clears all Messages in the Queue
Reset Message Counter Clears the MessageCounter data for this Queue
Reset Message Counter History Clears the MessageCounter history data for this Queue
List Messages by Selector Lists the Messages in the Queue by Selector (if provided). Selector is not required.
List All Messages Lists All Messages by Selector (if provided). Selector is not required.
List Durable Messages Lists Durable Messages by Selector (if provided). Selector is not required.
List Non-Durable Messages Lists Non-Durable Messages by Selector (if provided). Selector is not required.

Package Types
none

2.7.8.2. JBM JMS Topic Service

Overview

Table 2.136. Overview

Description:
Singleton: no
Plugin: JBossAS

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.137. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this topic yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.138. Metrics

Name Type Description Internal Name
All Message Counter measurement Returns the total message count for all subscriptions. AllMessageCount
Durable Message Count measurement Total number of messages for all durable subscriptions. DurableMessageCount
Non-durable Message Count measurement Total number of messages for all non-durable subscriptions. NonDurableMessageCount
All Subscription Count measurement Number of subscriptions waiting for a message. AllSubscriptionsCount
Durable Subscription Count measurement Number of durable subscriptions waiting for a message. DurableSubscriptionsCount
Non-durable Subscription Count measurement Number of non-durable subscriptions waiting for a message. NonDurableSubscriptionsCount
Created programmatically trait Was this Topic created dynamically CreatedProgrammatically

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 2.139. 

Name Description Required Internal Name
Server Peer The ObjectName of the server peer this destination was deployed on. yes ServerPeer
Dead Letter Queue The DLQ for this queue, overrides the default DLQ on the server peer. no DLQ
Expiry Queue By default, JBoss Messaging silently removes expired JMS message from its destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMessaging destination. no ExpiryQueue
JNDI Name The location in JNDI to which the topic will be bound. If this is not set it will be bound under the topic context using the mbean name of the topic. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples. no JNDIName
Clustered Is this a clustered destination? no Clustered
Max Delivery Attempts The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely) no MaxDeliveryAttempts
Redelivery Delay The length of time in milliseconds to wait before a message is redelivered after a NACK no RedeliveryDelay
Message Counter History Day Limit Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count. no MessageCounterHistoryDayLimit
Maximum Queue Size The maximum number of messages this queue can hold before they are dropped (-1 = infinite) no MaxSize
Full Size The in-memory message limit, can only be set when queue is stopped no FullSize
Page Size The paging size, can only be set when queue is stopped no PageSize
Down Cache Size The write-cache size, can only be set when queue is stopped no DownCacheSize
Security Configurations This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. yes SecurityConfig
Topic Name Name of the queue to be used in the JMX object name. yes MBeanName
JNDI Binding Binding path of this Topic in JNDI. yes JNDIBinding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 2.140. Metrics

Name Description
Remove All Messages Clears all Subscriptions
List All Subscriptions Lists all the Subscriptions.
List Durable Subscriptions Lists all the durable subscriptions.
List Non-durable Subscriptions Lists all the non-durable subscriptions.
List Messages by ID and Selector List the messages for a subscription by ID and with an optional selector.
List Non-durable Messages Lists the non-durable messages by subscription ID and an optional selector.
List Durable Messages Lists the durable messages by subscription ID and an optional selector.

Package Types
none

2.7.9. JBossMQ Service

Overview

Table 2.141. Overview

Description: The JBossMQ subsystem
Singleton: yes
Plugin: JBossAS

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.142. 

Name Description Required Internal Name
Object Name yes objectName
Name yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.143. Metrics

Name Type Description Internal Name
JMS Message Cache Hits measurement The number of cache hits to the JMS Message Cache jboss.mq:service=MessageCache:CacheHits
JMS Message Cache Hits per Minute measurement The number of cache hits to the JMS Message Cache jboss.mq:service=MessageCache:CacheHits
JMS Message Cache Misses measurement The number of cache misses to the JMS Message Cache jboss.mq:service=MessageCache:CacheMisses
JMS Message Cache Misses per Minute measurement The number of cache misses to the JMS Message Cache jboss.mq:service=MessageCache:CacheMisses
JMS Message Cache Current Memory Usage measurement The total memory currently in use by the JMS Message Cache jboss.mq:service=MessageCache:CurrentMemoryUsage
JMS Message Cache High Memory Mark measurement The peak amount of memory the JMS Message Cache has actively used since server start jboss.mq:service=MessageCache:HighMemoryMark
JMS Message Cache Max Memory Mark measurement The maximum amount of memory the JMS Message Cache is allowed to use jboss.mq:service=MessageCache:MaxMemoryMark
JMS Message Cache Size measurement The number of messages currently in the JMS Message Cache jboss.mq:service=MessageCache:TotalCacheSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.7.9.1. JMQ JMS Queue Service

Overview

Table 2.144. Overview

Description:
Singleton: no
Plugin: JBossAS

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.145. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this queue yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.146. Metrics

Name Type Description Internal Name
Messages in Queue measurement The number of undelivered messages in the queue. QueueDepth
Receivers Count measurement The number of ClientConsumers waiting for a message. ReceiversCount
Scheduled Message Count measurement The number of messages waiting to be scheduled ScheduledMessageCount
In Process Message Count measurement The number of messages received by clients but not acknowledged (from AS 4.0.5) InProcessMessageCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 2.147. 

Name Description Required Internal Name
Destination Manager The JMX object name of the destination manager configured for the server. yes DestinationManager
Security Manager The JMX object name of the security manager that is being used to validate client requests. no SecurityManager
Expiry Destination By default, JBossMQ silently removes expired JMS message from its destination. As of JBoss 4.0.4, expired messages can now be moved into a separate destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMQ destination. no ExpiryDestination
JNDI Name The location in JNDI to which the queue object will be bound. If this is not set it will be bound under the queue context using the name of the queue. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples. no JNDIName
In Memory Don't persist messages and avoid message softening when using the NullPersistenceManager no InMemory
Redelivery Limit The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely) no RedeliveryLimit
Redelivery Delay The length of time in milliseconds to wait before a message is redelivered after a nack no RedeliveryDelay
Message Counter History Day Limit Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count. no MessageCounterHistoryDayLimit
Maximum Depth The MaxDepth is an upper limit to the backlog of messages that can exist for a destination. If exceeded, attempts to add new messages will result in a org.jboss.mq.DestinationFullException. The MaxDepth can still be exceeded in a number of situations, e.g. when a message is placed back into the queue. Also transactions performing read committed processing, look at the current size of queue, ignoring any messages that may be added as a result of the current transaction or other transactions. This is because we don't want the transaction to fail during the commit phase when the message is physically added to the queue. no MaxDepth
Recovery Retries Specifies the number of times uncommitted transactions are to be resolved before failing. Default 0 - zero (from JBoss-4.0.3). no RecoveryRetries
Security Configurations This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. yes SecurityConf
Queue Name Name of the queue to be used in the JMX object name. yes MBeanName
JNDI Binding Binding path of this Queue in JNDI. yes JNDIBinding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 2.148. Metrics

Name Description
Remove All Messages Clears all Messages in the Queue
Reset Message Counter Clears the MessageCounter data for this Queue
Reset Message Counter History Clears the MessageCounter history data for this Queue
List Messages by Selector Lists the Messages in the Queue by Selector (if provided). Selector is not required.
List Scheduled Messages Lists the Scheduled Messages by Selector (if provided). Selector is not required.
List In Process Messages Lists the Messages in process by Selector (if provided). Selector is not required.

Package Types
none

2.7.9.2. JMQ JMS Topic Service

Overview

Table 2.149. Overview

Description:
Singleton: no
Plugin: JBossAS

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.150. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this topic yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.151. Metrics

Name Type Description Internal Name
All Message Counter measurement Returns the total message count for all subscriptions. AllMessageCount
Durable Message Count measurement Total number of messages for all durable subscriptions. DurableMessageCount
Non-durable Message Count measurement Total number of messages for all non-durable subscriptions. NonDurableMessageCount
All Subscription Count measurement Number of subscriptions waiting for a message. AllSubscriptionsCount
Durable Subscription Count measurement Number of durable subscriptions waiting for a message. DurableSubscriptionsCount
Non-durable Subscription Count measurement Number of non-durable subscriptions waiting for a message. NonDurableSubscriptionsCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 2.152. 

Name Description Required Internal Name
Destination Manager The JMX object name of the destination manager configured for the server. yes DestinationManager
Security Manager The JMX object name of the security manager that is being used to validate client requests. no SecurityManager
Expiry Destination By default, JBossMQ silently removes expired JMS message from its destination. As of JBoss 4.0.4, expired messages can now be moved into a separate destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMQ destination. no ExpiryDestination
JNDI Name The location in JNDI to which the topic will be bound. If this is not set it will be bound under the topic context using the mbean name of the topic. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples. no JNDIName
In Memory Don't persist messages and avoid message softening when using the NullPersistenceManager. no InMemory
Redelivery Limit The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely). no RedeliveryLimit
Redelivery Delay The length of time in milliseconds to wait before a message is redelivered after a nack. no RedeliveryDelay
Message Counter History Day Limit Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count. no MessageCounterHistoryDayLimit
Maximum Depth The MaxDepth is an upper limit to the backlog of messages that can exist for a destination. If exceeded, attempts to add new messages will result in a org.jboss.mq.DestinationFullException. The MaxDepth can still be exceeded in a number of situations, e.g. when a message is placed back into the queue. Also transactions performing read committed processing, look at the current size of queue, ignoring any messages that may be added as a result of the current transaction or other transactions. This is because we don't want the transaction to fail during the commit phase when the message is physically added to the queue. no MaxDepth
Recovery Retries Specifies the number of times uncommitted transactions are to be resolved before failing. Default 0 - zero (from JBoss-4.0.3). no RecoveryRetries
Security Configurations This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. yes SecurityConf
Topic Name Name of the queue to be used as the JMX object name. yes MBeanName
JNDI Binding Binding path of this Topic in JNDI. yes JNDIBinding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 2.153. Metrics

Name Description
Remove All Messages Clears all Subscriptions
List All Subscriptions Lists all the Subscriptions.
List Durable Subscriptions Lists all the durable subscriptions.
List Non-durable Subscriptions Lists all the non-durable subscriptions.
Reset Message Counter Clears the message counter data for all topic subscriptions.
Reset Message Counter History Clears the message counter history data for this topic.
List Messages by ID and Selector List the messages for a subscription by ID and with an optional selector.
Get Non-durable Message Count Gets the message count for non-durable messages by client ID and subscription ID.
List Non-durable Messages Lists the non-durable messages by client ID, subscription ID, and an optional selector.
Get Durable Message Count Gets the message count for durable messages by client ID and subscription ID.
List Durable Messages Lists the durable messages by client ID, subscription ID, and an optional selector.
Get Non-durable Scheduled Message Count Gets the message count for non-durable scheduled messages by client ID and subscription ID.
List Non-durable Scheduled Messages Lists the non-durable scheduled messages by client ID, subscription ID, and an optional selector.
Get Durable Scheduled Message Count Gets the message count for durable scheduled messages by client ID and subscription ID.
List Durable Scheduled Messages Lists the durable scheduled messages by client ID, subscription ID, and an optional selector.
Get Non-durable In-process Message Count Gets the message count for non-durable in-process messages by client Id and subscription Id
List Non-durable In-process Messages Lists the non-durable in-process messages by client ID, subscription ID, and an optional selector.
Get Durable In-process Message Count Gets the message count for durable in-process messages by client ID and subscription Id
List Durable In-process Messages Lists the durable in-process messages by client ID, subscription ID, and an optional selector.

Package Types
none

2.7.10. Message Driven EJB Service

Overview

Table 2.154. Overview

Description: An EJB 1.x or 2.x Message Driven Bean
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.155. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this ejb yes name
J 2ee Application yes j2eeApplication
Ejb Jar yes ejbJar

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.156. Metrics

Name Type Description Internal Name
Create Calls measurement The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been created since server start {stats.createCount.count}
Create Calls per Minute measurement The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been created since server start {stats.createCount.count}
Remove Calls measurement The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been removed since server start {stats.removeCount.count}
Remove Calls per Minute measurement The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been removed since server start {stats.removeCount.count}
Method-Ready Beans measurement The number of pooled instances of this EJB 1.x or 2.x Message Driven Bean in the method-ready state {stats.messageCount.count}
Method-Ready Beans per Minute measurement The number of pooled instances of this EJB 1.x or 2.x Message Driven Bean in the method-ready state {stats.messageCount.count}

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.7.11. Script Service

Overview

Table 2.157. Overview

Description: provides the ability to execute a script that performs some task related to its parent JBossAS server
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.158. 

Name Description Required Internal Name
Path the absolute path to the script file yes path
Environment Variables the environment variables that will be passed to the script; each variable must be on a new line and have the syntax name=value; the variable's value can contain properties with the syntax %propertyName%; the script plugin will interpolate these with the current values of the corresponding properties from the script's parent JBossAS server's connection properties no environmentVariables

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

Table 2.159. Metrics

Name Description
Execute Script execute the script; NOTE: environment variables to be passed to the script can be configured via this Script service's connection properties (under its Inventory>Connection tab)

Package Types

none

2.7.12. Stateful Session EJB Service

Overview

Table 2.160. Overview

Description: An EJB 1.x or 2.x Stateful Session Bean
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.161. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this EJB yes name
J 2ee Application yes j2eeApplication
Ejb Jar yes ejbJar

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.162. Metrics

Name Type Description Internal Name
Create Calls measurement The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been created since server start {stats.createCount.count}
Create Calls per Minute measurement The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been created since server start {stats.createCount.count}
Remove Calls measurement The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been removed since server start {stats.removeCount.count}
Remove Calls per Minute measurement The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been removed since server start {stats.removeCount.count}
Method-Ready Beans measurement The number of pooled instances of this EJB 1.x or 2.x Stateful Session Bean in the method-ready state {stats.methodReadyCount.current}
Passive Beans measurement The number of pooled instances of this EJB 1.x or 2.x Stateful Session Bean in the passivated state {stats.passiveCount.current}
Method Invocation Time calltime the minimum, maximum, and average invocation times for each of the methods exposed by this EJB MethodInvocationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.7.13. Stateless Session EJB Service

Overview

Table 2.163. Overview

Description: An EJB 1.x or 2.x Stateless Session Bean
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.164. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Name The name of this ejb yes name
J 2ee Application yes j2eeApplication
Ejb Jar yes ejbJar

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.165. Metrics

Name Type Description Internal Name
Create Calls measurement The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been created since server start {stats.createCount.count}
Create Calls per Minute measurement The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been created since server start {stats.createCount.count}
Remove Calls measurement The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been removed since server start {stats.removeCount.count}
Remove Calls per Minute measurement The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been removed since server start {stats.removeCount.count}
Method-Ready Beans measurement The number of pooled instances of this EJB 1.x or 2.x Stateless Session Bean in the method-ready state {stats.methodReadyCount.current}
Pool Size measurement The total number of currently pooled instances of this EJB 1.x or 2.x Stateless Session Bean {{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}CurrentSize}
Max Pool Size measurement The maximum number of instances that are allowed to be pooled {{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}MaxSize}
Method Invocation Time calltime the minimum, maximum, and average invocation times for each of the methods exposed by this EJB MethodInvocationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.7.14. Web Application (WAR) Service

Overview

Table 2.166. Overview

Description: Web Application
Singleton: no
Plugin: JBossAS

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.167. 

Name Description Required Internal Name
Name The name of this WAR yes name
Filename yes filename
Object Name yes objectName
Context Root this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR no contextRoot
Virtual Host The (virtual) host that this application is running on. If no virtual host is set, this defaults to 'localhost' no vHost
Jboss Web Name the objectName for the jboss.web WebModule that will be used to fire operations no jbossWebName
Response Time Log File the full path to the log file containing response-time stats for this webapp. The location is determined by the RtFilter and is usually something like ...server/.../log/rt/appname_rt.log no responseTimeLogFile
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Name Template yes nameTemplate
Extension yes extension
Description Template yes descriptionTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.168. Metrics

Name Type Description Internal Name
Path trait the absolute path of this WAR file or directory Application.path
Exploded? trait whether this WAR is deployed exploded (i.e. as a directory) Application.exploded
Context Root trait this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR ContextRoot
HTTP Response Time calltime the minimum, maximum, and average response times for HTTP requests serviced by this webapp ResponseTime
Min. Servlet Resp. Time measurement Minimum response time of a servlet Servlet.MinResponseTime
Avg. Servlet Resp. Time measurement Average response time of a servlet Servlet.AvgResponseTime
Max. Servlet Resp. Time measurement Maximum response time of a servlet Servlet.MaxResponseTime
Total processing time measurement Total processing time of the webapp Servlet.TotalTime
Total processing time per Minute measurement Total processing time of the webapp Servlet.TotalTime
Requests served measurement Number of requests served by servlets Servlet.NumRequests
Requests served per Minute measurement Number of requests served by servlets Servlet.NumRequests
Errors while processing measurement Number of errors while processing Servlet.NumErrors
Errors while processing per Minute measurement Number of errors while processing Servlet.NumErrors
Currently Active Sessions measurement Number active sessions for the webapp right now Session.activeSessions
Maximum number of Active Sessions measurement Maximum number of active sessions for the webapp Session.maxActive
Sessions created measurement Number of sessions created for the webapp Session.sessionCounter
Sessions created per Minute measurement Number of sessions created for the webapp Session.sessionCounter
Expired Sessions measurement Number of expired sessions for the webapp Session.expiredSessions
Expired Sessions per Minute measurement Number of expired sessions for the webapp Session.expiredSessions
Rejected Sessions measurement Number of sessions rejected for the webapp Session.rejectedSessions
Rejected Sessions per Minute measurement Number of sessions rejected for the webapp Session.rejectedSessions
Session Average alive time measurement Average alive time of a Sessions Session.sessionAverageAliveTime
Max Session alive time measurement Maximum alive time of a Sessions Session.sessionMaxAliveTime
Vhost trait Virtual hosts this app runs on Vhost.name

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.169. Metrics

Name Description
Start starts this webapp; NOTE: this operation is *not* supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006)
Stop stops this webapp; NOTE: this operation is *not* supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006)
Reload reloads this webapp; NOTE: if the webapp is not in the started state, this operation will fail
Revert Tries to revert this web application from a saved backup in the same directory and with a name ending in .bak

Package Types

Table 2.170. Package Types

Name Category Description
WAR File Deployable

2.8. JBoss AS 5.x

Overview

Table 2.171. Overview

Description: JBoss Application Server (AS), Enterprise Application Platform (EAP), Enterprise SOA Platform (SOA-P), or Enterprise Web Platform (EWP) 5.x instance
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Autodiscovery Process Scans

Table 2.172. Metrics

Name Query
jbossas process|basename|match=^java.*,arg|org.jboss.Main|match=.*

Connection Properties

Table 2.173. 

Name Description Required Internal Name
Naming Provider URL The JBoss Naming Provider (JNP) URL with which to connect to the JBoss AS or EAP instance (e.g. jnp://127.0.0.1:1099). yes namingURL
Principal The name of the principal (i.e. user) to authenticate. no principal
Credentials The credentials (i.e. password) that should be used to authenticate the principal. no credentials
JBoss Home Directory The absolute path to the directory where JBoss AS or EAP is installed (e.g. /opt/jboss-5.1.0.GA). yes homeDir
Server Home Dir The path to the configuration directory under which this instance operates (e.g. /opt/jboss-5.2.0.GA/server/default); if the path is not absolute, then it will be resolved relative to {homeDir}. yes serverHomeDir
Server Name The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {serverHomeDir}. no serverName
Script Prefix A prefix applied to script execution commands. Typically a sudo for applicable platforms. The prefix is applied verbatim. As such, a sudo user must be configured appropriately. Ignored if not set. no scriptPrefix
Start Script The path to the script used by the 'Start' operation to start this JBossAS server (e.g. /opt/jboss-5.2.0.GA/bin/run.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/run.sh' on UNIX or 'bin\run.bat' on Windows. no startScript
Shutdown Script The path to the script used by the Shut Down operation to shut down this JBossAS server (e.g. /opt/jboss-5.2.0.GA/bin/shutdown.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/shutdown.sh' on UNIX or 'bin\shutdown.bat' on Windows. no shutdownScript
Shutdown Method The method used to execute the Shut Down operation; defaults to 'JMX MBean'. no shutdownMethod
Bind Address The host or IP address that all application server services should listen on (e.g. 10.11.14.233 or foo.example.com); specify 0.0.0.0 to tell the application server to bind to all available network interfaces; defaults to '127.0.0.1'. no bindAddress
Java Home The absolute path to a JRE or JDK installation directory containing the JVM that should be used to start and shutdown this JBoss AS server; this property must be set in order for the Start operation to work, or for the Shutdown operation to work when the shutdown method is set to 'shutdown script'. no javaHome
Shutdown MBean Name Name of the MBean to use when shutting down this server through JMX. yes shutdownMBeanName
Shutdown MBean Operation Name of the operation to invoke when shutting down this server through JMX. Note that only operations with no parameter or with one int parameter are supported. If the operation requires an int parameter, '0' will be supplied. yes shutdownMBeanOperation
Availability Check Period The amount of time, in seconds, that must elapse between availability checks to see if the server is up. If set, the availability checks will be performed asynchronously thus allowing slow-responding servers to avoid being falsely reported as down. no availabilityCheckPeriod
JBoss AS JVM Name The name of the JBoss AS JVM resource. no childJmxServerName
Log Event Sources yes logEventSources

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.174. Metrics

Name Type Description Internal Name
Cluster Partition Name trait the name of the cluster partition this server belongs to MCBean|ServerConfig|*|partitionName
Server Name trait the name of the active profile (i.e. configuration set) this server is using MCBean|ServerConfig|*|serverName
Server Home Dir trait the full path of the configuration set directory this server is using (e.g. /opt/jboss-5.1.0.CR1/server/default) MCBean|ServerConfig|*|serverHomeDir
Version Name trait the code name for the this app server instance's major version (AS 5.0 = Morpheus, AS 5.1 = The Oracle, AS 6.0 = Neo) MCBean|MCServer|*|versionName
Build Date trait the date this app server was built MCBean|MCServer|*|buildDate
Start Date trait the date and time this app server instance was started MCBean|MCServer|*|startDate
Active Thread Count measurement The current number of active threads for this app server instance MCBean|ServerInfo|*|activeThreadCount
Active Thread Group Count measurement The current number of active thread groups for this app server instance MCBean|ServerInfo|*|activeThreadGroupCount
JVM Free Memory measurement An approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytes MCBean|ServerInfo|*|freeMemory
JVM Max Memory measurement The maximum amount of memory that the app server JVM will attempt to use, measured in bytes; if there is no inherent limit then the value Long.MAX_VALUE will be returned MCBean|ServerInfo|*|maxMemory
JVM Total Memory measurement The total amount of memory currently available in the app server JVM for current and future objects, measured in bytes MCBean|ServerInfo|*|totalMemory
Total Transactions measurement Total number of transactions since last restart MCBean|JTA|*|transactionCount
Total Transactions per Minute measurement Total number of transactions since last restart MCBean|JTA|*|transactionCount
Transactions Committed measurement Number of transactions committed since last restart MCBean|JTA|*|commitCount
Transactions Committed per Minute measurement Number of transactions committed since last restart MCBean|JTA|*|commitCount
Transactions Rolled Back measurement Number of transactions rolled back since last restart MCBean|JTA|*|rollbackCount
Transactions Rolled Back per Minute measurement Number of transactions rolled back since last restart MCBean|JTA|*|rollbackCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.175. Metrics

Name Description
Start Start this application server. The script used is specified in the Operations group of connection properties. This operation will fail if the server is already started.
Shut Down Shut down this application server via script or JMX, depending on the settings in the Operations and Advanced groups of connection properties. This operation will fail if the server is already shut down.
Restart Shut down (if started) and then start this application server.

Package Types

Table 2.176. Package Types

Name Category Description
Cumulative Patch Deployable Automatically installable application server patches
JAR Library Deployable Library Jar files deployed in JBoss AS

2.8.1. EJB2 JAR Service

Overview

Table 2.177. Overview

Description: a standalone EJB 2.x application
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.178. 

Name Description Required Internal Name
Deployment Name the name of this EJB JAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.179. Metrics

Name Type Description Internal Name
Path trait the absolute path of this EJB JAR file or directory custom.path
Exploded? trait whether this EJB JAR is deployed exploded (i.e. as a directory) custom.exploded

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.180. Metrics

Name Description
Start starts this EJB JAR
Stop stops this EJB JAR
Restart stops and then restarts this EJB JAR

Package Types

Table 2.181. Package Types

Name Category Description
EJB JAR File Deployable

2.8.1.1. EJB2 Entity Bean Service

Overview

Table 2.182. Overview

Description: An EJB2 Entity Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.183. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.184. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Cache Size measurement Cache Size CacheSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none

2.8.1.2. EJB2 Message-Driven Bean Service

Overview

Table 2.185. Overview

Description: An EJB2 Message Driven Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.186. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.187. Metrics

Name Type Description Internal Name
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Message Count measurement The number of messages sent/received MessageCount
Message Count per Minute measurement The number of messages sent/received MessageCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none

2.8.1.3. EJB2 Stateful Session Bean Service

Overview

Table 2.188. Overview

Description: An EJB2 Stateful Session Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.189. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.190. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime
Passive Beans measurement The count of beans in the passivated state PassivatedCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations

Table 2.191. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.1.4. EJB2 Stateless Session Bean Service

Overview

Table 2.192. Overview

Description: An EJB2 Stateless Session Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.193. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.194. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations

Table 2.195. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.2. EJB2 Entity Bean (Embedded) Service

Overview

Table 2.196. Overview

Description: An EJB2 Entity Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.197. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.198. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Cache Size measurement Cache Size CacheSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.8.3. EJB2 Message-Driven Bean (Embedded) Service

Overview

Table 2.199. Overview

Description: An EJB2 Message Driven Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.200. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.201. Metrics

Name Type Description Internal Name
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Message Count measurement The number of messages sent/received MessageCount
Message Count per Minute measurement The number of messages sent/received MessageCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.8.4. EJB2 Stateful Session Bean (Embedded) Service

Overview

Table 2.202. Overview

Description: An EJB2 Stateful Session Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.203. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.204. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime
Passive Beans measurement The count of beans in the passivated state PassivatedCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.205. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.5. EJB2 Stateless Session Bean (Embedded) Service

Overview

Table 2.206. Overview

Description: An EJB2 Stateless Session Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.207. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.208. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.209. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.6. EJB3 JAR Service

Overview

Table 2.210. Overview

Description: a standalone EJB 3.x application
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.211. 

Name Description Required Internal Name
Deployment Name the name of this EJB JAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.212. Metrics

Name Type Description Internal Name
Path trait the absolute path of this EJB JAR file or directory custom.path
Exploded? trait whether this EJB JAR is deployed exploded (i.e. as a directory) custom.exploded

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.213. Metrics

Name Description
Start starts this EJB JAR
Stop stops this EJB JAR
Restart stops and then restarts this EJB JAR

Package Types

Table 2.214. Package Types

Name Category Description
EJB JAR File Deployable

2.8.6.1. EJB3 Message-Driven Bean Service

Overview

Table 2.215. Overview

Description: An EJB3 Message-Driven Bean (MDB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.216. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.217. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Minimum Pool Size measurement Minimum Pool Size minPoolSize
Maximum Pool Size measurement Maximum Pool Size maxPoolSize
Maximum number of Messages measurement Maximum number of Messages maxMessages

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations

Table 2.218. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.6.2. EJB3 Stateful Session Bean Service

Overview

Table 2.219. Overview

Description: An EJB3 Stateful Session Bean (SFSB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.220. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.221. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Available Count measurement The number of pooled instances of this EJB3 Session Bean in the method-ready state availableCount
Create Count measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Create Count per Minute measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Current Count measurement The total number of currently pooled instances of this EJB3 Session Bean currentSize
Max Size measurement The maximum number of instances that are allowed to be pooled maxSize
Remove Count measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Remove Count per Minute measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime
Cache Size measurement Cache Size cacheSize
Passivated Count measurement Passivated Count passivatedCount
Total Size measurement Total Size totalSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations

Table 2.222. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.6.3. EJB3 Stateless Session Bean Service

Overview

Table 2.223. Overview

Description: An EJB3 Stateless Session Bean (SLSB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.224. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.225. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Available Count measurement The number of pooled instances of this EJB3 Session Bean in the method-ready state availableCount
Create Count measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Create Count per Minute measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Current Count measurement The total number of currently pooled instances of this EJB3 Session Bean currentSize
Max Size measurement The maximum number of instances that are allowed to be pooled maxSize
Remove Count measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Remove Count per Minute measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations

Table 2.226. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.7. EJB3 Message-Driven Bean (Embedded) Service

Overview

Table 2.227. Overview

Description: An EJB3 Message-Driven Bean (MDB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.228. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.229. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Minimum Pool Size measurement Minimum Pool Size minPoolSize
Maximum Pool Size measurement Maximum Pool Size maxPoolSize
Maximum number of Messages measurement Maximum number of Messages maxMessages

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.230. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.8. EJB3 Stateful Session Bean (Embedded) Service

Overview

Table 2.231. Overview

Description: An EJB3 Stateful Session Bean (SFSB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.232. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.233. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Available Count measurement The number of pooled instances of this EJB3 Session Bean in the method-ready state availableCount
Create Count measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Create Count per Minute measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Current Count measurement The total number of currently pooled instances of this EJB3 Session Bean currentSize
Max Size measurement The maximum number of instances that are allowed to be pooled maxSize
Remove Count measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Remove Count per Minute measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime
Cache Size measurement Cache Size cacheSize
Passivated Count measurement Passivated Count passivatedCount
Total Size measurement Total Size totalSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.234. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.9. EJB3 Stateless Session Bean (Embedded) Service

Overview

Table 2.235. Overview

Description: An EJB3 Stateless Session Bean (SLSB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.236. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.237. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Available Count measurement The number of pooled instances of this EJB3 Session Bean in the method-ready state availableCount
Create Count measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Create Count per Minute measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Current Count measurement The total number of currently pooled instances of this EJB3 Session Bean currentSize
Max Size measurement The maximum number of instances that are allowed to be pooled maxSize
Remove Count measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Remove Count per Minute measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.238. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.10. Embedded EJB2 JAR Service

Overview

Table 2.239. Overview

Description: an embedded EJB 2.x application
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.240. 

Name Description Required Internal Name
Deployment Name the name of this EJB JAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.241. Metrics

Name Type Description Internal Name
Parent trait the name of this EJB JAR's parent deployment custom.parent

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.8.11. Embedded EJB3 JAR Service

Overview

Table 2.242. Overview

Description: an embedded EJB 3.x application
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.243. 

Name Description Required Internal Name
Deployment Name the name of this EJB JAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.244. Metrics

Name Type Description Internal Name
Parent trait the name of this EJB JAR's parent deployment custom.parent

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.8.12. Embedded Resource Adapter Archive (RAR) Service

Overview

Table 2.245. Overview

Description: an embedded JCA resource adapter archive (RAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.246. 

Name Description Required Internal Name
Deployment Name the name of this RAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.247. Metrics

Name Type Description Internal Name
Parent trait the name of this RAR's parent deployment custom.parent

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.8.13. Embedded Web Application (WAR) Service

Overview

Table 2.248. Overview

Description: an embedded web application (WAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.249. 

Name Description Required Internal Name
Deployment Name the name of this WAR yes deploymentName
Context Path this WAR's context path (e.g. /admin-console yes contextPath
Response Time Log File the full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName
Embedded yes embedded

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.250. Metrics

Name Type Description Internal Name
Parent trait the name of this WAR's parent deployment custom.parent
Context Root trait this context root of this WAR (e.g. jmx-console) - used as a unique path prefix for URLs corresponding to this WAR contextRoot
Virtual Hosts trait the virtual host(s) to which this WAR is deployed virtualHosts

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.8.13.1. Embedded Web Application Context Service

Overview

Table 2.251. Overview

Description: a web application context
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.252. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Response Time Log File the full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Virtual Host this WAR's virtual host (e.g. localhost) yes virtualHost

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.253. Metrics

Name Type Description Internal Name
Virtual Host trait the virtual host with which this context is associated virtualHost
Response Time calltime the minimum, maximum, and average response times for requests serviced by this webapp responseTime
Currently Active Sessions measurement the number of sessions that are currently active for this WAR activeSessions
Maximum Active Sessions measurement the maximum number of sessions that have been active for this WAR maxActive
Created Sessions measurement the number of sessions created for this WAR sessionCounter
Created Sessions per Minute measurement the number of sessions created for this WAR sessionCounter
Expired Sessions measurement the number of expired sessions for this WAR expiredSessions
Expired Sessions per Minute measurement the number of expired sessions for this WAR expiredSessions
Rejected Sessions measurement the number of sessions rejected for this WAR rejectedSessions
Rejected Sessions per Minute measurement the number of sessions rejected for this WAR rejectedSessions
Average Session Alive Time measurement the average alive time of sessions for this WAR sessionAverageAliveTime
Max Session Alive Time measurement the maximum alive time of sessions for this WAR sessionMaxAliveTime
Minimum Response Time measurement the minimum response time for requests serviced by this WAR Servlet.minimumResponseTime
Average Response Time measurement the average response time for requests serviced by this WAR Servlet.averageResponseTime
Maximum Response Time measurement the maximum response time for requests serviced by this WAR Servlet.maximumResponseTime
Total Response Time measurement the total response time for requests serviced by this WAR Servlet.totalResponseTime
Total Response Time per Minute measurement the total response time for requests serviced by this WAR Servlet.totalResponseTime
Number of Requests Serviced measurement the number of requests serviced by this WAR Servlet.requestCount
Number of Requests Serviced per Minute measurement the number of requests serviced by this WAR Servlet.requestCount
Number of Error Responses measurement the number of error responses sent by this WAR Servlet.errorCount
Number of Error Responses per Minute measurement the number of error responses sent by this WAR Servlet.errorCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none

2.8.14. Enterprise Application (EAR) Service

Overview

Table 2.254. Overview

Description: JEE enterprise application (EAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.255. 

Name Description Required Internal Name
Deployment Name The name of this EAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.256. Metrics

Name Type Description Internal Name
Path trait the absolute path of this EAR file or directory custom.path
Exploded? trait whether this EAR is deployed exploded (i.e. as a directory) custom.exploded

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.257. Metrics

Name Description
Start starts this EAR
Stop stops this EAR
Restart stops and then restarts this EAR

Package Types

Table 2.258. Package Types

Name Category Description
EAR File Deployable

2.8.15. JBoss Messaging Service

Overview

Table 2.259. Overview

Description: the JBoss Messaging JMS provider
Singleton: yes
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.260. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

2.8.15.1. Queue Service

Overview

Table 2.261. Overview

Description: a JMS queue
Singleton: no
Plugin: JBossAS5

Note

The message counter metrics will not be collected by default. In order for these metrics to be collected for all Topics and Queues for a given application server instance, go to the instance's JMX Console, and invoke the enableMessageCounters operation on the jboss.messaging:service=ServerPeer MBean. To ensure the message counters are still enabled when the application server is restarted, edit that instance's deploy/messaging/messaging-service.xml file and set the EnableMessageCounters attribute to "true".
Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.262. 

Name Description Required Internal Name
Jms Type yes jms-type
Custom Properties Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. no customProperties
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Template Name yes templateName
Component Name Property The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. yes componentNameProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.263. Metrics

Name Type Description Internal Name
Run State trait Run State runState
Created Programmatically trait Was this queue created programmatically? If Yes, the queue will not survive a restart of the application server. If No, the queue was created via a deployment XML file. createdProgrammatically
Message Counter History Day Limit trait This queue's message counter history day limit - <0: unlimited, =0: history disabled, >0: maximum day count messageCounterHistoryDayLimit
Consumer Count measurement The number of consumers on the queue consumerCount
Delivering Count measurement The number of messages currently being delivered deliveringCount
Message Count measurement The number of messages in the queue messageCount
Scheduled Message Count measurement The number of scheduled messages in the queue scheduledMessageCount
Count measurement The total message count since startup or last counter reset messageStatistics.count
Count Delta measurement The message count delta since last method call messageStatistics.countDelta
Depth measurement The current message count of pending messages within the queue waiting for dispatch messageStatistics.depth
Depth Delta measurement The message count delta of pending messages since last method call messageStatistics.depthDelta
Time Last Update measurement The timestamp of the last message add messageStatistics.timeLastUpdate

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 2.264. 

Name Description Required Internal Name
Name The name of this queue (e.g. 'MyQueue'). yes name
JNDI Name This queue's JNDI name (e.g. '/queue/MyQueue'). yes JNDIName
Clustered Is this queue clustered? For an existing queue, this property is read-only. If not specified when creating a new queue, the default value is false. no clustered
Down Cache Size When paging messages to storage from a subscription, they first go into a "Down Cache" before being written to storage. This enables the write to occur as a single operation, thus aiding performance. This setting determines the maximum number of messages that the Down Cache will hold before they are flushed to storage. Updates to this property will not go into effect until the queue has been restarted. The default value is 2000. no downCacheSize
Full Size The maximum number of messages for the queue held in memory at any one time. The actual queue can hold many more messages than this, but these are paged to and from storage as necessary, as messages are added or consumed. Updates to this property will not go into effect until the queue has been restarted. The default value is 200000. no fullSize
Max Delivery Attempts The number of delivery attempts before a message to a subscriber of this queue is moved to the DLQ. The default value is 10. A value of -1 indicates the default value should be used. no maxDeliveryAttempts
Max Size The maximum number of messages this queue can hold before they are dropped. A value of -1 means there is no maximum. The default value is -1. no maxSize
Page Size When loading messages from a subscription, this is the maximum number of messages to pre-load in one operation. Must be less than Full Size and greater than or equal to Down Cache Size. Updates to this property will not go into effect until the queue has been restarted. The default value is 2000. no pageSize
Redelivery Delay The delay in milliseconds before a rolled back or recovered message is redelivered. Set to 0 to disable redelivery. The default value is 0. A value of -1 indicates the default value should be used. no redeliveryDelay
DLQ The JMX ObjectName of the dead letter queue (DLQ) for this queue (e.g. "jboss.messaging.destination:service=Queue,name=PrivateDLQ") - overrides the default DLQ on the server peer. no DLQ
Expiry Queue The JMX ObjectName of the expiry queue for this queue (e.g. "jboss.messaging.destination:service=Queue,name=PrivateExpiryQueue") - overrides the default expiry queue on the server peer. no expiryQueue
Server Peer The JMX ObjectName of the server peer this queue was deployed on (e.g. "jboss.messaging:service=ServerPeer"). Updates to this property will not go into effect until the queue has been restarted. no serverPeer
Security Configurations This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. yes securityConfig

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 2.265. Metrics

Name Description
Remove All Messages Remove all messages from the destination.
Start Start the destination.
Stop Stop the destination.
List All Messages List all messages for the specified selector
List Durable Messages List all durable messages for the specified selector
List Non Durable Messages List all non durable messages for the specified selector
List Message Counter As HTML Get the message counter as HTML
List Message Counter History As HTML Get the message counter history as HTML
Reset Message Counter Reset the message counter
Reset Message Counter History Reset the message counter history

Package Types
none

2.8.15.2. Topic Service

Overview

Table 2.266. Overview

Description: a JMS topic
Singleton: no
Plugin: JBossAS5

Note

The message counter metrics will not be collected by default. In order for these metrics to be collected for all Topics and Queues for a given application server instance, go to the instance's JMX Console, and invoke the enableMessageCounters operation on the jboss.messaging:service=ServerPeer MBean. To ensure the message counters are still enabled when the application server is restarted, edit that instance's deploy/messaging/messaging-service.xml file and set the EnableMessageCounters attribute to "true".
Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.267. 

Name Description Required Internal Name
Jms Type yes jms-type
Custom Properties Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. no customProperties
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Template Name yes templateName
Component Name Property The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. yes componentNameProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.268. Metrics

Name Type Description Internal Name
Run State trait Run State runState
Created Programmatically trait Was this topic created programmatically? If Yes, the topic will not survive a restart of the application server. If No, the topic was created via a deployment XML file. createdProgrammatically
Message Counter History Day Limit trait This topic's message counter history day limit - <0: unlimited, =0: history disabled, >0: maximum day count messageCounterHistoryDayLimit
All Message Count measurement The count of all messages in all subscriptions to this topic allMessageCount
All Subscriptions Count measurement The count of all subscriptions to this topic allSubscriptionsCount
Durable Message Count measurement The count of all messages for all durable subscriptions to this topic durableMessageCount
Durable Subscriptions Count measurement The count of all durable subscriptions to this topic durableSubscriptionsCount
Non Durable Message Count measurement The count of all messages in all non durable subscriptions to this topic nonDurableMessageCount
Non Durable Subscriptions Count measurement The count of all non durable subscriptions to this topic nonDurableSubscriptionsCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 2.269. 

Name Description Required Internal Name
Name The name of this topic (e.g. 'MyTopic'). yes name
JNDI Name This topic's JNDI name (e.g. '/topic/MyTopic') yes JNDIName
Clustered Is this topic clustered? For an existing topic, this property is read-only. If not specified when creating a new topic, the default value is false. no clustered
Down Cache Size When paging messages to storage from a subscription, they first go into a "Down Cache" before being written to storage. This enables the write to occur as a single operation, thus aiding performance. This setting determines the maximum number of messages that the Down Cache will hold before they are flushed to storage. Updates to this property will not go into effect until the topic has been restarted. The default value is 2000. no downCacheSize
Full Size The maximum number of messages held by the topic subscriptions in memory at any one time. The actual subscription can hold many more messages than this, but these are paged to and from storage as necessary, as messages are added or consumed. Updates to this property will not go into effect until the topic has been restarted. The default value is 200000. no fullSize
Max Delivery Attempts The number of delivery attempts before a message to a subscriber of this topic is moved to the DLQ. The default value is 10. A value of -1 indicates the default value should be used. no maxDeliveryAttempts
Max Size The maximum number of messages this topic can hold before they are dropped. A value of -1 means there is no maximum. The default value is -1. no maxSize
Page Size When loading messages from a subscription, this is the maximum number of messages to pre-load in one operation. Must be less than Full Size and greater than or equal to Down Cache Size. Updates to this property will not go into effect until the topic has been restarted. The default value is 2000. no pageSize
Redelivery Delay The delay in milliseconds before a rolled back or recovered message is redelivered. Set to 0 to disable redelivery. The default value is 0. A value of -1 indicates the default value should be used. no redeliveryDelay
DLQ The JMX ObjectName of the dead letter queue (DLQ) for this topic (e.g. "jboss.messaging.destination:service=Queue,name=PrivateDLQ") - overrides the default DLQ on the server peer. no DLQ
Expiry Queue The JMX ObjectName of the expiry queue for this topic (e.g. "jboss.messaging.destination:service=Queue,name=PrivateExpiryQueue") - overrides the default expiry queue on the server peer. no expiryQueue
Server Peer The JMX ObjectName of the server peer this topic was deployed on (e.g. "jboss.messaging:service=ServerPeer"). Updates to this property will not go into effect until the topic has been restarted. no serverPeer
Security Configurations This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. yes securityConfig

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 2.270. Metrics

Name Description
Remove All Messages Remove all messages from the destination.
Start Start the destination.
Stop Stop the destination.
List All Messages List all messages for the specified subscription with the specified selector
List Durable Messages List all durable messages for the specified subscription with the specified selector
List Non Durable Messages List all non durable messages for the specified subscription with the specified selector
List All Subscriptions Return all subscriptions for the topic
List All Subscriptions As HTML Return all subscriptions for the topic as HTML
List Durable Subscriptions Return all durable subscriptions for the topic
List Durable Subscriptions As HTML Return all durable subscriptions for the topic as HTML
List Non-Durable Subscriptions Return all non-durable subscriptions for the topic
List Non-Durable Subscriptions As HTML Return all non-durable subscriptions for the topic as HTML

Package Types
none

2.8.16. JBoss Web Service

Overview

Table 2.271. Overview

Description: JBoss Web Servlet Container
Singleton: yes
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

none

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

2.8.16.1. Connector Service

Overview

Table 2.272. Overview

Description: a JBoss Web Connector
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.273. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Protocol this connector's protocol (e.g. jk, ajp, http) yes protocol
Address the IP address this connector listens on yes address
Port the port this connector listens on yes port

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.274. Metrics

Name Type Description Internal Name
Maximum Request Time measurement the maximum time it took to process a request since the last restart maxTime
Request Count measurement the total number of requests processed since the last restart requestCount
Request Count per Minute measurement the total number of requests processed since the last restart requestCount
Error Count measurement the number of errors while processing requests since the last restart errorCount
Error Count per Minute measurement the number of errors while processing requests since the last restart errorCount
Current Active Threads measurement the number of threads for this connector that are currently active ThreadPool|currentThreadsBusy
Current Thread Count measurement the number of threads for this connector that currently exist ThreadPool|currentThreadCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none

2.8.16.2. Virtual Host Service

Overview

Table 2.275. Overview

Description: a JBoss Web virtual host
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.276. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Name the virtual host's name (e.g. localhost) yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.277. Metrics

Name Type Description Internal Name
Aliases trait the aliases for this virtual host, if any aliases

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none

2.8.17. Local Tx Datasource Service

Overview

Table 2.278. Overview

Description: Local Transaction Datasources deployed in the instance of JBoss AS
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.279. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Template Name yes templateName
Component Name Property The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. yes componentNameProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.280. Metrics

Name Type Description Internal Name
Run State trait Run State runState
Pool JNDI Name trait the JNDI name of the connection pool for this datasource poolJndiName
Available Connection Count measurement the maximum number of connections that are available availableConnectionCount
Connection Count measurement the number of connections that are currently in the pool connectionCount
Connection Created Count measurement the number of connections that have been created since the datasource was last started connectionCreatedCount
Connection Destroyed Count measurement the number of connections that have been destroyed since the datasource was last started connectionDestroyedCount
In Use Connection Count measurement the number of connections that are currently in use inUseConnectionCount
Local Transaction trait Local Transaction local-transaction
Max Connections In Use Count measurement the most connections that have been simultaneously in use since this datasource was started maxConnectionsInUseCount
Max Size measurement Max Size maxSize
Min Size measurement Min Size minSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.281. 

Name Description Required Internal Name
JNDI Name The global JNDI Name under which to bind the datasource yes jndi-name
Username The default username when creating a new connection. no user-name
Password The default password when creating a new connection. no password
Minimum Pool Size The minimum number of connections the pool should hold. The default is 0. no min-pool-size
Maximum Pool Size The maximum number of connections the pool should hold. The default is 10. no max-pool-size
JDBC Driver Class The fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver"). yes driver-class
Connection URL The JDBC URL for the database (e.g. "jdbc:oracle:thin:@host.example.com:1521:db"). To define a high availablity (HA) datasource, specify a list of URLs separated by URL delimiters (e.g. "jdbc:oracle:thin:@host1.example.com:1521:db1|jdbc:oracle:thin:@host2.example.com:1521:db2"). yes connection-url
Connection Properties Arbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method. no connection-properties
Allocation Retry The number of times that allocating a connection should be tried before throwing an exception. The default is 0. no allocation-retry
Allocation Retry Wait Millis The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). no allocation-retry-wait-millis
Background Validation Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. no background-validation
Background Validation Millis The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. no background-validation-millis
Blocking Timeout in Milliseconds Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds). no blocking-timeout-millis
Idle Timeout The maximum time, in minutes, a connection may be idle before being closed. The default is 30. no idle-timeout-minutes
Is Same RM Override Value If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). no isSameRM-override-value
Jmx Invoker Name The ObjectName of the JMX Invoker MBean associated with this datasource. no jmx-invoker-name
Metadata Metadata properties. no metadata
No Tx Separate Pools If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. no no-tx-separate-pools
Prefill Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. no prefill
Security Settings Security settings for connections in the pool. no security-domain
Statistics Formatter The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". no statistics-formatter
Type Mapping The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. no type-mapping
Use Java Context Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. no use-java-context
Use Strict Min Whether idle connections below the min-pool-size should be closed. The default is No. no use-strict-min
Validate On Match The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes. no validate-on-match
Check Valid Connection SQL The SQL statement to use to check the validity of a pool connection. no check-valid-connection-sql
Connection Definition The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". no connection-definition
Exception Sorter Class Name The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. no exception-sorter-class-name
New Connection SQL An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. no new-connection-sql
Prepared Statement Cache Size The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. no prepared-statement-cache-size
Query Timeout Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. no query-timeout
Rar Name The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. no rar-name
Set Tx Query Timeout Whether to set the query timeout based on the time remaining until transaction timeout; any configured query timeout will be used if there is no transaction. The default is No. no set-tx-query-timeout
Share Prepared Statements Should prepared statements be shared? The default is No. no share-prepared-statements
Stale Connection Checker Class Name Fully qualified name of the Java class used to check if a connection has become stale. no stale-connection-checker-class-name
Track Statements Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". no track-statements
Transaction Isolation The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. no transaction-isolation
Url Delimiter Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". no url-delimiter
Url Selector Strategy Class Name The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. no url-selector-strategy-class-name
Use Try Lock Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. no use-try-lock
Valid Connection Checker Class Name The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. no valid-connection-checker-class-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.282. Metrics

Name Description
Flush Flush the connections in the pool
List Formatted Sub Pool Statistics Obtain a formatted sub pool statistics report
List Statistics Obtain a statistics report
Test Connection Test if a connection can be obtained

Package Types

none

2.8.18. No Tx ConnectionFactory Service

Overview

Table 2.283. Overview

Description: A ConnectionFactory that does not take part in JTA transactions.
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.284. 

Name Description Required Internal Name
Custom Properties Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. no customProperties
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Template Name yes templateName
Component Name Property The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. yes componentNameProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.285. Metrics

Name Type Description Internal Name
Run State trait Run State runState
Pool JNDI Name trait Pool JNDI Name poolJndiName
Available Connection Count measurement Number of available connections. availableConnectionCount
Connection Count measurement Connection Count connectionCount
Connection Created Count measurement Connection Created Count connectionCreatedCount
Connection Destroyed Count measurement Connection Destroyed Count connectionDestroyedCount
In Use Connection Count measurement Mumber of connections currently in use. inUseConnectionCount
Max Connections In Use Count measurement Maximum number of maximum connections that have been in use. maxConnectionsInUseCount
Max Size measurement Max Size maxSize
Min Size measurement Min Size minSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.286. 

Name Description Required Internal Name
JNDI Name The global JNDI name to bind the connection factory under. yes jndi-name
RAR Name The name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar. yes rar-name
Connection Definition The connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. yes connection-definition
Minimum Pool Size The minimum number of connections the pool should hold. The default is 0. no min-pool-size
Maximum Pool Size The maximum number of connections the pool should hold. The default is 10. no max-pool-size
Allocation Retry The number of times that allocating a connection should be tried before throwing an exception. The default is 0. no allocation-retry
Allocation Retry Wait Millis The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). no allocation-retry-wait-millis
Background Validation Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. no background-validation
Background Validation Millis The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. no background-validation-millis
Blocking Timeout in Milliseconds Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds). no blocking-timeout-millis
Idle Timeout The maximum time, in minutes, a connection may be idle before being closed. The default is 30. no idle-timeout-minutes
Is Same RM Override Value If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). no isSameRM-override-value
Jmx Invoker Name The ObjectName of the JMX Invoker MBean associated with this datasource. no jmx-invoker-name
Metadata Metadata properties. no metadata
No Tx Separate Pools If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. no no-tx-separate-pools
Prefill Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. no prefill
Security Settings Security settings for connections in the pool. no security-domain
Statistics Formatter The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". no statistics-formatter
Type Mapping The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. no type-mapping
Use Java Context Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. no use-java-context
Use Strict Min Whether idle connections below the min-pool-size should be closed. The default is No. no use-strict-min
Validate On Match The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes. no validate-on-match
Config Property Properties to supply to the ManagedConnectionFactory (MCF) MBean service configuration. no config-property

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.287. Metrics

Name Description
Flush Flush the connections in the pool
List Formatted Sub Pool Statistics Obtain a formatted sub pool statistics report
List Statistics Obtain a statistics report
Test Connection Test if a connection can be obtained

Package Types

none

2.8.19. No Tx Datasource Service

Overview

Table 2.288. Overview

Description: No Transaction Datasources deployed in the instance of JBoss AS
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.289. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Template Name yes templateName
Component Name Property The name of the Resource configuration property whose value should be used as the ManagedComponent name when creating a new Resource of this type. yes componentNameProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.290. Metrics

Name Type Description Internal Name
Run State trait Run State runState
Pool JNDI Name trait the JNDI name of the connection pool for this datasource poolJndiName
Available Connection Count measurement the maximum number of connections that are available availableConnectionCount
Connection Count measurement the number of connections that are currently in the pool connectionCount
Connection Created Count measurement the number of connections that have been created since the datasource was last started connectionCreatedCount
Connection Destroyed Count measurement the number of connections that have been destroyed since the datasource was last started connectionDestroyedCount
In Use Connection Count measurement the number of connections that are currently in use inUseConnectionCount
Local Transaction trait Local Transaction local-transaction
Max Connections In Use Count measurement the most connections that have been simultaneously in use since this datasource was started maxConnectionsInUseCount
Max Size measurement Max Size maxSize
Min Size measurement Min Size minSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.291. 

Name Description Required Internal Name
JNDI Name The global JNDI Name under which to bind the datasource yes jndi-name
Username The default username when creating a new connection. no user-name
Password The default password when creating a new connection. no password
Minimum Pool Size The minimum number of connections the pool should hold. The default is 0. no min-pool-size
Maximum Pool Size The maximum number of connections the pool should hold. The default is 10. no max-pool-size
JDBC Driver Class The fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver"). yes driver-class
Connection URL The JDBC URL for the database (e.g. "jdbc:oracle:thin:@host.example.com:1521:db"). To define a high availablity (HA) datasource, specify a list of URLs separated by URL delimiters (e.g. "jdbc:oracle:thin:@host1.example.com:1521:db1|jdbc:oracle:thin:@host2.example.com:1521:db2"). yes connection-url
Connection Properties Arbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method. no connection-properties
Allocation Retry The number of times that allocating a connection should be tried before throwing an exception. The default is 0. no allocation-retry
Allocation Retry Wait Millis The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). no allocation-retry-wait-millis
Background Validation Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. no background-validation
Background Validation Millis The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. no background-validation-millis
Blocking Timeout in Milliseconds Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds). no blocking-timeout-millis
Idle Timeout The maximum time, in minutes, a connection may be idle before being closed. The default is 30. no idle-timeout-minutes
Is Same RM Override Value If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). no isSameRM-override-value
Jmx Invoker Name The ObjectName of the JMX Invoker MBean associated with this datasource. no jmx-invoker-name
Metadata Metadata properties. no metadata
No Tx Separate Pools If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. no no-tx-separate-pools
Prefill Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. no prefill
Security Settings Security settings for connections in the pool. no security-domain
Statistics Formatter The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". no statistics-formatter
Type Mapping The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. no type-mapping
Use Java Context Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. no use-java-context
Use Strict Min Whether idle connections below the min-pool-size should be closed. The default is No. no use-strict-min
Validate On Match The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes. no validate-on-match
Check Valid Connection SQL The SQL statement to use to check the validity of a pool connection. no check-valid-connection-sql
Connection Definition The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". no connection-definition
Exception Sorter Class Name The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. no exception-sorter-class-name
New Connection SQL An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. no new-connection-sql
Prepared Statement Cache Size The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. no prepared-statement-cache-size
Query Timeout Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. no query-timeout
Rar Name The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. no rar-name
Set Tx Query Timeout Whether to set the query timeout based on the time remaining until transaction timeout; any configured query timeout will be used if there is no transaction. The default is No. no set-tx-query-timeout
Share Prepared Statements Should prepared statements be shared? The default is No. no share-prepared-statements
Stale Connection Checker Class Name Fully qualified name of the Java class used to check if a connection has become stale. no stale-connection-checker-class-name
Track Statements Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". no track-statements
Transaction Isolation The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. no transaction-isolation
Url Delimiter Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". no url-delimiter
Url Selector Strategy Class Name The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. no url-selector-strategy-class-name
Use Try Lock Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. no use-try-lock
Valid Connection Checker Class Name The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. no valid-connection-checker-class-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.292. Metrics

Name Description
Flush Flush the connections in the pool
List Formatted Sub Pool Statistics Obtain a formatted sub pool statistics report
List Statistics Obtain a statistics report
Test Connection Test if a connection can be obtained

Package Types

none

2.8.20. Resource Adapter Archive (RAR) Service

Overview

Table 2.293. Overview

Description: a standalone JCA resource adapter archive (RAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.294. 

Name Description Required Internal Name
Deployment Name the name of this RAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.295. Metrics

Name Type Description Internal Name
Path trait the absolute path of this RAR file or directory custom.path
Exploded? trait whether this RAR is deployed exploded (i.e. as a directory) custom.exploded

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.296. Metrics

Name Description
Start starts this RAR
Stop stops this RAR
Restart stops and then restarts this RAR

Package Types

Table 2.297. Package Types

Name Category Description
RAR File Deployable

2.8.21. Script Service

Overview

Table 2.298. Overview

Description: provides the ability to execute a script that performs some task related to its parent JBossAS server
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.299. 

Name Description Required Internal Name
Path the absolute path to the script file yes path
Environment Variables the environment variables that will be passed to the script; each variable must be on a new line and have the syntax name=value; the variable's value can contain properties with the syntax %propertyName%; the script plugin will interpolate these with the current values of the corresponding properties from the script's parent JBossAS server's connection properties no environmentVariables

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

Table 2.300. Metrics

Name Description
Execute Script execute the script; NOTE: environment variables to be passed to the script can be configured via this Script service's connection properties (under its Inventory tab)

Package Types

none

2.8.22. Service Binding Manager Service

Overview

Table 2.301. Overview

Description: The Service Binding Manager manages the ports of the deployed services
Singleton: yes
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.302. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.303. Metrics

Name Type Description Internal Name
Active Binding Set trait The active binding set used to obtain port bindings from. activeBindingSetName

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.304. 

Name Description Required Internal Name
Active Binding Set Name The name of the binding set the Service Binding Manager should use when resolving bindings. Note to JBoss ON or Jopr users (does not apply to JBoss AS admin console): CHANGING THIS PROPERTY IS POTENTIALLY DANGEROUS because if there are any port conflicts on the machine the Application Server is running on, the server will not start up again and it will not be possible to monitor it. To be able to monitor the server again after the restart you have to update the "Naming Provider Url" in the "Connection" subtab in the "Inventory" of the Application Server to the value of "jboss:service=Naming:Port" binding of the active binding set. I.e. if the "jboss:service=Naming:Port" binding of the active binding set has the port set to 4099 and hostname to 127.0.0.1, you have to set the "Naming Provider Url" to jnp://127.0.0.1:4099. yes activeBindingSetName
Standard Bindings The standard port bindings inherited by the binding sets. yes standardBindings

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

none

Package Types

none

2.8.22.1. Service Binding Set Service

Overview

Table 2.305. Overview

Description: The Service Binding Set defines all bindings of a profile. It inherits the standard bindings from the Service Binding Manager and defines a port offset and overridden and additional bindings.
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties
none
Metrics

Table 2.306. Metrics

Name Type Description Internal Name
Name trait The name of this binding set. name
Default Host Name trait The default host name of this binding set. defaultHostName
Port Offset trait The port offset of this binding set. portOffset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 2.307. 

Name Description Required Internal Name
Name The name of this binding set. yes name
Default Host Name The host name that should be used for all bindings whose configuration does not specify "fixed host name". yes defaultHostName
Port Offset A value to add to the port configuration for a standard binding to derive the port to use in this binding set. This doesn't apply to standard bindings defined as 'fixed port'. yes portOffset
Override Bindings The binding configurations that apply only to this binding set, either non-standard bindings or ones that override standard binding configurations. The binding set inherits the standard bindings from the Service Binding Manager, applies the port offset to them (unless the standard binding is defined as "fixed port"), and appends the override bindings. These can either redefine a standard binding or define a brand new binding. The standard bindings and the override bindings then define the full set of the bindings that are defined by the binding set. yes overrideBindings

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 2.308. Metrics

Name Description
Display Bindings Displays the full set of bindings as they would look if this bindings set was active.

Package Types
none

2.8.23. Tx ConnectionFactory Service

Overview

Table 2.309. Overview

Description: A ConnectionFactory that takes part in JTA transactions.
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.310. 

Name Description Required Internal Name
Custom Properties Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. no customProperties
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Template Name yes templateName
Component Name Property The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. yes componentNameProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.311. Metrics

Name Type Description Internal Name
Transaction Type trait The type of transactions used by this connection factory - Local or XA custom.transactionType
Run State trait Run State runState
Pool JNDI Name trait Pool JNDI Name poolJndiName
Available Connection Count measurement Number of available connections. availableConnectionCount
Connection Count measurement Connection Count connectionCount
Connection Created Count measurement Connection Created Count connectionCreatedCount
Connection Destroyed Count measurement Connection Destroyed Count connectionDestroyedCount
In Use Connection Count measurement Mumber of connections currently in use. inUseConnectionCount
Max Connections In Use Count measurement Maximum number of maximum connections that have been in use. maxConnectionsInUseCount
Max Size measurement Max Size maxSize
Min Size measurement Min Size minSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.312. 

Name Description Required Internal Name
JNDI Name The global JNDI name to bind the connection factory under. yes jndi-name
RAR Name The name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar. yes rar-name
Connection Definition The connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. yes connection-definition
Minimum Pool Size The minimum number of connections the pool should hold. The default is 0. no min-pool-size
Maximum Pool Size The maximum number of connections the pool should hold. The default is 10. no max-pool-size
XA Transaction Whether on not to use XA transactions. The default is No. no xa-transaction
Allocation Retry The number of times that allocating a connection should be tried before throwing an exception. The default is 0. no allocation-retry
Allocation Retry Wait Millis The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). no allocation-retry-wait-millis
Background Validation Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. no background-validation
Background Validation Millis The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. no background-validation-millis
Blocking Timeout in Milliseconds Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds). no blocking-timeout-millis
Idle Timeout The maximum time, in minutes, a connection may be idle before being closed. The default is 30. no idle-timeout-minutes
Is Same RM Override Value If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). no isSameRM-override-value
Jmx Invoker Name The ObjectName of the JMX Invoker MBean associated with this datasource. no jmx-invoker-name
Metadata Metadata properties. no metadata
No Tx Separate Pools If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. no no-tx-separate-pools
Prefill Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. no prefill
Security Settings Security settings for connections in the pool. no security-domain
Statistics Formatter The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". no statistics-formatter
Type Mapping The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. no type-mapping
Use Java Context Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. no use-java-context
Use Strict Min Whether idle connections below the min-pool-size should be closed. The default is No. no use-strict-min
Validate On Match The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes. no validate-on-match
Config Property Properties to supply to the ManagedConnectionFactory (MCF) MBean service configuration. no config-property
Interleaving If true, enable transaction interleaving if the DB vendor supports it (most do not). Can only be set to true if XA transactions are enabled. This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false. no interleaving
XA Resource Timeout The maximum time, in minutes, an XA Resource can be idle before it is removed. 0 means no timeout. The default is 0. no xa-resource-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.313. Metrics

Name Description
Flush Flush the connections in the pool
List Formatted Sub Pool Statistics Obtain a formatted sub pool statistics report
List Statistics Obtain a statistics report
Test Connection Test if a connection can be obtained

Package Types

none

2.8.24. Web Application (WAR) Service

Overview

Table 2.314. Overview

Description: a standalone web application (WAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.315. 

Name Description Required Internal Name
Deployment Name the name of this WAR yes deploymentName
Filename yes filename
Context Path this WAR's context path (e.g. /admin-console) yes contextPath
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.316. Metrics

Name Type Description Internal Name
Path trait the absolute path of this WAR file or directory custom.path
Exploded? trait whether this WAR is deployed exploded (i.e. as a directory) custom.exploded
Context Root trait this context root of this WAR (e.g. jmx-console) - used as a unique path prefix for URLs corresponding to this WAR contextRoot
Virtual Hosts trait the virtual host(s) to which this WAR is deployed virtualHosts

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.317. Metrics

Name Description
Start starts this WAR
Stop stops this WAR
Restart stops and then restarts this WAR

Package Types

Table 2.318. Package Types

Name Category Description
WAR File Deployable

2.8.24.1. Web Application Context Service

Overview

Table 2.319. Overview

Description: a web application context
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.320. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Response Time Log File the full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Virtual Host this WAR's virtual host (e.g. localhost) yes virtualHost

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.321. Metrics

Name Type Description Internal Name
Virtual Host trait the virtual host with which this context is associated virtualHost
Response Time calltime the minimum, maximum, and average response times for requests serviced by this webapp responseTime
Currently Active Sessions measurement the number of sessions that are currently active for this WAR activeSessions
Maximum Active Sessions measurement the maximum number of sessions that have been active for this WAR maxActive
Created Sessions measurement the number of sessions created for this WAR sessionCounter
Created Sessions per Minute measurement the number of sessions created for this WAR sessionCounter
Expired Sessions measurement the number of expired sessions for this WAR expiredSessions
Expired Sessions per Minute measurement the number of expired sessions for this WAR expiredSessions
Rejected Sessions measurement the number of sessions rejected for this WAR rejectedSessions
Rejected Sessions per Minute measurement the number of sessions rejected for this WAR rejectedSessions
Average Session Alive Time measurement the average alive time of sessions for this WAR sessionAverageAliveTime
Max Session Alive Time measurement the maximum alive time of sessions for this WAR sessionMaxAliveTime
Minimum Response Time measurement the minimum response time for requests serviced by this WAR Servlet.minimumResponseTime
Average Response Time measurement the average response time for requests serviced by this WAR Servlet.averageResponseTime
Maximum Response Time measurement the maximum response time for requests serviced by this WAR Servlet.maximumResponseTime
Total Response Time measurement the total response time for requests serviced by this WAR Servlet.totalResponseTime
Total Response Time per Minute measurement the total response time for requests serviced by this WAR Servlet.totalResponseTime
Number of Requests Serviced measurement the number of requests serviced by this WAR Servlet.requestCount
Number of Requests Serviced per Minute measurement the number of requests serviced by this WAR Servlet.requestCount
Number of Error Responses measurement the number of error responses sent by this WAR Servlet.errorCount
Number of Error Responses per Minute measurement the number of error responses sent by this WAR Servlet.errorCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none

2.8.25. XA Datasource Service

Overview

Table 2.322. Overview

Description: XA Datasources deployed in the instance of JBoss AS
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.323. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Template Name yes templateName
Component Name Property The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. yes componentNameProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.324. Metrics

Name Type Description Internal Name
Run State trait Run State runState
Pool JNDI Name trait the JNDI name of the connection pool for this datasource poolJndiName
Available Connection Count measurement the maximum number of connections that are available availableConnectionCount
Connection Count measurement the number of connections that are currently in the pool connectionCount
Connection Created Count measurement the number of connections that have been created since the datasource was last started connectionCreatedCount
Connection Destroyed Count measurement the number of connections that have been destroyed since the datasource was last started connectionDestroyedCount
In Use Connection Count measurement the number of connections that are currently in use inUseConnectionCount
Local Transaction trait Local Transaction local-transaction
Max Connections In Use Count measurement the most connections that have been simultaneously in use since this datasource was started maxConnectionsInUseCount
Max Size measurement Max Size maxSize
Min Size measurement Min Size minSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.325. 

Name Description Required Internal Name
JNDI Name The global JNDI Name under which to bind the datasource yes jndi-name
Username The default username when creating a new connection. no user-name
Password The default password when creating a new connection. no password
Minimum Pool Size The minimum number of connections the pool should hold. The default is 0. no min-pool-size
Maximum Pool Size The maximum number of connections the pool should hold. The default is 10. no max-pool-size
XA DataSource Class The fully qualified name of the javax.sql.XADataSource implementation class. yes xa-datasource-class
XA Datasource Properties The properties to assign to the XADataSource implementation class. Each property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor for the type. no xa-datasource-properties
XA Resource Timeout XA transaction timeout, in seconds (passed to XAResource.setTransactionTimeout()) - default is zero which does not invoke the setter. no xa-resource-timeout
URL Property For HA XA datasources, specifies the name of an XADataSource property that contains a list of URLs. no url-property
Allocation Retry The number of times that allocating a connection should be tried before throwing an exception. The default is 0. no allocation-retry
Allocation Retry Wait Millis The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). no allocation-retry-wait-millis
Background Validation Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. no background-validation
Background Validation Millis The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. no background-validation-millis
Blocking Timeout in Milliseconds Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds). no blocking-timeout-millis
Idle Timeout The maximum time, in minutes, a connection may be idle before being closed. The default is 30. no idle-timeout-minutes
Is Same RM Override Value If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). no isSameRM-override-value
Jmx Invoker Name The ObjectName of the JMX Invoker MBean associated with this datasource. no jmx-invoker-name
Metadata Metadata properties. no metadata
No Tx Separate Pools If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. no no-tx-separate-pools
Prefill Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. no prefill
Security Settings Security settings for connections in the pool. no security-domain
Statistics Formatter The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". no statistics-formatter
Type Mapping The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. no type-mapping
Use Java Context Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. no use-java-context
Use Strict Min Whether idle connections below the min-pool-size should be closed. The default is No. no use-strict-min
Validate On Match The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes. no validate-on-match
Check Valid Connection SQL The SQL statement to use to check the validity of a pool connection. no check-valid-connection-sql
Connection Definition The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". no connection-definition
Exception Sorter Class Name The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. no exception-sorter-class-name
New Connection SQL An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. no new-connection-sql
Prepared Statement Cache Size The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. no prepared-statement-cache-size
Query Timeout Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. no query-timeout
Rar Name The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. no rar-name
Set Tx Query Timeout Whether to set the query timeout based on the time remaining until transaction timeout; any configured query timeout will be used if there is no transaction. The default is No. no set-tx-query-timeout
Share Prepared Statements Should prepared statements be shared? The default is No. no share-prepared-statements
Stale Connection Checker Class Name Fully qualified name of the Java class used to check if a connection has become stale. no stale-connection-checker-class-name
Track Statements Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". no track-statements
Transaction Isolation The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. no transaction-isolation
Url Delimiter Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". no url-delimiter
Url Selector Strategy Class Name The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. no url-selector-strategy-class-name
Use Try Lock Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. no use-try-lock
Valid Connection Checker Class Name The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. no valid-connection-checker-class-name
Interleaving If true, enable transaction interleaving if the DB vendor supports it (most do not). This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false. no interleaving

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.326. Metrics

Name Description
Flush Flush the connections in the pool
List Formatted Sub Pool Statistics Obtain a formatted sub pool statistics report
List Statistics Obtain a statistics report
Test Connection Test if a connection can be obtained

Package Types

none

2.9. JBossCacheSubsystem Server

Overview

Table 2.327. Overview

Description: The JBoss Cache instances on this server
Singleton: yes
Plugin: JBossCache

Parent Resource Types

Child Resource Types

Autodiscovery Process Scans

none

Connection Properties

none

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

2.9.1. JBossCache Service

Overview

Table 2.328. Overview

Description: Statistics for JBossCache
Singleton: no
Plugin: JBossCache

Note

Please note that the number of possible metrics varies depending on the configuration and flavour of Cache used.

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.329. 

Name Description Required Internal Name
Object Name yes objectName
Is Tree Cache Is this a TreeCache instance or a POJO Cache yes isTreeCache

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.330. Metrics

Name Type Description Internal Name
Number of Nodes measurement Number of Nodes :numberOfNodes
Activations measurement Number of passivated nodes that have been activated. ActivationInterceptor:activations
Cache Loader Loads measurement Number of nodes loaded through a cache loader. CacheLoaderInterceptor:cacheLoaderLoads
Cache Loader Loads per Minute measurement Number of nodes loaded through a cache loader. CacheLoaderInterceptor:cacheLoaderLoads
Cache Loader Misses measurement Number of unsuccessful attempts to load a node through a cache loader. CacheLoaderInterceptor:cacheLoaderMisses
Cache Loader Misses per Minute measurement Number of unsuccessful attempts to load a node through a cache loader. CacheLoaderInterceptor:cacheLoaderMisses
Cache Hits measurement Number of successful attribute retrievals. CacheMgmtInterceptor:hits
Cache Hits per Minute measurement Number of successful attribute retrievals. CacheMgmtInterceptor:hits
Cache Misses measurement Number of unsuccessful attribute retrievals. CacheMgmtInterceptor:misses
Cache Misses per Minute measurement Number of unsuccessful attribute retrievals. CacheMgmtInterceptor:misses
Hit-miss-ratio measurement Ratio of hits to hits and misses. A hit is a get attribute operation that results in an object being returned to the client. The retrieval may be from a cache loader if the entry isn't in the local cache. CacheMgmtInterceptor:hitMissRatio
Read-write-ratio measurement Ratio of read operations to write operations. This is the ratio of cache hits and misses to cache stores. CacheMgmtInterceptor:readWriteRatio
Cache Stores measurement Number of attribute store operations. CacheMgmtInterceptor:stores
Cache Stores per Minute measurement Number of attribute store operations. CacheMgmtInterceptor:stores
Cache Evictions measurement Number of node evictions. CacheMgmtInterceptor:evictions
Cache Evictions per Minute measurement Number of node evictions. CacheMgmtInterceptor:evictions
Number of Attributes measurement Number of attributes currently cached. CacheMgmtInterceptor:numberOfAttributes
Number of Nodes cached measurement Number of nodes currently cached. CacheMgmtInterceptor:numberOfNodes
Elapsed Time measurement Number of seconds that the cache has been running. CacheMgmtInterceptor:elapsedTime
Elapsed Time per Minute measurement Number of seconds that the cache has been running. CacheMgmtInterceptor:elapsedTime
Time since reset measurement Number of seconds since the cache statistics have been reset. CacheMgmtInterceptor:timeSinceReset
Time since reset per Minute measurement Number of seconds since the cache statistics have been reset. CacheMgmtInterceptor:timeSinceReset
Average Read Time measurement Average time in milliseconds to retrieve a cache attribute, including unsuccessful attribute retrievals. CacheMgmtInterceptor:averageReadTime
Average Write Time measurement Average time in milliseconds to write a cache attribute. CacheMgmtInterceptor:averageWriteTime
Cache Loader Stores measurement Number of nodes written to the cache loader. CacheStoreInterceptor:cacheLoaderStores
Cache Loader Stores per Minute measurement Number of nodes written to the cache loader. CacheStoreInterceptor:cacheLoaderStores
Invalidataions measurement Number of cached nodes that have been invalidated. InvalidationInterceptor:invalidations
Invalidataions per Minute measurement Number of cached nodes that have been invalidated. InvalidationInterceptor:invalidations
Passivations measurement Number of cached nodes that have been passivated. PassivationInterceptor:passivations
Passivations per Minute measurement Number of cached nodes that have been passivated. PassivationInterceptor:passivations
Tx prepares measurement Number of transaction prepare operations performed. TxInterceptor:prepares
Tx prepares per Minute measurement Number of transaction prepare operations performed. TxInterceptor:prepares
Tx commits measurement Number of transaction commit operations performed. TxInterceptor:commits
Tx commits per Minute measurement Number of transaction commit operations performed. TxInterceptor:commits
Tx rollbacks measurement Number of transaction rollback operations performed. TxInterceptor:rollbacks
Tx rollbacks per Minute measurement Number of transaction rollback operations performed. TxInterceptor:rollbacks

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.331. 

Name Description Required Internal Name
Flavour Is this going to be a Pojo Cache or a Tree Cache yes Flavour
Transaction Manager Lookup Class What class should be used to get a transaction manager instance yes TransactionManagerLookupClass
Isolation Level The isolation level for access to the cache yes IsolationLevel
Node Locking Scheme yes NodeLockingScheme
Cache Mode yes CacheMode
Use Repl Queue Just used for async repl: use a replication queue yes UseReplQueue
Repl Queue Interval Replication interval for replication queue (in ms) yes ReplQueueInterval
Repl Queue Max Elements Max number of elements which trigger replication yes ReplQueueMaxElements
Cluster Name Name of cluster. Needs to be the same for all clusters, in order to find each other yes ClusterName
Fetch State On Startup Whether or not to fetch state on joining a cluster yes FetchStateOnStartup
Initial State Retrieval Timeout The max amount of time (in milliseconds) we wait until the initial state (ie. the contents of the cache) are retrieved from existing members in a clustered environment yes InitialStateRetrievalTimeout
Sync Repl Timeout Number of milliseconds to wait until all responses for a synchronous call have been received. yes SyncReplTimeout
Lock Acquisition Timeout Max number of milliseconds to wait for a lock acquisition. yes LockAcquisitionTimeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.332. Metrics

Name Description
Reset Statistics Resets all statistics
List associated MBeans List all MBeans that form this Cache instance

Package Types

none

2.9.1.1. JGroupsRepo Service

Overview

Table 2.333. Overview

Description: The underlying JGroups repo for this cache instance
Singleton: no
Plugin: JBossCache

Parent Resource Types
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none

2.10. JBoss Cache Service 3

Overview

Table 2.334. Overview

Description: The JBoss Cache instances on this server
Singleton: no
Plugin: JBossCache3

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.335. 

Name Description Required Internal Name
Search String yes searchString

Note

The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.336. Metrics

Name Type Description Internal Name
Cluster Config trait Cluster Config ClusterConfig
Node Locking Scheme trait Node Locking Scheme NodeLockingScheme
Expose Management Statistics? trait Expose Management Statistics? ExposeManagementStatistics
Register JMX Resource? trait Register JMX Resource? RegisterJmxResource
Cache Loader Configuration trait Cache Loader Configuration CacheLoaderConfiguration
Multiplexer Stack trait Multiplexer Stack MultiplexerStack
Replication Queue Max Elements measurement Replication Queue Max Elements ReplQueueMaxElements
Number of Attributes measurement Number of Attributes NumberOfAttributes
Cache Loader Config trait Cache Loader Config CacheLoaderConfig
Cluster Name trait Cluster Name ClusterName
Inactive on Startup? trait Inactive on Startup? InactiveOnStartup
Cache Mode trait Cache Mode CacheMode
Isolation Level trait Isolation Level IsolationLevel
Replication Version trait Replication Version ReplicationVersion
Fetch In-Memory State? trait Fetch In-Memory State? FetchInMemoryState
Initial State Retrieval Timeout measurement Initial State Retrieval Timeout InitialStateRetrievalTimeout
Buddy Replication Config trait Buddy Replication Config BuddyReplicationConfig
Replication Queue Interval measurement Replication Queue Interval ReplQueueInterval
Use Replication Queue? trait Use Replication Queue? UseReplQueue
Use Region-Based Marshalling? trait Use Region-Based Marshalling? UseRegionBasedMarshalling
Lock Acquisition Timeout measurement Lock Acquisition Timeout LockAcquisitionTimeout
Number of Nodes measurement Number of Nodes NumberOfNodes
Sync Commit Phase? trait Sync Commit Phase? SyncCommitPhase
Sync Replication Timeout measurement Sync Replication Timeout SyncReplTimeout
Eviction Policy Config trait Eviction Policy Config EvictionPolicyConfig
State trait State State
State Retrieval Timeout measurement State Retrieval Timeout StateRetrievalTimeout
Transaction Manager Lookup Class trait Transaction Manager Lookup Class TransactionManagerLookupClass
Cluster Properties trait Cluster Properties ClusterProperties

Note

The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.337. Metrics

Name Description
Destroy this cache.
Stop this cache.
Create this cache.
Start this cache.
Print lock information.
Print cache details.
Print cache details as HTML.
Print configuration as plain text.
Print lock info as HTML.
Print configuration as HTML.

Package Types

none

2.10.1. Data Container Service

Overview

Table 2.338. Overview

Description: JBoss Cache Data Container
Singleton: yes
Plugin: JBossCache3

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.339. 

Name Description Required Internal Name
Jmx Resource yes jmx-resource

Note

The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

Table 2.340. Metrics

Name Description
Get the number of nodes. Returns the number of nodes in the data container
Get the number of attributes. Returns the number of nodes in the data container
Print details as plain text. Prints details about the data container
Print details as HTML. Prints details about the data container, formatted as HTML

Package Types

none

2.10.2. Interceptor Service

Overview

Table 2.341. Overview

Description: JBoss Cache Interceptor
Singleton: yes
Plugin: JBossCache3

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.342. 

Name Description Required Internal Name
Jmx Resource yes jmx-resource

Note

The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.343. Metrics

Name Type Description Internal Name
Evictions measurement the number of cache eviction operations Evictions
Evictions per Minute measurement the number of cache eviction operations Evictions
Hit/Miss Ratio measurement Hit/Miss Ratio HitMissRatio
Read/Write Ratio measurement Read/Write Ratio ReadWriteRatio
NumberOfNodes measurement the number of nodes in the cache NumberOfNodes
Hits measurement the number of cache attribute hits Hits
Hits per Minute measurement the number of cache attribute hits Hits
Number Of Attributes measurement the number of cache attributes NumberOfAttributes
Statistics Enabled trait Statistics Enabled StatisticsEnabled
Elapsed Time measurement the time elapsed since the cache was started ElapsedTime
Elapsed Time per Minute measurement the time elapsed since the cache was started ElapsedTime
Time Since Reset measurement the time elapsed since the cache statistics were last reset TimeSinceReset
Time Since Reset per Minute measurement the time elapsed since the cache statistics were last reset TimeSinceReset
Misses measurement the number of cache attribute misses Misses
Misses per Minute measurement the number of cache attribute misses Misses
Average Write Time measurement the average amount of time per write operation AverageWriteTime
Stores measurement the number of cache attribute put operations Stores
Stores per Minute measurement the number of cache attribute put operations Stores
Average Read Time measurement the average amount of time per read operation AverageReadTime

Note

The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.344. Metrics

Name Description
Reset Statistics Reset all statistics.

Package Types

none

2.10.3. Lock Manager Service

Overview

Table 2.345. Overview

Description: MVCC Lock Manager
Singleton: yes
Plugin: JBossCache3

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.346. 

Name Description Required Internal Name
Jmx Resource yes jmx-resource

Note

The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.347. Metrics

Name Type Description Internal Name
Concurrency level measurement The concurrency level that the MVCC Lock Manager has been configured with. concurrency level
Locks held measurement The number of exclusive locks that are held. locks held

Note

The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.10.4. RegionManager Service

Overview

Table 2.348. Overview

Description: JBoss Cache RegionManager
Singleton: yes
Plugin: JBossCache3

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.349. 

Name Description Required Internal Name
Jmx Resource yes jmx-resource

Note

The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.350. Metrics

Name Type Description Internal Name
Number of Regions measurement the total number of regions numRegions

Note

The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.351. Metrics

Name Description
Dump Regions Dump a list of all registered regions.

Package Types

none

2.10.5. RPC Manager Service

Overview

Table 2.352. Overview

Description: JBoss Cache RPC Manager
Singleton: yes
Plugin: JBossCache3

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.353. 

Name Description Required Internal Name
Jmx Resource yes jmx-resource

Note

The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.354. Metrics

Name Type Description Internal Name
RPC Enabled? trait whether or not the RPC Manager is used in this cache instance Enabled
Failed Replications measurement the number of failed replications ReplicationFailures
Local Address trait Local address LocalAddressString
Statistics Enabled trait Statistics Enabled StatisticsEnabled
Successful Replications measurement the number of successful replications ReplicationCount
Success Ratio trait RPC call success ratio SuccessRatio
Members trait cluster view MembersString

Note

The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.355. Metrics

Name Description
Reset Statistics Reset all statistics.

Package Types

none

2.10.6. Transaction Table Service

Overview

Table 2.356. Overview

Description: JBoss Cache TransactionTable
Singleton: yes
Plugin: JBossCache3

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.357. 

Name Description Required Internal Name
Jmx Resource yes jmx-resource

Note

The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.358. Metrics

Name Type Description Internal Name
Number Of Registered Transactions measurement the number of registered transactions numberOfRegisteredTransactions
Transaction Map trait a string representation of the transaction map transactionMap

Note

The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.359. Metrics

Name Description
Reset Statistics Reset all statistics.

Package Types

none

2.10.7. Tx Interceptor Service

Overview

Table 2.360. Overview

Description: JBoss Cache TxInterceptor
Singleton: yes
Plugin: JBossCache3

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.361. 

Name Description Required Internal Name
Jmx Resource yes jmx-resource

Note

The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.362. Metrics

Name Type Description Internal Name
Commits measurement the number of transaction commits Commits
Statistics Enabled? trait a String representation of the transaction map StatisticsEnabled
Rollbacks measurement the number of transaction rollbacks Rollbacks
Prepares measurement the number of transaction prepares Prepares
Number Of Syncs Registered measurement the number of transaction synchronizations currently registered numberOfSyncsRegistered

Note

The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.11. JMX Server

Overview

Table 2.363. Overview

Description: Generic JMX Server
Singleton: no
Plugin: JMX

Note

In order to monitor your Java applications via JMX, you need to expose their MBeans to remote JMX clients. In order to do this, you must pass in some system properties when starting your application's Java virtual machine.
To run a JVM with JMX remoting enabled without authentication, you must pass in the following system properties:
  • -Dcom.sun.management.jmxremote.port=19988
  • -Dcom.sun.management.jmxremote.ssl=false
  • -Dcom.sun.management.jmxremote.authenticate=false
You can require your remote JMX endpoint to demand authentication for clients to be able to connect to it. To run a JVM with JMX remoting enabled with password authentication:
  • -Dcom.sun.management.jmxremote.port=19988
  • -Dcom.sun.management.jmxremote.ssl=false
  • -Dcom.sun.management.jmxremote.authenticate=true
  • -Dcom.sun.management.jmxremote.password.file=/some/directory/jmxremote.password
Note that "jmxremote.password" must be read-only. On Windows, you must use "cacls" command to do this: cacls /some/directory/jmxremote.password /P username:R
A password file template is located at $JRE_HOME/lib/management/jmxremote.password.template. There is also an auth file that you can use to define other roles. For more information on setting this up and setting up SSL, see Monitoring and Management Using JMX.
If you wish to expose your JBossAS 4 application server's MBeans over this remote JMX mechanism, you must pass in these extra properties, in addition to the properties specified above:
  • -Djboss.platform.mbeanserver
  • -Djavax.management.builder.initial=org.jboss.system.server.jmx.MBeanServerBuilderImpl

Parent Resource Types

Child Resource Types

Autodiscovery Process Scans

Table 2.364. Metrics

Name Query
java process|basename|match=^java.*

Connection Properties

Table 2.365. 

Name Description Required Internal Name
Type The EMS connection type for this JMX Server yes type
Connector Address The connection url in the form of a JMXServiceURL yes connectorAddress
Install URI The installation path for the selected server type which will be used to find client libraries (if appropriate). no installURI
Principal The login principal/username no principal
Credentials The login credentials/password no credentials
Additional Class Path Entries Comma-separated list of directories and filenames that contain resources and classes needed to communicate with the JMX Server and its MBeans. If you specify 'some/directory/*.jar', all jars found in the given directory will be added. no additionalClassPathEntries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

2.11.1. java.util.logging Service

Overview

Table 2.366. Overview

Description: Logging control for the java.util.logging subsystem
Singleton: yes
Plugin: JMX

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.367. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Config Management Enabled When false, configuration reading for this resource will fail. yes configManagementEnabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

Table 2.368. 

Name Description Required Internal Name
Appender List yes AppenderList

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

none

Package Types

none

2.11.2. Operating System Service

Overview

Table 2.369. Overview

Description:
Singleton: yes
Plugin: JMX

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.370. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.371. Metrics

Name Type Description Internal Name
Free Physical Memory measurement The amount of free physical memory for the OS FreePhysicalMemorySize
Free Swap Memory measurement The amount of free swap space for the OS FreeSwapSpaceSize
Process CPU Time measurement The cpu time used by this process ProcessCpuTime
Process CPU Time per Minute measurement The cpu time used by this process ProcessCpuTime
Committed Virtual Memory measurement Size of virtual memory used by this process CommittedVirtualMemorySize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

2.11.3. Threading Service

Overview

Table 2.372. Overview

Description: Information on threading in the VM
Singleton: yes
Plugin: JMX

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.373. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.374. Metrics

Name Type Description Internal Name
Thread Count measurement Number of active threads in the system ThreadCount
Peak Thread Count measurement Peak count of active threads in the system PeakThreadCount
Total Started Thread Count measurement Count of threads started since system start TotalStartedThreadCount
Daemon Thread Count measurement Count of threads marked as daemons in the system DaemonThreadCount
Suspended Thread Count measurement Count of suspended threads SuspendedThreadCount
Deadlocked Thread Count measurement Count of threads that are deadlocked waiting to acquire object monitors. This is a CPU-time consuming metric. DeadLockedThreadCount

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.375. 

Name Description Required Internal Name
Thread Contention Monitoring Enabled yes ThreadContentionMonitoringEnabled
Thread Cpu Time Enabled yes ThreadCpuTimeEnabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.376. Metrics

Name Description
Reset Peak Thread Metrics Reset the peak number of threads