Complete Resource Reference for Metrics, Operations, and Configuration Properties

Red Hat JBoss Operations Network 3.3

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

Edition 3.3

Jared Morgan

Zach Rhoads

Ella Deon Ballard

Abstract

This is a reference for all monitoring checks available for the default resources handled in Red Hat JBoss Operations Network, as well as available resource operations, configuration properties, and plug-in properties.

Preface

1. Document History

Revision History
Revision 3.3.2-5June 30, 2015Jared Morgan
Prepared for JBoss ON 3.3.2 Release, and fixed issues with sort order.
Revision 3.3-10November 17, 2014Jared Morgan
Updated for JBoss ON 3.3 GA

Chapter 1. Managed Platforms

JBoss Operations Network 3.3 supports several major types of platforms and operating systems, including Java, Linux, Unix distributions, and Windows. Platform support is implemented through a single agent resource plug-in that defines the individual configuration, metrics, and operations for all supported platform types.

1.1. Platforms - AIX Platform

Overview

Table 1.1. Overview

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

Child Resource Types

Connection Properties

none

Metrics

Table 1.2. Metrics

NameTypeDescriptionInternal Name
Free MemorymeasurementThe total free system memory (does not include buffer or cache memory)Native.MemoryInfo.free
Actual Free MemorymeasurementThe actual total free system memory (includes unallocated memory as well as available buffer and cache memory)Native.MemoryInfo.actualFree
Used MemorymeasurementThe total used system memory (does not include buffer or cache memory)Native.MemoryInfo.used
Actual Used MemorymeasurementThe actual total used system memory (includes buffer and cache memory)Native.MemoryInfo.actualUsed
Total MemorymeasurementThe total system memoryNative.MemoryInfo.total
Free Swap SpacemeasurementThe total free system swapNative.SwapInfo.free
Used Swap SpacemeasurementThe total used system swapNative.SwapInfo.used
Total Swap SpacemeasurementThe total system swapNative.SwapInfo.total
IdlemeasurementIdle percentage of all CPUsCpuPerc.idle
System LoadmeasurementPercentage of all CPUs running in system modeCpuPerc.sys
User LoadmeasurementPercentage of all CPUs running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of all CPUs waiting on I/OCpuPerc.wait
HostnametraitName that this platform is known asTrait.hostname
OS NametraitName that the operating system is known asTrait.osname
OS VersiontraitVersion of the operating systemTrait.osversion
ArchitecturetraitHardware architecture of the platformTrait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.3. Metrics

NameDescription
Run AutodiscoveryRun an immediate discovery to search for new resources
View Process ListView running processes on this system

Package Types

none

1.1.1. Platforms - Process Service

Overview

Table 1.4. Overview

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

Child Resource Types

none

Connection Properties

Table 1.5. 

NameDescriptionRequiredInternal Name
TypeChoice of using a pid file or a PIQL query to find the process to monitor yes type
Pid FileFully qualified path to the pid file for the process to monitor no pidFile
PiqlProcess Information Query Language for process to monitor no piql
Full Process TreeIf 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.6. Metrics

NameTypeDescriptionInternal Name
User TimemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
User Time per MinutemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
Kernel TimemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
Kernel Time per MinutemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
CPU PercentagemeasurementThe percentage of CPU currently being used by all processesProcess.cpu.percent
Physical MemorymeasurementThe aggregate amount of resident memory used by all processesProcess.memory.resident
Virtual MemorymeasurementThe aggregate amount of virtual memory used by all processesProcess.memory.size
Open File DescriptorsmeasurementThe aggregate number of file descriptors open by all processesProcess.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

1.1.2. Platforms - File System Service

Overview

Table 1.7. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.8. Metrics

NameTypeDescriptionInternal Name
Free SpacemeasurementThe total free bytes on filesystemfileSystemUsage.free
Used PercentagemeasurementThe percentage of disk usedfileSystemUsage.usePercent
CapacitytraitThe total size of the filesystemfileSystemUsage.total
Volume TypetraitThe filesystem's generic type namefileSystem.typeName
Drive TypetraitThe filesystem's operating system-specific type namefileSystem.sysTypeName
nametraitThe name of this devicefileSystem.devName
Free FilesmeasurementThe number of free file nodes on the filesystemfileSystemUsage.freeFiles
FlagstraitThe filesystem's flagsfileSystem.flags
UsedmeasurementThe total bytes used on the filesystemfileSystemUsage.used
Disk ReadsmeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk Reads per MinutemeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk WritesmeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Writes per MinutemeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Read BytesmeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Read Bytes per MinutemeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Write BytesmeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk Write Bytes per MinutemeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk QueuemeasurementThe number of I/Os currently in progressfileSystemUsage.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.1.3. Platforms - Directory Service

Overview

Table 1.9. Overview

Description:Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

Table 1.10. 

NameDescriptionRequiredInternal Name
PathDirectory to monitor. / is not allowed. yes path

Note

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

Metrics

Table 1.11. Metrics

NameTypeDescriptionInternal Name
Directory usagemeasurementDisk usage of this directoryusage
Number of filesmeasurementNumber of files in the directoryfiles
Number of itemsmeasurementNumber of items in the directory (files, subdirs, symlinks)total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.1.4. Platforms - Network Adapter Service

Overview

Table 1.12. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.13. Metrics

NameTypeDescriptionInternal Name
Inet4AddresstraitIP address of the network adapterTrait.net4.address
Interface FlagstraitFlag constants for network related operationsTrait.interfaceFlags
Bytes ReceivedmeasurementThe total number of bytes received across this network interface since it startedrxBytes
Bytes Received per MinutemeasurementThe total number of bytes received across this network interface since it startedrxBytes
Packets ReceivedmeasurementThe total number of packets received across this network interface since it startedrxPackets
Packets Received per MinutemeasurementThe total number of packets received across this network interface since it startedrxPackets
Bytes TransmittedmeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Bytes Transmitted per MinutemeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Packets TransmittedmeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Packets Transmitted per MinutemeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Receive Errorsmeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Errors per Minutemeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Packets Droppedmeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Packets Dropped per Minutemeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Overrurnsmeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Overrurns per Minutemeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Framemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Receive Frame per Minutemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Transmit Errorsmeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Errors per Minutemeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Packets Droppedmeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Packets Dropped per Minutemeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Overrunsmeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Overruns per Minutemeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Collisionsmeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Collisions per Minutemeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Carriermeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier
Transmit Carrier per Minutemeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.1.5. Platforms - CPU Service

Overview

Table 1.14. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.15. Metrics

NameTypeDescriptionInternal Name
IdlemeasurementIdle percentage of this CPUCpuPerc.idle
System LoadmeasurementPercentage of this CPU running in system modeCpuPerc.sys
User LoadmeasurementPercentage of this CPU running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of this CPU waiting on I/OCpuPerc.wait
User TimemeasurementThe total system CPU user timeCpu.user
User Time per MinutemeasurementThe total system CPU user timeCpu.user
Nice TimemeasurementThe total system CPU nice timeCpu.nice
Nice Time per MinutemeasurementThe total system CPU nice timeCpu.nice
System TimemeasurementThe total system CPU kernel timeCpu.sys
System Time per MinutemeasurementThe total system CPU kernel timeCpu.sys
Idle TimemeasurementThe total system CPU idle timeCpu.idle
Idle Time per MinutemeasurementThe total system CPU idle timeCpu.idle
Wait TimemeasurementThe total system CPU I/O wait timeCpu.wait
Wait Time per MinutemeasurementThe total system CPU I/O wait timeCpu.wait
VendortraitVendor of this CPUCpuTrait.vendor
CPU ModeltraitModel of this CPUCpuTrait.model
CPU SpeedtraitSpeed of this CPU in MhzCpuTrait.mhz
Cache sizetraitCache Size of this CPUCpuTrait.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.2. Platforms - FreeBSD Platform

Overview

Table 1.16. Overview

Description:FreeBSD Operating System
Singleton: no
Plugin:Platforms

Child Resource Types

Connection Properties

none

Metrics

Table 1.17. Metrics

NameTypeDescriptionInternal Name
Free MemorymeasurementThe total free system memory (does not include buffer or cache memory)Native.MemoryInfo.free
Actual Free MemorymeasurementThe actual total free system memory (includes unallocated memory as well as available buffer and cache memory)Native.MemoryInfo.actualFree
Used MemorymeasurementThe total used system memory (does not include buffer or cache memory)Native.MemoryInfo.used
Actual Used MemorymeasurementThe actual total used system memory (includes buffer and cache memory)Native.MemoryInfo.actualUsed
Total MemorymeasurementThe total system memoryNative.MemoryInfo.total
Free Swap SpacemeasurementThe total free system swapNative.SwapInfo.free
Used Swap SpacemeasurementThe total used system swapNative.SwapInfo.used
Total Swap SpacemeasurementThe total system swapNative.SwapInfo.total
IdlemeasurementIdle percentage of all CPUsCpuPerc.idle
System LoadmeasurementPercentage of all CPUs running in system modeCpuPerc.sys
User LoadmeasurementPercentage of all CPUs running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of all CPUs waiting on I/OCpuPerc.wait
HostnametraitName that this platform is known asTrait.hostname
OS NametraitName that the operating system is known asTrait.osname
OS VersiontraitVersion of the operating systemTrait.osversion
ArchitecturetraitHardware architecture of the platformTrait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.18. Metrics

NameDescription
Run AutodiscoveryRun an immediate discovery to search for new resources
View Process ListView running processes on this system

Package Types

none

1.2.1. Platforms - Process Service

Overview

Table 1.19. Overview

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

Child Resource Types

none

Connection Properties

Table 1.20. 

NameDescriptionRequiredInternal Name
TypeChoice of using a pid file or a PIQL query to find the process to monitor yes type
Pid FileFully qualified path to the pid file for the process to monitor no pidFile
PiqlProcess Information Query Language for process to monitor no piql
Full Process TreeIf 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.21. Metrics

NameTypeDescriptionInternal Name
User TimemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
User Time per MinutemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
Kernel TimemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
Kernel Time per MinutemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
CPU PercentagemeasurementThe percentage of CPU currently being used by all processesProcess.cpu.percent
Physical MemorymeasurementThe aggregate amount of resident memory used by all processesProcess.memory.resident
Virtual MemorymeasurementThe aggregate amount of virtual memory used by all processesProcess.memory.size
Open File DescriptorsmeasurementThe aggregate number of file descriptors open by all processesProcess.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

1.2.2. Platforms - File System Service

Overview

Table 1.22. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.23. Metrics

NameTypeDescriptionInternal Name
Free SpacemeasurementThe total free bytes on filesystemfileSystemUsage.free
Used PercentagemeasurementThe percentage of disk usedfileSystemUsage.usePercent
CapacitytraitThe total size of the filesystemfileSystemUsage.total
Volume TypetraitThe filesystem's generic type namefileSystem.typeName
Drive TypetraitThe filesystem's operating system-specific type namefileSystem.sysTypeName
nametraitThe name of this devicefileSystem.devName
Free FilesmeasurementThe number of free file nodes on the filesystemfileSystemUsage.freeFiles
FlagstraitThe filesystem's flagsfileSystem.flags
UsedmeasurementThe total bytes used on the filesystemfileSystemUsage.used
Disk ReadsmeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk Reads per MinutemeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk WritesmeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Writes per MinutemeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Read BytesmeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Read Bytes per MinutemeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Write BytesmeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk Write Bytes per MinutemeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk QueuemeasurementThe number of I/Os currently in progressfileSystemUsage.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.2.3. Platforms - Directory Service

Overview

Table 1.24. Overview

Description:Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

Table 1.25. 

NameDescriptionRequiredInternal Name
PathDirectory to monitor. / is not allowed. yes path

Note

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

Metrics

Table 1.26. Metrics

NameTypeDescriptionInternal Name
Directory usagemeasurementDisk usage of this directoryusage
Number of filesmeasurementNumber of files in the directoryfiles
Number of itemsmeasurementNumber of items in the directory (files, subdirs, symlinks)total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.2.4. Platforms - Network Adapter Service

Overview

Table 1.27. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.28. Metrics

NameTypeDescriptionInternal Name
Inet4AddresstraitIP address of the network adapterTrait.net4.address
Interface FlagstraitFlag constants for network related operationsTrait.interfaceFlags
Bytes ReceivedmeasurementThe total number of bytes received across this network interface since it startedrxBytes
Bytes Received per MinutemeasurementThe total number of bytes received across this network interface since it startedrxBytes
Packets ReceivedmeasurementThe total number of packets received across this network interface since it startedrxPackets
Packets Received per MinutemeasurementThe total number of packets received across this network interface since it startedrxPackets
Bytes TransmittedmeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Bytes Transmitted per MinutemeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Packets TransmittedmeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Packets Transmitted per MinutemeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Receive Errorsmeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Errors per Minutemeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Packets Droppedmeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Packets Dropped per Minutemeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Overrurnsmeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Overrurns per Minutemeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Framemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Receive Frame per Minutemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Transmit Errorsmeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Errors per Minutemeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Packets Droppedmeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Packets Dropped per Minutemeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Overrunsmeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Overruns per Minutemeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Collisionsmeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Collisions per Minutemeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Carriermeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier
Transmit Carrier per Minutemeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.2.5. Platforms - CPU Service

Overview

Table 1.29. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.30. Metrics

NameTypeDescriptionInternal Name
IdlemeasurementIdle percentage of this CPUCpuPerc.idle
System LoadmeasurementPercentage of this CPU running in system modeCpuPerc.sys
User LoadmeasurementPercentage of this CPU running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of this CPU waiting on I/OCpuPerc.wait
User TimemeasurementThe total system CPU user timeCpu.user
User Time per MinutemeasurementThe total system CPU user timeCpu.user
Nice TimemeasurementThe total system CPU nice timeCpu.nice
Nice Time per MinutemeasurementThe total system CPU nice timeCpu.nice
System TimemeasurementThe total system CPU kernel timeCpu.sys
System Time per MinutemeasurementThe total system CPU kernel timeCpu.sys
Idle TimemeasurementThe total system CPU idle timeCpu.idle
Idle Time per MinutemeasurementThe total system CPU idle timeCpu.idle
Wait TimemeasurementThe total system CPU I/O wait timeCpu.wait
Wait Time per MinutemeasurementThe total system CPU I/O wait timeCpu.wait
VendortraitVendor of this CPUCpuTrait.vendor
CPU ModeltraitModel of this CPUCpuTrait.model
CPU SpeedtraitSpeed of this CPU in MhzCpuTrait.mhz
Cache sizetraitCache Size of this CPUCpuTrait.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.3. Platforms - HP-UX Platform

Overview

Table 1.31. Overview

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

Child Resource Types

Connection Properties

none

Metrics

Table 1.32. Metrics

NameTypeDescriptionInternal Name
Free MemorymeasurementThe total free system memory (does not include buffer or cache memory)Native.MemoryInfo.free
Actual Free MemorymeasurementThe actual total free system memory (includes unallocated memory as well as available buffer and cache memory)Native.MemoryInfo.actualFree
Used MemorymeasurementThe total used system memory (does not include buffer or cache memory)Native.MemoryInfo.used
Actual Used MemorymeasurementThe actual total used system memory (includes buffer and cache memory)Native.MemoryInfo.actualUsed
Total MemorymeasurementThe total system memoryNative.MemoryInfo.total
Free Swap SpacemeasurementThe total free system swapNative.SwapInfo.free
Used Swap SpacemeasurementThe total used system swapNative.SwapInfo.used
Total Swap SpacemeasurementThe total system swapNative.SwapInfo.total
IdlemeasurementIdle percentage of all CPUsCpuPerc.idle
System LoadmeasurementPercentage of all CPUs running in system modeCpuPerc.sys
User LoadmeasurementPercentage of all CPUs running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of all CPUs waiting on I/OCpuPerc.wait
HostnametraitName that this platform is known asTrait.hostname
OS NametraitName that the operating system is known asTrait.osname
OS VersiontraitVersion of the operating systemTrait.osversion
ArchitecturetraitHardware architecture of the platformTrait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.33. Metrics

NameDescription
Run AutodiscoveryRun an immediate discovery to search for new resources
View Process ListView running processes on this system

Package Types

none

1.3.1. Platforms - Process Service

Overview

Table 1.34. Overview

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

Child Resource Types

none

Connection Properties

Table 1.35. 

NameDescriptionRequiredInternal Name
TypeChoice of using a pid file or a PIQL query to find the process to monitor yes type
Pid FileFully qualified path to the pid file for the process to monitor no pidFile
PiqlProcess Information Query Language for process to monitor no piql
Full Process TreeIf 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.36. Metrics

NameTypeDescriptionInternal Name
User TimemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
User Time per MinutemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
Kernel TimemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
Kernel Time per MinutemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
CPU PercentagemeasurementThe percentage of CPU currently being used by all processesProcess.cpu.percent
Physical MemorymeasurementThe aggregate amount of resident memory used by all processesProcess.memory.resident
Virtual MemorymeasurementThe aggregate amount of virtual memory used by all processesProcess.memory.size
Open File DescriptorsmeasurementThe aggregate number of file descriptors open by all processesProcess.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

1.3.2. Platforms - File System Service

Overview

Table 1.37. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.38. Metrics

NameTypeDescriptionInternal Name
Free SpacemeasurementThe total free bytes on filesystemfileSystemUsage.free
Used PercentagemeasurementThe percentage of disk usedfileSystemUsage.usePercent
CapacitytraitThe total size of the filesystemfileSystemUsage.total
Volume TypetraitThe filesystem's generic type namefileSystem.typeName
Drive TypetraitThe filesystem's operating system-specific type namefileSystem.sysTypeName
nametraitThe name of this devicefileSystem.devName
Free FilesmeasurementThe number of free file nodes on the filesystemfileSystemUsage.freeFiles
FlagstraitThe filesystem's flagsfileSystem.flags
UsedmeasurementThe total bytes used on the filesystemfileSystemUsage.used
Disk ReadsmeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk Reads per MinutemeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk WritesmeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Writes per MinutemeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Read BytesmeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Read Bytes per MinutemeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Write BytesmeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk Write Bytes per MinutemeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk QueuemeasurementThe number of I/Os currently in progressfileSystemUsage.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.3.3. Platforms - Directory Service

Overview

Table 1.39. Overview

Description:Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

Table 1.40. 

NameDescriptionRequiredInternal Name
PathDirectory to monitor. / is not allowed. yes path

Note

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

Metrics

Table 1.41. Metrics

NameTypeDescriptionInternal Name
Directory usagemeasurementDisk usage of this directoryusage
Number of filesmeasurementNumber of files in the directoryfiles
Number of itemsmeasurementNumber of items in the directory (files, subdirs, symlinks)total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.3.4. Platforms - Network Adapter Service

Overview

Table 1.42. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.43. Metrics

NameTypeDescriptionInternal Name
Inet4AddresstraitIP address of the network adapterTrait.net4.address
Interface FlagstraitFlag constants for network related operationsTrait.interfaceFlags
Bytes ReceivedmeasurementThe total number of bytes received across this network interface since it startedrxBytes
Bytes Received per MinutemeasurementThe total number of bytes received across this network interface since it startedrxBytes
Packets ReceivedmeasurementThe total number of packets received across this network interface since it startedrxPackets
Packets Received per MinutemeasurementThe total number of packets received across this network interface since it startedrxPackets
Bytes TransmittedmeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Bytes Transmitted per MinutemeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Packets TransmittedmeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Packets Transmitted per MinutemeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Receive Errorsmeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Errors per Minutemeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Packets Droppedmeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Packets Dropped per Minutemeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Overrurnsmeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Overrurns per Minutemeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Framemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Receive Frame per Minutemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Transmit Errorsmeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Errors per Minutemeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Packets Droppedmeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Packets Dropped per Minutemeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Overrunsmeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Overruns per Minutemeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Collisionsmeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Collisions per Minutemeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Carriermeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier
Transmit Carrier per Minutemeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.3.5. Platforms - CPU Service

Overview

Table 1.44. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.45. Metrics

NameTypeDescriptionInternal Name
IdlemeasurementIdle percentage of this CPUCpuPerc.idle
System LoadmeasurementPercentage of this CPU running in system modeCpuPerc.sys
User LoadmeasurementPercentage of this CPU running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of this CPU waiting on I/OCpuPerc.wait
User TimemeasurementThe total system CPU user timeCpu.user
User Time per MinutemeasurementThe total system CPU user timeCpu.user
Nice TimemeasurementThe total system CPU nice timeCpu.nice
Nice Time per MinutemeasurementThe total system CPU nice timeCpu.nice
System TimemeasurementThe total system CPU kernel timeCpu.sys
System Time per MinutemeasurementThe total system CPU kernel timeCpu.sys
Idle TimemeasurementThe total system CPU idle timeCpu.idle
Idle Time per MinutemeasurementThe total system CPU idle timeCpu.idle
Wait TimemeasurementThe total system CPU I/O wait timeCpu.wait
Wait Time per MinutemeasurementThe total system CPU I/O wait timeCpu.wait
VendortraitVendor of this CPUCpuTrait.vendor
CPU ModeltraitModel of this CPUCpuTrait.model
CPU SpeedtraitSpeed of this CPU in MhzCpuTrait.mhz
Cache sizetraitCache Size of this CPUCpuTrait.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.4. Platforms - Java Platform

Overview

Table 1.46. Overview

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

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.47. Metrics

NameTypeDescriptionInternal Name
HostnametraitName that this platform is known asTrait.hostname
OS NametraitName that the operating system is known asTrait.osname
OS VersiontraitVersion of the operating systemTrait.osversion
ArchitecturetraitHardware architecture of the platformTrait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.48. Metrics

NameDescription
Run AutodiscoveryRun an immediate discovery to search for new resources
View Process ListView running processes on this system

Package Types

none

1.5. Platforms - Linux Platform

Overview

Table 1.49. Overview

Description:Linux Operating System
Singleton: no
Plugin:Platforms

Child Resource Types

Connection Properties

Table 1.50. 

NameDescriptionRequiredInternal Name
Enable Content DiscoveryIf true, attempts will be made to discover installed packages on this platform yes enableContentDiscovery
Enable Internal Yum ServerIf true, an internal yum server will be started in order to process yum content requests made on the local machine. yes enableInternalYumServer
Yum server portThe 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 TimeoutThe 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.51. Metrics

NameTypeDescriptionInternal Name
Free MemorymeasurementThe total free system memory (does not include buffer or cache memory)Native.MemoryInfo.free
Actual Free MemorymeasurementThe actual total free system memory (includes unallocated memory as well as available buffer and cache memory)Native.MemoryInfo.actualFree
Used MemorymeasurementThe total used system memory (does not include buffer or cache memory)Native.MemoryInfo.used
Actual Used MemorymeasurementThe actual total used system memory (includes buffer and cache memory)Native.MemoryInfo.actualUsed
Total MemorymeasurementThe total system memoryNative.MemoryInfo.total
Free Swap SpacemeasurementThe total free system swapNative.SwapInfo.free
Used Swap SpacemeasurementThe total used system swapNative.SwapInfo.used
Total Swap SpacemeasurementThe total system swapNative.SwapInfo.total
IdlemeasurementIdle percentage of all CPUsCpuPerc.idle
System LoadmeasurementPercentage of all CPUs running in system modeCpuPerc.sys
User LoadmeasurementPercentage of all CPUs running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of all CPUs waiting on I/OCpuPerc.wait
HostnametraitName that this platform is known asTrait.hostname
OS NametraitName that the operating system is known asTrait.osname
OS VersiontraitVersion of the operating systemTrait.osversion
ArchitecturetraitHardware architecture of the platformTrait.sysarch
Distribution Nametraitname of the Linux distributiondistro.name
Distribution Versiontraitversion of the Linux distributiondistro.version

Note

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

Configuration Properties

none

Operations

Table 1.52. Metrics

NameDescription
Run AutodiscoveryRun an immediate discovery to search for new resources
View Process ListView running processes on this system
Clean Yum Metadata CacheDeletes all cached package metadata

Package Types

Table 1.53. Package Types

NameCategoryDescription
RPM FileDeployableRed Hat installable package

1.5.1. Platforms - Process Service

Overview

Table 1.54. Overview

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

Child Resource Types

none

Connection Properties

Table 1.55. 

NameDescriptionRequiredInternal Name
TypeChoice of using a pid file or a PIQL query to find the process to monitor yes type
Pid FileFully qualified path to the pid file for the process to monitor no pidFile
PiqlProcess Information Query Language for process to monitor no piql
Full Process TreeIf 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.56. Metrics

NameTypeDescriptionInternal Name
User TimemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
User Time per MinutemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
Kernel TimemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
Kernel Time per MinutemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
CPU PercentagemeasurementThe percentage of CPU currently being used by all processesProcess.cpu.percent
Physical MemorymeasurementThe aggregate amount of resident memory used by all processesProcess.memory.resident
Virtual MemorymeasurementThe aggregate amount of virtual memory used by all processesProcess.memory.size
Open File DescriptorsmeasurementThe aggregate number of file descriptors open by all processesProcess.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

1.5.2. Platforms - File System Service

Overview

Table 1.57. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.58. Metrics

NameTypeDescriptionInternal Name
Free SpacemeasurementThe total free bytes on filesystemfileSystemUsage.free
Used PercentagemeasurementThe percentage of disk usedfileSystemUsage.usePercent
CapacitytraitThe total size of the filesystemfileSystemUsage.total
Volume TypetraitThe filesystem's generic type namefileSystem.typeName
Drive TypetraitThe filesystem's operating system-specific type namefileSystem.sysTypeName
nametraitThe name of this devicefileSystem.devName
Free FilesmeasurementThe number of free file nodes on the filesystemfileSystemUsage.freeFiles
FlagstraitThe filesystem's flagsfileSystem.flags
UsedmeasurementThe total bytes used on the filesystemfileSystemUsage.used
Disk ReadsmeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk Reads per MinutemeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk WritesmeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Writes per MinutemeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Read BytesmeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Read Bytes per MinutemeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Write BytesmeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk Write Bytes per MinutemeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk QueuemeasurementThe number of I/Os currently in progressfileSystemUsage.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.5.3. Platforms - Directory Service

Overview

Table 1.59. Overview

Description:Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

Table 1.60. 

NameDescriptionRequiredInternal Name
PathDirectory to monitor. / is not allowed. yes path

Note

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

Metrics

Table 1.61. Metrics

NameTypeDescriptionInternal Name
Directory usagemeasurementDisk usage of this directoryusage
Number of filesmeasurementNumber of files in the directoryfiles
Number of itemsmeasurementNumber of items in the directory (files, subdirs, symlinks)total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.5.4. Platforms - Network Adapter Service

Overview

Table 1.62. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.63. Metrics

NameTypeDescriptionInternal Name
Inet4AddresstraitIP address of the network adapterTrait.net4.address
Interface FlagstraitFlag constants for network related operationsTrait.interfaceFlags
Bytes ReceivedmeasurementThe total number of bytes received across this network interface since it startedrxBytes
Bytes Received per MinutemeasurementThe total number of bytes received across this network interface since it startedrxBytes
Packets ReceivedmeasurementThe total number of packets received across this network interface since it startedrxPackets
Packets Received per MinutemeasurementThe total number of packets received across this network interface since it startedrxPackets
Bytes TransmittedmeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Bytes Transmitted per MinutemeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Packets TransmittedmeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Packets Transmitted per MinutemeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Receive Errorsmeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Errors per Minutemeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Packets Droppedmeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Packets Dropped per Minutemeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Overrurnsmeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Overrurns per Minutemeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Framemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Receive Frame per Minutemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Transmit Errorsmeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Errors per Minutemeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Packets Droppedmeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Packets Dropped per Minutemeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Overrunsmeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Overruns per Minutemeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Collisionsmeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Collisions per Minutemeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Carriermeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier
Transmit Carrier per Minutemeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.5.5. Platforms - CPU Service

Overview

Table 1.64. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.65. Metrics

NameTypeDescriptionInternal Name
IdlemeasurementIdle percentage of this CPUCpuPerc.idle
System LoadmeasurementPercentage of this CPU running in system modeCpuPerc.sys
User LoadmeasurementPercentage of this CPU running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of this CPU waiting on I/OCpuPerc.wait
User TimemeasurementThe total system CPU user timeCpu.user
User Time per MinutemeasurementThe total system CPU user timeCpu.user
Nice TimemeasurementThe total system CPU nice timeCpu.nice
Nice Time per MinutemeasurementThe total system CPU nice timeCpu.nice
System TimemeasurementThe total system CPU kernel timeCpu.sys
System Time per MinutemeasurementThe total system CPU kernel timeCpu.sys
Idle TimemeasurementThe total system CPU idle timeCpu.idle
Idle Time per MinutemeasurementThe total system CPU idle timeCpu.idle
Wait TimemeasurementThe total system CPU I/O wait timeCpu.wait
Wait Time per MinutemeasurementThe total system CPU I/O wait timeCpu.wait
VendortraitVendor of this CPUCpuTrait.vendor
CPU ModeltraitModel of this CPUCpuTrait.model
CPU SpeedtraitSpeed of this CPU in MhzCpuTrait.mhz
Cache sizetraitCache Size of this CPUCpuTrait.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.6. Platforms - Mac OS X Platform

Overview

Table 1.66. Overview

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

Child Resource Types

Connection Properties

Table 1.67. 

NameDescriptionRequiredInternal Name
Logs  yes logs

Note

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

Metrics

Table 1.68. Metrics

NameTypeDescriptionInternal Name
Free MemorymeasurementThe total free system memory (does not include buffer or cache memory)Native.MemoryInfo.free
Actual Free MemorymeasurementThe actual total free system memory (includes unallocated memory as well as available buffer and cache memory)Native.MemoryInfo.actualFree
Used MemorymeasurementThe total used system memory (does not include buffer or cache memory)Native.MemoryInfo.used
Actual Used MemorymeasurementThe actual total used system memory (includes buffer and cache memory)Native.MemoryInfo.actualUsed
Total MemorymeasurementThe total system memoryNative.MemoryInfo.total
Free Swap SpacemeasurementThe total free system swapNative.SwapInfo.free
Used Swap SpacemeasurementThe total used system swapNative.SwapInfo.used
Total Swap SpacemeasurementThe total system swapNative.SwapInfo.total
IdlemeasurementIdle percentage of all CPUsCpuPerc.idle
System LoadmeasurementPercentage of all CPUs running in system modeCpuPerc.sys
User LoadmeasurementPercentage of all CPUs running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of all CPUs waiting on I/OCpuPerc.wait
HostnametraitName that this platform is known asTrait.hostname
OS NametraitName that the operating system is known asTrait.osname
OS VersiontraitVersion of the operating systemTrait.osversion
ArchitecturetraitHardware architecture of the platformTrait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.69. Metrics

NameDescription
Run AutodiscoveryRun an immediate discovery to search for new resources
View Process ListView running processes on this system

Package Types

none

1.6.1. Platforms - Process Service

Overview

Table 1.70. Overview

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

Child Resource Types

none

Connection Properties

Table 1.71. 

NameDescriptionRequiredInternal Name
TypeChoice of using a pid file or a PIQL query to find the process to monitor yes type
Pid FileFully qualified path to the pid file for the process to monitor no pidFile
PiqlProcess Information Query Language for process to monitor no piql
Full Process TreeIf 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.72. Metrics

NameTypeDescriptionInternal Name
User TimemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
User Time per MinutemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
Kernel TimemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
Kernel Time per MinutemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
CPU PercentagemeasurementThe percentage of CPU currently being used by all processesProcess.cpu.percent
Physical MemorymeasurementThe aggregate amount of resident memory used by all processesProcess.memory.resident
Virtual MemorymeasurementThe aggregate amount of virtual memory used by all processesProcess.memory.size
Open File DescriptorsmeasurementThe aggregate number of file descriptors open by all processesProcess.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

1.6.2. Platforms - File System Service

Overview

Table 1.73. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.74. Metrics

NameTypeDescriptionInternal Name
Free SpacemeasurementThe total free bytes on filesystemfileSystemUsage.free
Used PercentagemeasurementThe percentage of disk usedfileSystemUsage.usePercent
CapacitytraitThe total size of the filesystemfileSystemUsage.total
Volume TypetraitThe filesystem's generic type namefileSystem.typeName
Drive TypetraitThe filesystem's operating system-specific type namefileSystem.sysTypeName
nametraitThe name of this devicefileSystem.devName
Free FilesmeasurementThe number of free file nodes on the filesystemfileSystemUsage.freeFiles
FlagstraitThe filesystem's flagsfileSystem.flags
UsedmeasurementThe total bytes used on the filesystemfileSystemUsage.used
Disk ReadsmeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk Reads per MinutemeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk WritesmeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Writes per MinutemeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Read BytesmeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Read Bytes per MinutemeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Write BytesmeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk Write Bytes per MinutemeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk QueuemeasurementThe number of I/Os currently in progressfileSystemUsage.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.6.3. Platforms - Directory Service

Overview

Table 1.75. Overview

Description:Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

Table 1.76. 

NameDescriptionRequiredInternal Name
PathDirectory to monitor. / is not allowed. yes path

Note

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

Metrics

Table 1.77. Metrics

NameTypeDescriptionInternal Name
Directory usagemeasurementDisk usage of this directoryusage
Number of filesmeasurementNumber of files in the directoryfiles
Number of itemsmeasurementNumber of items in the directory (files, subdirs, symlinks)total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.6.4. Platforms - Network Adapter Service

Overview

Table 1.78. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.79. Metrics

NameTypeDescriptionInternal Name
Inet4AddresstraitIP address of the network adapterTrait.net4.address
Interface FlagstraitFlag constants for network related operationsTrait.interfaceFlags
Bytes ReceivedmeasurementThe total number of bytes received across this network interface since it startedrxBytes
Bytes Received per MinutemeasurementThe total number of bytes received across this network interface since it startedrxBytes
Packets ReceivedmeasurementThe total number of packets received across this network interface since it startedrxPackets
Packets Received per MinutemeasurementThe total number of packets received across this network interface since it startedrxPackets
Bytes TransmittedmeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Bytes Transmitted per MinutemeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Packets TransmittedmeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Packets Transmitted per MinutemeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Receive Errorsmeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Errors per Minutemeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Packets Droppedmeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Packets Dropped per Minutemeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Overrurnsmeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Overrurns per Minutemeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Framemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Receive Frame per Minutemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Transmit Errorsmeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Errors per Minutemeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Packets Droppedmeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Packets Dropped per Minutemeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Overrunsmeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Overruns per Minutemeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Collisionsmeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Collisions per Minutemeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Carriermeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier
Transmit Carrier per Minutemeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.6.5. Platforms - CPU Service

Overview

Table 1.80. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.81. Metrics

NameTypeDescriptionInternal Name
IdlemeasurementIdle percentage of this CPUCpuPerc.idle
System LoadmeasurementPercentage of this CPU running in system modeCpuPerc.sys
User LoadmeasurementPercentage of this CPU running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of this CPU waiting on I/OCpuPerc.wait
User TimemeasurementThe total system CPU user timeCpu.user
User Time per MinutemeasurementThe total system CPU user timeCpu.user
Nice TimemeasurementThe total system CPU nice timeCpu.nice
Nice Time per MinutemeasurementThe total system CPU nice timeCpu.nice
System TimemeasurementThe total system CPU kernel timeCpu.sys
System Time per MinutemeasurementThe total system CPU kernel timeCpu.sys
Idle TimemeasurementThe total system CPU idle timeCpu.idle
Idle Time per MinutemeasurementThe total system CPU idle timeCpu.idle
Wait TimemeasurementThe total system CPU I/O wait timeCpu.wait
Wait Time per MinutemeasurementThe total system CPU I/O wait timeCpu.wait
VendortraitVendor of this CPUCpuTrait.vendor
CPU ModeltraitModel of this CPUCpuTrait.model
CPU SpeedtraitSpeed of this CPU in MhzCpuTrait.mhz
Cache sizetraitCache Size of this CPUCpuTrait.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.7. Platforms - Solaris Platform

Overview

Table 1.82. Overview

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

Child Resource Types

Connection Properties

Table 1.83. 

NameDescriptionRequiredInternal Name
Logs  yes logs

Note

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

Metrics

Table 1.84. Metrics

NameTypeDescriptionInternal Name
Free MemorymeasurementThe total free system memory (does not include buffer or cache memory)Native.MemoryInfo.free
Actual Free MemorymeasurementThe actual total free system memory (includes unallocated memory as well as available buffer and cache memory)Native.MemoryInfo.actualFree
Used MemorymeasurementThe total used system memory (does not include buffer or cache memory)Native.MemoryInfo.used
Actual Used MemorymeasurementThe actual total used system memory (includes buffer and cache memory)Native.MemoryInfo.actualUsed
Total MemorymeasurementThe total system memoryNative.MemoryInfo.total
Free Swap SpacemeasurementThe total free system swapNative.SwapInfo.free
Used Swap SpacemeasurementThe total used system swapNative.SwapInfo.used
Total Swap SpacemeasurementThe total system swapNative.SwapInfo.total
IdlemeasurementIdle percentage of all CPUsCpuPerc.idle
System LoadmeasurementPercentage of all CPUs running in system modeCpuPerc.sys
User LoadmeasurementPercentage of all CPUs running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of all CPUs waiting on I/OCpuPerc.wait
HostnametraitName that this platform is known asTrait.hostname
OS NametraitName that the operating system is known asTrait.osname
OS VersiontraitVersion of the operating systemTrait.osversion
ArchitecturetraitHardware architecture of the platformTrait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.85. Metrics

NameDescription
Run AutodiscoveryRun an immediate discovery to search for new resources
View Process ListView running processes on this system

Package Types

none

1.7.1. Platforms - Process Service

Overview

Table 1.86. Overview

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

Child Resource Types

none

Connection Properties

Table 1.87. 

NameDescriptionRequiredInternal Name
TypeChoice of using a pid file or a PIQL query to find the process to monitor yes type
Pid FileFully qualified path to the pid file for the process to monitor no pidFile
PiqlProcess Information Query Language for process to monitor no piql
Full Process TreeIf 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.88. Metrics

NameTypeDescriptionInternal Name
User TimemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
User Time per MinutemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
Kernel TimemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
Kernel Time per MinutemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
CPU PercentagemeasurementThe percentage of CPU currently being used by all processesProcess.cpu.percent
Physical MemorymeasurementThe aggregate amount of resident memory used by all processesProcess.memory.resident
Virtual MemorymeasurementThe aggregate amount of virtual memory used by all processesProcess.memory.size
Open File DescriptorsmeasurementThe aggregate number of file descriptors open by all processesProcess.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

1.7.2. Platforms - File System Service

Overview

Table 1.89. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.90. Metrics

NameTypeDescriptionInternal Name
Free SpacemeasurementThe total free bytes on filesystemfileSystemUsage.free
Used PercentagemeasurementThe percentage of disk usedfileSystemUsage.usePercent
CapacitytraitThe total size of the filesystemfileSystemUsage.total
Volume TypetraitThe filesystem's generic type namefileSystem.typeName
Drive TypetraitThe filesystem's operating system-specific type namefileSystem.sysTypeName
nametraitThe name of this devicefileSystem.devName
Free FilesmeasurementThe number of free file nodes on the filesystemfileSystemUsage.freeFiles
FlagstraitThe filesystem's flagsfileSystem.flags
UsedmeasurementThe total bytes used on the filesystemfileSystemUsage.used
Disk ReadsmeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk Reads per MinutemeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk WritesmeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Writes per MinutemeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Read BytesmeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Read Bytes per MinutemeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Write BytesmeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk Write Bytes per MinutemeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk QueuemeasurementThe number of I/Os currently in progressfileSystemUsage.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.7.3. Platforms - Directory Service

Overview

Table 1.91. Overview

Description:Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

Table 1.92. 

NameDescriptionRequiredInternal Name
PathDirectory to monitor. / is not allowed. yes path

Note

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

Metrics

Table 1.93. Metrics

NameTypeDescriptionInternal Name
Directory usagemeasurementDisk usage of this directoryusage
Number of filesmeasurementNumber of files in the directoryfiles
Number of itemsmeasurementNumber of items in the directory (files, subdirs, symlinks)total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.7.4. Platforms - Network Adapter Service

Overview

Table 1.94. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.95. Metrics

NameTypeDescriptionInternal Name
Inet4AddresstraitIP address of the network adapterTrait.net4.address
Interface FlagstraitFlag constants for network related operationsTrait.interfaceFlags
Bytes ReceivedmeasurementThe total number of bytes received across this network interface since it startedrxBytes
Bytes Received per MinutemeasurementThe total number of bytes received across this network interface since it startedrxBytes
Packets ReceivedmeasurementThe total number of packets received across this network interface since it startedrxPackets
Packets Received per MinutemeasurementThe total number of packets received across this network interface since it startedrxPackets
Bytes TransmittedmeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Bytes Transmitted per MinutemeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Packets TransmittedmeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Packets Transmitted per MinutemeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Receive Errorsmeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Errors per Minutemeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Packets Droppedmeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Packets Dropped per Minutemeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Overrurnsmeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Overrurns per Minutemeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Framemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Receive Frame per Minutemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Transmit Errorsmeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Errors per Minutemeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Packets Droppedmeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Packets Dropped per Minutemeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Overrunsmeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Overruns per Minutemeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Collisionsmeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Collisions per Minutemeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Carriermeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier
Transmit Carrier per Minutemeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.7.5. Platforms - CPU Service

Overview

Table 1.96. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.97. Metrics

NameTypeDescriptionInternal Name
IdlemeasurementIdle percentage of this CPUCpuPerc.idle
System LoadmeasurementPercentage of this CPU running in system modeCpuPerc.sys
User LoadmeasurementPercentage of this CPU running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of this CPU waiting on I/OCpuPerc.wait
User TimemeasurementThe total system CPU user timeCpu.user
User Time per MinutemeasurementThe total system CPU user timeCpu.user
Nice TimemeasurementThe total system CPU nice timeCpu.nice
Nice Time per MinutemeasurementThe total system CPU nice timeCpu.nice
System TimemeasurementThe total system CPU kernel timeCpu.sys
System Time per MinutemeasurementThe total system CPU kernel timeCpu.sys
Idle TimemeasurementThe total system CPU idle timeCpu.idle
Idle Time per MinutemeasurementThe total system CPU idle timeCpu.idle
Wait TimemeasurementThe total system CPU I/O wait timeCpu.wait
Wait Time per MinutemeasurementThe total system CPU I/O wait timeCpu.wait
VendortraitVendor of this CPUCpuTrait.vendor
CPU ModeltraitModel of this CPUCpuTrait.model
CPU SpeedtraitSpeed of this CPU in MhzCpuTrait.mhz
Cache sizetraitCache Size of this CPUCpuTrait.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.8. Platforms - Windows Platform

Overview

Table 1.98. Overview

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

Child Resource Types

Connection Properties

Table 1.99. 

NameDescriptionRequiredInternal Name
Enable Content DiscoveryIf true, attempts will be made to discover installed packages on this platform yes enableContentDiscovery
Event Tracking EnabledEnables the collection of Windows events into the event subsystem yes eventTrackingEnabled
Regular ExpressionA regular expression that if not-null must be matched by the event detail for the message to be accepted no regularExpression
Minimum SeverityThe 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.100. Metrics

NameTypeDescriptionInternal Name
Free MemorymeasurementThe total free system memory (does not include buffer or cache memory)Native.MemoryInfo.free
Actual Free MemorymeasurementThe actual total free system memory (includes unallocated memory as well as available buffer and cache memory)Native.MemoryInfo.actualFree
Used MemorymeasurementThe total used system memory (does not include buffer or cache memory)Native.MemoryInfo.used
Actual Used MemorymeasurementThe actual total used system memory (includes buffer and cache memory)Native.MemoryInfo.actualUsed
Total MemorymeasurementThe total system memoryNative.MemoryInfo.total
Free Swap SpacemeasurementThe total free system swapNative.SwapInfo.free
Used Swap SpacemeasurementThe total used system swapNative.SwapInfo.used
Total Swap SpacemeasurementThe total system swapNative.SwapInfo.total
IdlemeasurementIdle percentage of all CPUsCpuPerc.idle
System LoadmeasurementPercentage of all CPUs running in system modeCpuPerc.sys
User LoadmeasurementPercentage of all CPUs running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of all CPUs waiting on I/OCpuPerc.wait
HostnametraitName that this platform is known asTrait.hostname
OS NametraitName that the operating system is known asTrait.osname
OS VersiontraitVersion of the operating systemTrait.osversion
ArchitecturetraitHardware architecture of the platformTrait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.101. Metrics

NameDescription
Run AutodiscoveryRun an immediate discovery to search for new resources
View Process ListView running processes on this system

Package Types

Table 1.102. Package Types

NameCategoryDescription
Installed SoftwareDeployableInstalled Windows Software

1.8.1. Platforms - Process Service

Overview

Table 1.103. Overview

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

Child Resource Types

none

Connection Properties

Table 1.104. 

NameDescriptionRequiredInternal Name
TypeChoice of using a pid file or a PIQL query to find the process to monitor yes type
Pid FileFully qualified path to the pid file for the process to monitor no pidFile
PiqlProcess Information Query Language for process to monitor no piql
Full Process TreeIf 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.105. Metrics

NameTypeDescriptionInternal Name
User TimemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
User Time per MinutemeasurementThe aggregate amount of CPU user time spent by all processesProcess.cpu.user
Kernel TimemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
Kernel Time per MinutemeasurementThe aggregate amount of CPU kernel time spent by all processesProcess.cpu.sys
CPU PercentagemeasurementThe percentage of CPU currently being used by all processesProcess.cpu.percent
Physical MemorymeasurementThe aggregate amount of resident memory used by all processesProcess.memory.resident
Virtual MemorymeasurementThe aggregate amount of virtual memory used by all processesProcess.memory.size
Open File DescriptorsmeasurementThe aggregate number of file descriptors open by all processesProcess.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

1.8.2. Platforms - File System Service

Overview

Table 1.106. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.107. Metrics

NameTypeDescriptionInternal Name
Free SpacemeasurementThe total free bytes on filesystemfileSystemUsage.free
Used PercentagemeasurementThe percentage of disk usedfileSystemUsage.usePercent
CapacitytraitThe total size of the filesystemfileSystemUsage.total
Volume TypetraitThe filesystem's generic type namefileSystem.typeName
Drive TypetraitThe filesystem's operating system-specific type namefileSystem.sysTypeName
nametraitThe name of this devicefileSystem.devName
Free FilesmeasurementThe number of free file nodes on the filesystemfileSystemUsage.freeFiles
FlagstraitThe filesystem's flagsfileSystem.flags
UsedmeasurementThe total bytes used on the filesystemfileSystemUsage.used
Disk ReadsmeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk Reads per MinutemeasurementThe number of physical disk readsfileSystemUsage.diskReads
Disk WritesmeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Writes per MinutemeasurementThe number of physical disk writesfileSystemUsage.diskWrites
Disk Read BytesmeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Read Bytes per MinutemeasurementThe number of physical disk bytes readfileSystemUsage.diskReadBytes
Disk Write BytesmeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk Write Bytes per MinutemeasurementThe number of physical disk bytes writtenfileSystemUsage.diskWriteBytes
Disk QueuemeasurementThe number of I/Os currently in progressfileSystemUsage.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.8.3. Platforms - Network Adapter Service

Overview

Table 1.108. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.109. Metrics

NameTypeDescriptionInternal Name
Inet4AddresstraitIP address of the network adapterTrait.net4.address
Interface FlagstraitFlag constants for network related operationsTrait.interfaceFlags
Bytes ReceivedmeasurementThe total number of bytes received across this network interface since it startedrxBytes
Bytes Received per MinutemeasurementThe total number of bytes received across this network interface since it startedrxBytes
Packets ReceivedmeasurementThe total number of packets received across this network interface since it startedrxPackets
Packets Received per MinutemeasurementThe total number of packets received across this network interface since it startedrxPackets
Bytes TransmittedmeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Bytes Transmitted per MinutemeasurementThe total number of bytes transmitted across this network interface since it startedtxBytes
Packets TransmittedmeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Packets Transmitted per MinutemeasurementThe total number of packets transmitted across this network interface since it startedtxPackets
Receive Errorsmeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Errors per Minutemeasurement'errors' statistic for received packets across this network interface since it startedrxErrors
Receive Packets Droppedmeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Packets Dropped per Minutemeasurement'dropped' statistic for received packets across this network interface since it startedrxDropped
Receive Overrurnsmeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Overrurns per Minutemeasurement'overruns' statistic for received packets across this network interface since it startedrxOverruns
Receive Framemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Receive Frame per Minutemeasurement'frame' statistic for received packets across this network interface since it startedrxFrame
Transmit Errorsmeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Errors per Minutemeasurement'errors' statistic for transmitted packets across this network interface since it startedtxErrors
Transmit Packets Droppedmeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Packets Dropped per Minutemeasurement'dropped' statistic for transmitted packets across this network interface since it startedtxDropped
Transmit Overrunsmeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Overruns per Minutemeasurement'overruns' statistic for transmitted packets across this network interface since it startedtxOverruns
Transmit Collisionsmeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Collisions per Minutemeasurement'collisions' statistic for transmitted packets across this network interface since it startedtxCollisions
Transmit Carriermeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier
Transmit Carrier per Minutemeasurement'carrier' statistic for transmitted packets across this network interface since it startedtxCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.8.4. Platforms - CPU Service

Overview

Table 1.110. Overview

Description: 
Singleton: no
Plugin:Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.111. Metrics

NameTypeDescriptionInternal Name
IdlemeasurementIdle percentage of this CPUCpuPerc.idle
System LoadmeasurementPercentage of this CPU running in system modeCpuPerc.sys
User LoadmeasurementPercentage of this CPU running in user modeCpuPerc.user
Wait LoadmeasurementPercentage of this CPU waiting on I/OCpuPerc.wait
User TimemeasurementThe total system CPU user timeCpu.user
User Time per MinutemeasurementThe total system CPU user timeCpu.user
Nice TimemeasurementThe total system CPU nice timeCpu.nice
Nice Time per MinutemeasurementThe total system CPU nice timeCpu.nice
System TimemeasurementThe total system CPU kernel timeCpu.sys
System Time per MinutemeasurementThe total system CPU kernel timeCpu.sys
Idle TimemeasurementThe total system CPU idle timeCpu.idle
Idle Time per MinutemeasurementThe total system CPU idle timeCpu.idle
Wait TimemeasurementThe total system CPU I/O wait timeCpu.wait
Wait Time per MinutemeasurementThe total system CPU I/O wait timeCpu.wait
VendortraitVendor of this CPUCpuTrait.vendor
CPU ModeltraitModel of this CPUCpuTrait.model
CPU SpeedtraitSpeed of this CPU in MhzCpuTrait.mhz
Cache sizetraitCache Size of this CPUCpuTrait.cacheSize

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. Core Managed Resources

There are certain server types that are supported by default in JBoss Operations Network, both for JBoss and non-JBoss resource types.

2.1. Apache - HTTP Server

Overview

Table 2.1. Overview

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

Child Resource Types

Autodiscovery Process Scans

Table 2.2. Metrics

NameQuery
HttpdOnWindowsprocess|basename|match=(?i)httpd.exe,process|basename|match|parent=(?i)httpd.exe
ApacheOnWindowsprocess|basename|match=(?i)Apache.exe,process|basename|match|parent=(?i)Apache.exe
HttpdOnUnixprocess|basename|match=httpd.*,process|basename|nomatch|parent=httpd.*
Apache2OnUnixprocess|basename|match=apache2,process|basename|nomatch|parent=apache2

Connection Properties

Table 2.3. 

NameDescriptionRequiredInternal Name
Enable augeas supportEnable augeas support yes augeasEnabled
Augeas Module Namethe name of the Augeas module/lens to use for loading and updating this resource's configuration yes augeasModuleName
Httpd config fileLocation of the Apache main configuration file. yes configurationFilesInclusionPatterns
Virtual Hosts Configuration PlacementHow should the new virtual host definitions be put in the configuration yes vhostCreationPolicy
Path To Contain Virtual Hosts FilesIf 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 PathThe 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 EnabledA flag indicating whether or not generation of Events for new error log entries is enabled. yes errorLogEventsEnabled
Error Log Minimum SeverityThe 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 PatternA 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
Custom Module NamesApache can use 2 values to identify a module. Either its module name that is used in the LoadModule directive or its source file that can be used in the IfModule directive (as of Apache 2.1 the IfModule directive can but doesn't have to use the module name, too). The plugin contains the mappings of the module names to module files for all the standard apache modules mentioned on the http://httpd.apache.org/docs/current/mod/ plus the SNMP module and mod_jk. If you use any non-standard modules and use their source file in the IfModule directives, you have to add the module-name-to-module-file mapping to this list so that the plugin can determine the correct runtime configuration of the apache instance. yes customModuleNames
Server Rootthe absolute path of the Apache server root directory yes serverRoot
Executable Paththe 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 Paththe 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 Filethe 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
URLThe http or https URL that will be used to check availability for this Apache server; if not set, availability will be determined based on whether plugin can connect to the Apache server's SNMP agent. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL. no url
SNMP Agent Hostthe host name or IP address of the Apache SNMP agent (typically '127.0.0.1') no snmpAgentHost
SNMP Agent Portthe UDP port of the Apache SNMP agent (typically '1610') no snmpAgentPort
SNMP Agent Communitythe SNMP community of the Apache SNMP agent (typically 'public') no snmpAgentCommunity
SNMP Request Timeoutthe timeout, in milliseconds, for requests to the Apache SNMP agent; defaults to 2000 no snmpRequestTimeout
SNMP Request Retriesthe number of times a request that has timed out should be retried; defaults to 1 no snmpRequestRetries
Restart After Configuration UpdateIf 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
BMX HandlerIf set to a valid URL to mod_bmx handler allow to use mod_bmx instead of mod_snmp. no bmxUrl

Note

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

Metrics

Table 2.4. Metrics

NameTypeDescriptionInternal Name
Number of Concurrent ConnectionsmeasurementNumber of Concurrent ConnectionsapplInboundAssociations
Server Builttraitthe date and time this Apache server's binary was compiledserverBuilt
Start Timetraitthe date and time this Apache server was last startedwwwServiceStartTime
Time to ping the server for availabilitymeasurementTime 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. 

NameDescriptionRequiredInternal Name
Listen  yes Listen
Name Virtual HostA 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

NameDescription
StartStarts this Apache server, or returns an error if it is already running. The control script used is specified in the Connection Properties.
StopStops this Apache server, or returns an error if it is not running. The control script used is specified in the Connection Properties.
RestartRestarts 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 SupportStarts this Apache server with support for SSL. The control script used is specified in the Connection Properties. Only supported on Apache 1.3.
Restart GracefullyGracefully 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 SyntaxRun 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 configurationTries 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.1.1. Apache - Virtual Host Service

Overview

Table 2.7. Overview

Description: 
Singleton: no
Plugin:Apache

Child Resource Types

Connection Properties

Table 2.8. 

NameDescriptionRequiredInternal Name
Response Time Log Filethe full path to the log file containing response-time stats for this virtual host no responseTimeLogFile
Response Time Url Excludesa space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transformsa 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
URLThe http or https URL that will be used to check availability for this virtual host. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL. If the URL is not set, the availability is determined by pinging the configured SNMP location. no url

Note

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

Metrics

Table 2.9. Metrics

NameTypeDescriptionInternal Name
Hosttraitthe host name or IP address of this virtual hostwwwServiceName
Porttraitthe TCP port of this virtual hostwwwServiceProtocol
Administratortraitthe administrator of this virtual hostwwwServiceContact
Total Number of RequestsmeasurementThe number of inbound requests on the servicewwwSummaryInRequests
Total Number of Requests per MinutemeasurementThe number of inbound requests on the servicewwwSummaryInRequests
Total Number of Bytes ReceivedmeasurementThe number of bytes received by the servicewwwSummaryInLowBytes
Total Number of Bytes Received per MinutemeasurementThe number of bytes received by the servicewwwSummaryInLowBytes
Total Number of ResponsesmeasurementThe number of outbound requests on the servicewwwSummaryOutResponses
Total Number of Responses per MinutemeasurementThe number of outbound requests on the servicewwwSummaryOutResponses
Total Number of Bytes SentmeasurementThe number of bytes sent by the servicewwwSummaryOutLowBytes
Total Number of Bytes Sent per MinutemeasurementThe number of bytes sent by the servicewwwSummaryOutLowBytes
Number of GET RequestsmeasurementThe number of inbound GET requests on the servicewwwRequestInRequests.GET
Number of GET Requests per MinutemeasurementThe number of inbound GET requests on the servicewwwRequestInRequests.GET
Number of HEAD RequestsmeasurementThe number of inbound HEAD requests on the servicewwwRequestInRequests.HEAD
Number of HEAD Requests per MinutemeasurementThe number of inbound HEAD requests on the servicewwwRequestInRequests.HEAD
Number of POST RequestsmeasurementThe number of inbound POST requests on the servicewwwRequestInRequests.POST
Number of POST Requests per MinutemeasurementThe number of inbound POST requests on the servicewwwRequestInRequests.POST
Number of PUT RequestsmeasurementThe number of inbound PUT requests on the servicewwwRequestInRequests.PUT
Number of PUT Requests per MinutemeasurementThe number of inbound PUT requests on the servicewwwRequestInRequests.PUT
Bytes Received for GET RequestsmeasurementThe number of bytes received by GET requests on the servicewwwRequestInBytes.GET
Bytes Received for GET Requests per MinutemeasurementThe number of bytes received by GET requests on the servicewwwRequestInBytes.GET
Bytes Received for HEAD RequestsmeasurementThe number of bytes received by HEAD requests on the servicewwwRequestInBytes.HEAD
Bytes Received for HEAD Requests per MinutemeasurementThe number of bytes received by HEAD requests on the servicewwwRequestInBytes.HEAD
Bytes Received for POST RequestsmeasurementThe number of bytes received by POST requests on the servicewwwRequestInBytes.POST
Bytes Received for POST Requests per MinutemeasurementThe number of bytes received by POST requests on the servicewwwRequestInBytes.POST
Bytes Received for PUT RequestsmeasurementThe number of bytes received by PUT requests on the servicewwwRequestInBytes.PUT
Bytes Received for PUT Requests per MinutemeasurementThe number of bytes received by PUT requests on the servicewwwRequestInBytes.PUT
Number of 200 ResponsesmeasurementThe number of 200 responses generated by this servicewwwResponseOutResponses.200
Number of 200 Responses per MinutemeasurementThe number of 200 responses generated by this servicewwwResponseOutResponses.200
Number of 301 ResponsesmeasurementThe number of 301 responses generated by this servicewwwResponseOutResponses.301
Number of 301 Responses per MinutemeasurementThe number of 301 responses generated by this servicewwwResponseOutResponses.301
Number of 302 ResponsesmeasurementThe number of 302 responses generated by this servicewwwResponseOutResponses.302
Number of 302 Responses per MinutemeasurementThe number of 302 responses generated by this servicewwwResponseOutResponses.302
Number of 401 ResponsesmeasurementThe number of 401 responses generated by this servicewwwResponseOutResponses.401
Number of 401 Responses per MinutemeasurementThe number of 401 responses generated by this servicewwwResponseOutResponses.401
Number of 403 ResponsesmeasurementThe number of 403 responses generated by this servicewwwResponseOutResponses.403
Number of 403 Responses per MinutemeasurementThe number of 403 responses generated by this servicewwwResponseOutResponses.403
Number of 404 ResponsesmeasurementThe number of 404 responses generated by this servicewwwResponseOutResponses.404
Number of 404 Responses per MinutemeasurementThe number of 404 responses generated by this servicewwwResponseOutResponses.404
Number of 500 ResponsesmeasurementThe number of 500 responses generated by this servicewwwResponseOutResponses.500
Number of 500 Responses per MinutemeasurementThe number of 500 responses generated by this servicewwwResponseOutResponses.500
Bytes Sent for 200 ResponsesmeasurementThe number of bytes sent for 200 responses generated by this servicewwwResponseOutBytes.200
Bytes Sent for 200 Responses per MinutemeasurementThe number of bytes sent for 200 responses generated by this servicewwwResponseOutBytes.200
Bytes Sent for 301 ResponsesmeasurementThe number of bytes sent for 301 responses generated by this servicewwwResponseOutBytes.301
Bytes Sent for 301 Responses per MinutemeasurementThe number of bytes sent for 301 responses generated by this servicewwwResponseOutBytes.301
Bytes Sent for 302 ResponsesmeasurementThe number of bytes sent for 302 responses generated by this servicewwwResponseOutBytes.302
Bytes Sent for 302 Responses per MinutemeasurementThe number of bytes sent for 302 responses generated by this servicewwwResponseOutBytes.302
Bytes Sent for 401 ResponsesmeasurementThe number of bytes sent for 401 responses generated by this servicewwwResponseOutBytes.401
Bytes Sent for 401 Responses per MinutemeasurementThe number of bytes sent for 401 responses generated by this servicewwwResponseOutBytes.401
Bytes Sent for 403 ResponsesmeasurementThe number of bytes sent for 403 responses generated by this servicewwwResponseOutBytes.403
Bytes Sent for 403 Responses per MinutemeasurementThe number of bytes sent for 403 responses generated by this servicewwwResponseOutBytes.403
Bytes Sent for 404 ResponsesmeasurementThe number of bytes sent for 404 responses generated by this servicewwwResponseOutBytes.404
Bytes Sent for 404 Responses per MinutemeasurementThe number of bytes sent for 404 responses generated by this servicewwwResponseOutBytes.404
Bytes Sent for 500 ResponsesmeasurementThe number of bytes sent for 500 responses generated by this servicewwwResponseOutBytes.500
Bytes Sent for 500 Responses per MinutemeasurementThe number of bytes sent for 500 responses generated by this servicewwwResponseOutBytes.500
HTTP Response TimecalltimeThe minimum, maximum, and average response times for HTTP requests serviced by this virtual hostResponseTime

Note

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

Configuration Properties

Table 2.10. 

NameDescriptionRequiredInternal Name
Error LogSets 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 logsConfigure the logging of requests to the server. yes CustomLog
Server NameSets 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 AdminThe 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 RootThis 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 CharsetThis 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
AliasThe 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 TypeThere 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 IndexSets 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 DocumentIn 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
TimeoutThe TimeOut directive defines the length of time Apache will wait for I/O in various circumstances. no Timeout
OptionsThe Options directive controls which server features are available in a particular directory. no Options
Use Canonical NameWith 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 PortIn 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.1.1.1. Apache - Directory Service

Overview

Table 2.11. Overview

Description: 
Singleton: no
Plugin:Apache
Child Resource Types
Connection Properties

Table 2.12. 

NameDescriptionRequiredInternal Name
Regular ExpressionDoes 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. 

NameDescriptionRequiredInternal Name
IfModule ConditionsList of modules which must be loaded to use directive configuration. yes IfModules
OrderThe 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
AllowThe 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
DenyThe arguments for the Deny directive are identical to the arguments for the Allow directive. no Deny
Allow Override  no AllowOverride
Add Default CharsetThis 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 TypeThere 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 IndexSets 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 DocumentIn 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
OptionsThe Options directive controls which server features are available in a particular directory. no Options
Use Canonical NameWith 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 PortIn 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.1.1.1.1. Apache - IfModule Parameters Service
Overview

Table 2.14. Overview

Description: 
Singleton: no
Plugin:Apache
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties

Table 2.15. 

NameDescriptionRequiredInternal Name
IfModule ConditionsList of modules which must be loaded to use directive configuration. yes IfModules
OrderThe 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
AllowThe 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
DenyThe arguments for the Deny directive are identical to the arguments for the Allow directive. no Deny
Allow Override  no AllowOverride
Add Default CharsetThis 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 TypeThere 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 IndexSets 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 DocumentIn 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
OptionsThe Options directive controls which server features are available in a particular directory. no Options
Use Canonical NameWith 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 PortIn 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.1.1.2. Apache - IfModule Service

Overview

Table 2.16. Overview

Description: 
Singleton: no
Plugin:Apache
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties

Table 2.17. 

NameDescriptionRequiredInternal Name
IfModule ConditionsList of modules which must be loaded to use directive configuration. yes IfModules
OrderThe 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
AllowThe 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
DenyThe arguments for the Deny directive are identical to the arguments for the Allow directive. no Deny
Allow Override  no AllowOverride
Add Default CharsetThis 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 TypeThere 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 IndexSets 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 DocumentIn 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
OptionsThe Options directive controls which server features are available in a particular directory. no Options
Use Canonical NameWith 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 PortIn 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.1.2. Apache - Mod JK Service

Overview

Table 2.18. Overview

Description:Management of mod_jk
Singleton: yes
Plugin:Apache

Child Resource Types

none

Connection Properties

Table 2.19. 

NameDescriptionRequiredInternal Name
Path to workers.propertiesThe 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 fileThe 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.2. IIS - Server

Important

This plug-in is deprecated in JBoss ON 3.3 and will be removed in a future release.

Overview

Table 2.20. Overview

Description:IIS Web Server
Singleton: no
Plugin:IIS

Child Resource Types

Autodiscovery Process Scans

none

Connection Properties

none

Metrics

Table 2.21. Metrics

NameTypeDescriptionInternal Name
Bytes SentmeasurementShows the rate that data bytes are sent by the Web service.Bytes Sent/sec
Bytes Sent per MinutemeasurementShows the rate that data bytes are sent by the Web service.Bytes Sent/sec
Bytes ReceivedmeasurementShows the rate that data bytes are received by the Web service.Bytes Received/sec
Bytes Received per MinutemeasurementShows the rate that data bytes are received by the Web service.Bytes Received/sec
Total Files SentmeasurementShows the total number of files sent by the Web service (counted since service startup).Total Files Sent
Total Files Sent per MinutemeasurementShows the total number of files sent by the Web service (counted since service startup).Total Files Sent
Total Files ReceivedmeasurementShows the total number of files received by the Web service (counted since service startup).Total Files Received
Total Files Received per MinutemeasurementShows the total number of files received by the Web service (counted since service startup).Total Files Received
Total Files TransferredmeasurementShows 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 MinutemeasurementShows 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 UsersmeasurementShows the number of users who currently have an anonymous connection using the Web service.Current Anonymous Users
Current NonAnonymous UsersmeasurementShows the number of users who currently have a non-anonymous connection using the Web service.Current NonAnonymous Users
Total Anonymous UsersmeasurementShows 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 MinutemeasurementShows the total number of users who established an anonymous connection with the Web service (counted since service startup).Total Anonymous Users
Total Non Anonymous UsersmeasurementShows 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 MinutemeasurementShows the total number of users who established a non-anonymous connection with the Web service (counted since service startup).Total NonAnonymous Users
Maximum Anonymous UsersmeasurementShows the maximum number of users who established concurrent anonymous connections using the Web service (counted since service startup).Maximum Anonymous Users
Maximum Non Anonymous UsersmeasurementShows the maximum number of users who established concurrent non-anonymous connections using the Web service (counted since service startup).Maximum NonAnonymous Users
Current ConnectionsmeasurementShows the current number of connections established with the Web service.Current Connections
Maximum ConnectionsmeasurementShows the maximum number of simultaneous connections established with the Web service.Maximum Connections
Total Logon AttemptsmeasurementShows the number of logons that have been attempted using the Web service (counted since service startup).Total Logon Attempts
Total Logon Attempts per MinutemeasurementShows the number of logons that have been attempted using the Web service (counted since service startup).Total Logon Attempts
Total GET RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows the number of HTTP requests using the PUT method (counted since service startup).Total Put Requests
Total PUT Requests per MinutemeasurementShows the number of HTTP requests using the PUT method (counted since service startup).Total Put Requests
Total DELETE RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 MethodsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows the number of all HTTP requests (counted since service startup).Total Method Requests
Total Method Requests per MinutemeasurementShows the number of all HTTP requests (counted since service startup).Total Method Requests
Total CGI RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 ErrorsmeasurementShows 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 MinutemeasurementShows 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 ErrorsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows the current number of CGI requests that are simultaneously being processed by the Web service.Current CGI Requests
Current CGI Requests per MinutemeasurementShows the current number of CGI requests that are simultaneously being processed by the Web service.Current CGI Requests
Current ISAPI Extension RequestsmeasurementShows the current number of Extension requests that are simultaneously being processed by the Web service.Current ISAPI Extension Requests
Maximum CGI RequestsmeasurementShows the maximum number of CGI requests simultaneously processed by the Web service.Maximum CGI Requests
Maximum ISAPI Extension RequestsmeasurementShows the maximum number of Extension requests simultaneously processed by the Web service.Maximum ISAPI Extension Requests
Total Blocked Async I/O RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows current requests that are temporarily blocked due to bandwidth throttling settings.Current Blocked Async I/O Requests
Measured Async I/O Bandwidth UsagemeasurementShows the measured bandwidth of asynchronous I/O averaged over a minute.Measured Async I/O Bandwidth Usage
Total Connection Attempts (all Instances)measurementShows 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 MinutemeasurementShows 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 UptimemeasurementThe amount of time this service has been up forService Uptime

Note

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

Configuration Properties

none

Operations

Table 2.22. Metrics

NameDescription
StartStarts IIS and, if necessary, dependent services
StopShuts down IIS

Package Types

none

2.2.1. IIS - VHost Service

Overview

Table 2.23. Overview

Description:IIS VHost
Singleton: no
Plugin:IIS

Child Resource Types

none

Connection Properties

Table 2.24. 

NameDescriptionRequiredInternal 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 FormatThe 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 Excludesa space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transformsa 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.25. Metrics

NameTypeDescriptionInternal Name
Bytes SentmeasurementShows the rate that data bytes are sent by the Web service.Bytes Sent/sec
Bytes Sent per MinutemeasurementShows the rate that data bytes are sent by the Web service.Bytes Sent/sec
Bytes ReceivedmeasurementShows the rate that data bytes are received by the Web service.Bytes Received/sec
Bytes Received per MinutemeasurementShows the rate that data bytes are received by the Web service.Bytes Received/sec
Total Files SentmeasurementShows the total number of files sent by the Web service (counted since service startup).Total Files Sent
Total Files Sent per MinutemeasurementShows the total number of files sent by the Web service (counted since service startup).Total Files Sent
Total Files ReceivedmeasurementShows the total number of files received by the Web service (counted since service startup).Total Files Received
Total Files Received per MinutemeasurementShows the total number of files received by the Web service (counted since service startup).Total Files Received
Total Files TransferredmeasurementShows 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 MinutemeasurementShows 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 UsersmeasurementShows the number of users who currently have an anonymous connection using the Web service.Current Anonymous Users
Current NonAnonymous UsersmeasurementShows the number of users who currently have a non-anonymous connection using the Web service.Current NonAnonymous Users
Total Anonymous UsersmeasurementShows 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 MinutemeasurementShows the total number of users who established an anonymous connection with the Web service (counted since service startup).Total Anonymous Users
Total Non Anonymous UsersmeasurementShows 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 MinutemeasurementShows the total number of users who established a non-anonymous connection with the Web service (counted since service startup).Total NonAnonymous Users
Maximum Anonymous UsersmeasurementShows the maximum number of users who established concurrent anonymous connections using the Web service (counted since service startup).Maximum Anonymous Users
Maximum Non Anonymous UsersmeasurementShows the maximum number of users who established concurrent non-anonymous connections using the Web service (counted since service startup).Maximum NonAnonymous Users
Current ConnectionsmeasurementShows the current number of connections established with the Web service.Current Connections
Maximum ConnectionsmeasurementShows the maximum number of simultaneous connections established with the Web service.Maximum Connections
Total Logon AttemptsmeasurementShows the number of logons that have been attempted using the Web service (counted since service startup).Total Logon Attempts
Total Logon Attempts per MinutemeasurementShows the number of logons that have been attempted using the Web service (counted since service startup).Total Logon Attempts
Total GET RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows the number of HTTP requests using the PUT method (counted since service startup).Total Put Requests
Total PUT Requests per MinutemeasurementShows the number of HTTP requests using the PUT method (counted since service startup).Total Put Requests
Total DELETE RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 MethodsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows the number of all HTTP requests (counted since service startup).Total Method Requests
Total Method Requests per MinutemeasurementShows the number of all HTTP requests (counted since service startup).Total Method Requests
Total CGI RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 ErrorsmeasurementShows 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 MinutemeasurementShows 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 ErrorsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows the current number of CGI requests that are simultaneously being processed by the Web service.Current CGI Requests
Current CGI Requests per MinutemeasurementShows the current number of CGI requests that are simultaneously being processed by the Web service.Current CGI Requests
Current ISAPI Extension RequestsmeasurementShows the current number of Extension requests that are simultaneously being processed by the Web service.Current ISAPI Extension Requests
Maximum CGI RequestsmeasurementShows the maximum number of CGI requests simultaneously processed by the Web service.Maximum CGI Requests
Maximum ISAPI Extension RequestsmeasurementShows the maximum number of Extension requests simultaneously processed by the Web service.Maximum ISAPI Extension Requests
Total Blocked Async I/O RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows 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 MinutemeasurementShows 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 RequestsmeasurementShows current requests that are temporarily blocked due to bandwidth throttling settings.Current Blocked Async I/O Requests
Measured Async I/O Bandwidth UsagemeasurementShows the measured bandwidth of asynchronous I/O averaged over a minute.Measured Async I/O Bandwidth Usage
HTTP Response Timecalltimethe minimum, maximum, and average response times for HTTP requests serviced by this virtual hostResponseTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

2.3. Postgres - Server

Overview

Table 2.26. Overview

Description:PostgreSQL Server
Singleton: no
Plugin:Postgres

Child Resource Types

Autodiscovery Process Scans

Table 2.27. Metrics

NameQuery
unixprocess|basename|match=^(postgres|postmaster)$,process|basename|nomatch|parent=^(postgres|postmaster)$
windowsprocess|basename|match=^(?i)(postgres|postmaster)\.exe$,process|basename|nomatch|parent=^(?i)(postgres|postmaster)\.exe$

Connection Properties

Table 2.28. 

NameDescriptionRequiredInternal Name
listen hostthe hostname or IP address that the database is listening on yes host
listen portthe TCP port that the database is listening on yes port
database namethe name of the database to connect to yes db
JDBC driver classthe fully-qualified classname of the JDBC driver class no driverClass
role namethe database role to connect as yes principal
role passwordthe password for the database role being used to connect yes credentials
PGDATA directorythe absolute path to the directory containing the cluster configuration files postgresql.conf, pg_hba.conf, and pg_ident.conf yes pgdataDir
configuration filethe absolute path to the main cluster configuration file; default value is '{pgDataDir}/postgresql.conf', where [pgDataDir] is the value of the pgDataDir connection property no configFile

Note

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

Metrics

Table 2.29. Metrics

NameTypeDescriptionInternal Name
User TimemeasurementThe aggregate amount of CPU user time spent by all postgres processesProcess.aggregateCpu.user
User Time per MinutemeasurementThe aggregate amount of CPU user time spent by all postgres processesProcess.aggregateCpu.user
Kernel TimemeasurementThe aggregate amount of CPU kernel time spent by all postgres processesProcess.aggregateCpu.sys
Kernel Time per MinutemeasurementThe aggregate amount of CPU kernel time spent by all postgres processesProcess.aggregateCpu.sys
CPU PercentagemeasurementThe percentage of CPU currently being used by all postgres processesProcess.aggregateCpu.percent
Physical MemorymeasurementThe aggregate amount of resident memory used by all postgres processesProcess.aggregateMemory.resident
Virtual MemorymeasurementThe aggregate amount of virtual memory used by all postgres processesProcess.aggregateMemory.size
Open File DescriptorsmeasurementThe aggregate number of file descriptors open by all postgres processesProcess.aggregateFileDescriptor.total
Active BackendsmeasurementNumber of currently active backends (user connections)Database.backends
Start timetraitStart time of the PostgreSQL database serverDatabase.startTime
Add Missing FromtraitAutomatically adds missing table references to FROM clausesRuntime.add_missing_from
Allow System Table ModstraitAllows modifications of the structure of system tablesRuntime.allow_system_table_mods
Archive CommandtraitWAL archiving commandRuntime.archive_command
Archive TimeouttraitForces a switch to the next xlog file if a new file has not been started within the specified amount of timeRuntime.archive_timeout
Array NullstraitEnable input of NULL elements in arrays.Runtime.array_nulls
Authentication TimeouttraitThe maximum allowed time to complete client authenticationRuntime.authentication_timeout
AutovacuumtraitStarts the autovacuum subprocess.Runtime.autovacuum
Autovacuum Analyze Scale FactortraitNumber of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples.Runtime.autovacuum_analyze_scale_factor
Autovacuum Analyze ThresholdtraitMinimum number of tuple inserts, updates or deletes prior to analyze.Runtime.autovacuum_analyze_threshold
Autovacuum Freeze Max AgetraitAge (in transactions) at which to autovacuum a table to prevent transaction ID wraparound.Runtime.autovacuum_freeze_max_age
Autovacuum NaptimetraitAmount of time to sleep between autovacuum runsRuntime.autovacuum_naptime
Autovacuum Vacuum Cost DelaytraitVacuum cost delay for autovacuumRuntime.autovacuum_vacuum_cost_delay
Autovacuum Vacuum Cost LimittraitVacuum cost amount available before napping, for autovacuum.Runtime.autovacuum_vacuum_cost_limit
Autovacuum Vacuum Scale FactortraitNumber of tuple updates or deletes prior to vacuum as a fraction of reltuples.Runtime.autovacuum_vacuum_scale_factor
Autovacuum Vacuum ThresholdtraitMinimum number of tuple updates or deletes prior to vacuum.Runtime.autovacuum_vacuum_threshold
Backslash QuotetraitWhether quotes are allowed in string literalsRuntime.backslash_quote
Bgwriter All MaxpagestraitBackground writer maximum number of all pages to flush per roundRuntime.bgwriter_all_maxpages
Bgwriter All PercenttraitBackground writer percentage of all buffers to flush per roundRuntime.bgwriter_all_percent
Bgwriter DelaytraitBackground writer sleep time between rounds; default unit is millisecondsRuntime.bgwriter_delay
Bgwriter Lru MaxpagestraitBackground writer maximum number of LRU pages to flush per roundRuntime.bgwriter_lru_maxpages
Bgwriter Lru PercenttraitBackground writer percentage of LRU buffers to flush per roundRuntime.bgwriter_lru_percent
Block SizetraitShows size of a disk block; determined by the value of BLCKSZ when building the server; default unit is bytesRuntime.block_size
Bonjour NametraitThe Bonjour broadcast service nameRuntime.bonjour_name
Check Function BodiestraitCheck function bodies during CREATE FUNCTION.Runtime.check_function_bodies
Checkpoint SegmentstraitThe maximum distance (in log segments) between automatic WAL checkpoints.Runtime.checkpoint_segments
Checkpoint TimeouttraitThe maximum amount of time between automatic WAL checkpoints; default unit is secondsRuntime.checkpoint_timeout
Checkpoint WarningtraitLogs if filling of checkpoint segments happens more frequently than this amount of time; default unit is secondsRuntime.checkpoint_warning
Client EncodingtraitThe client's character set encoding.Runtime.client_encoding
Client Min MessagestraitThe message levels that are sent to the client.Runtime.client_min_messages
Commit DelaytraitThe delay in between transaction commit and flushing WAL to disk; default unit is microsecondsRuntime.commit_delay
Commit SiblingstraitThe minimum concurrent open transactions before performing commit_delay.Runtime.commit_siblings
Config FiletraitThe server's main configuration file.Runtime.config_file
Constraint ExclusiontraitEnables the planner to use constraints to optimize queries.Runtime.constraint_exclusion
Cpu Index Tuple CosttraitThe planner's estimate of the cost of processing each index entry during an index scan; measured on the same scale as the seq_page_cost configuration parameterRuntime.cpu_index_tuple_cost
Cpu Operator CosttraitThe planner's estimate of the cost of processing each operator or function call; measured on the same scale as the seq_page_cost configuration parameterRuntime.cpu_operator_cost
Cpu Tuple CosttraitThe planner's estimate of the cost of processing each tuple (row); measured on the same scale as the seq_page_cost configuration parameterRuntime.cpu_tuple_cost
Custom Variable ClassestraitThe list of known custom variable classesRuntime.custom_variable_classes
Data DirectorytraitThe server's data directory.Runtime.data_directory
DateStyletraitThe display format for date and time values.Runtime.DateStyle
Db User NamespacetraitEnables per-database user names.Runtime.db_user_namespace
Deadlock TimeouttraitThe amount of time to wait on lock before checking for a deadlock; default unit is millisecondsRuntime.deadlock_timeout
Debug AssertionstraitTurns on various assertion checks.Runtime.debug_assertions
Debug Pretty PrinttraitIndents parse and plan tree displays.Runtime.debug_pretty_print
Debug Print ParsetraitPrints the parse tree to the server log.Runtime.debug_print_parse
Debug Print PlantraitPrints the execution plan to server log.Runtime.debug_print_plan
Debug Print RewrittentraitPrints the parse tree after rewriting to server log.Runtime.debug_print_rewritten
Default Statistics TargettraitThe default statistics target; range 1-1000.Runtime.default_statistics_target
Default TablespacetraitThe default tablespace to create tables and indexes in.Runtime.default_tablespace
Default Transaction IsolationtraitThe transaction isolation level of each new transaction.Runtime.default_transaction_isolation
Default Transaction Read OnlytraitThe default read-only status of new transactions.Runtime.default_transaction_read_only
Default With OidstraitCreate new tables with OIDs by default.Runtime.default_with_oids
Dynamic Library PathtraitThe path for dynamically loadable modules.Runtime.dynamic_library_path
Effective Cache SizetraitThe planner's assumption about size of the disk cache; the unit is disk pages, which are normally 8KB eachRuntime.effective_cache_size
Enable BitmapscantraitEnables the planner's use of bitmap-scan plans.Runtime.enable_bitmapscan
Enable HashaggtraitEnables the planner's use of hashed aggregation plans.Runtime.enable_hashagg
Enable HashjointraitEnables the planner's use of hash join plans.Runtime.enable_hashjoin
Enable IndexscantraitEnables the planner's use of index-scan plans.Runtime.enable_indexscan
Enable MergejointraitEnables the planner's use of merge join plans.Runtime.enable_mergejoin
Enable NestlooptraitEnables the planner's use of nested-loop join plans.Runtime.enable_nestloop
Enable SeqscantraitEnables the planner's use of sequential-scan plans.Runtime.enable_seqscan
Enable SorttraitEnables the planner's use of explicit sort steps.Runtime.enable_sort
Enable TidscantraitEnables the planner's use of TID scan plans.Runtime.enable_tidscan
Escape String WarningtraitWarn about backslash escapes in ordinary string literals.Runtime.escape_string_warning
Explain Pretty PrinttraitUses the indented output format for EXPLAIN VERBOSE.Runtime.explain_pretty_print
External Pid FiletraitWrites the postmaster PID to the specified file.Runtime.external_pid_file
Extra Float DigitstraitThe number of extra digits displayed for floating-point values.Runtime.extra_float_digits
From Collapse LimittraitThe FROM-list size beyond which subqueries are not collapsedRuntime.from_collapse_limit
FsynctraitForces synchronization of updates to disk.Runtime.fsync
Full Page WritestraitWrites full pages to WAL when first modified after a checkpoint.Runtime.full_page_writes
GeqotraitEnables genetic query optimizationRuntime.geqo
Geqo EfforttraitGEQO: effort is used to set the default for other GEQO parameters; range 1-10Runtime.geqo_effort
Geqo GenerationstraitGEQO: number of iterations of the algorithm; default selected based on effort.Runtime.geqo_generations
Geqo Pool SizetraitGEQO: number of individuals in the population; default selected based on effort.Runtime.geqo_pool_size
Geqo Selection BiastraitGEQO: selective pressure within the population.Runtime.geqo_selection_bias
Geqo ThresholdtraitThe threshold of FROM items beyond which GEQO is used.Runtime.geqo_threshold
Gin Fuzzy Search LimittraitThe maximum allowed result for exact search by GIN.Runtime.gin_fuzzy_search_limit
Hba FiletraitThe server's hba [configuration file]Runtime.hba_file
Ident FiletraitThe server's ident [configuration file]Runtime.ident_file
Ignore System IndexestraitDisables reading from system indexes.Runtime.ignore_system_indexes
Integer DatetimestraitDatetimes are integer based.Runtime.integer_datetimes
Join Collapse LimittraitThe FROM-list size beyond which JOIN constructs are not flattenedRuntime.join_collapse_limit
Krb Caseins UserstraitWhether Kerberos user names should be treated as case-insensitive.Runtime.krb_caseins_users
Krb Server HostnametraitThe hostname of the Kerberos server.Runtime.krb_server_hostname
Krb Server KeyfiletraitThe location of the Kerberos server key file.Runtime.krb_server_keyfile
Krb SrvnametraitThe name of the Kerberos service.Runtime.krb_srvname
Lc CollatetraitShows the collation order locale.Runtime.lc_collate
Lc CtypetraitShows the character classification and case conversion locale.Runtime.lc_ctype
Lc MessagestraitThe language in which messages are displayed.Runtime.lc_messages
Lc MonetarytraitThe locale for formatting monetary amounts.Runtime.lc_monetary
Lc NumerictraitThe locale for formatting numbers.Runtime.lc_numeric
Lc TimetraitThe locale for formatting date and time values.Runtime.lc_time
Listen AddressestraitThe host name or IP address(es) to listen to.Runtime.listen_addresses
Local Preload LibrariestraitLists shared libraries to preload into each backend.Runtime.local_preload_libraries
Log ConnectionstraitLogs each successful connection.Runtime.log_connections
Log DestinationtraitThe destination for server log output.Runtime.log_destination
Log DirectorytraitThe destination directory for log files.Runtime.log_directory
Log DisconnectionstraitLogs end of a session, including duration.Runtime.log_disconnections
Log DurationtraitLogs the duration of each completed SQL statement.Runtime.log_duration
Log Error VerbositytraitThe verbosity of logged messages.Runtime.log_error_verbosity
Log Executor StatstraitWrites executor performance statistics to the server log.Runtime.log_executor_stats
Log FilenametraitThe file name pattern for log files.Runtime.log_filename
Log HostnametraitLogs the host name in the connection logs.Runtime.log_hostname
Log Line PrefixtraitControls information prefixed to each log lineRuntime.log_line_prefix
Log Min Duration StatementtraitThe minimum execution time (in milliseconds) above which statements will be logged.Runtime.log_min_duration_statement
Log Min Error StatementtraitCauses all statements generating error at or above this level to be logged.Runtime.log_min_error_statement
Log Min MessagestraitThe message levels that are logged.Runtime.log_min_messages
Log Parser StatstraitWrites parser performance statistics to the server log.Runtime.log_parser_stats
Log Planner StatstraitWrites planner performance statistics to the server log.Runtime.log_planner_stats
Log Rotation AgetraitAutomatic log file rotation will occur after this amount of time; default unit is minutesRuntime.log_rotation_age
Log Rotation SizetraitAutomatic log file rotation will occur when the file reaches this size; default unit is kilobytesRuntime.log_rotation_size
Log StatementtraitThe type of statements logged.Runtime.log_statement
Log Statement StatstraitWrites cumulative performance statistics to the server log.Runtime.log_statement_stats
Log Truncate On RotationtraitTruncate existing log files of same name during log rotation.Runtime.log_truncate_on_rotation
Maintenance Work MemtraitThe maximum memory to be used for maintenance operations.Runtime.maintenance_work_mem
Max ConnectionstraitThe maximum number of concurrent connections.Runtime.max_connections
Max Files Per ProcesstraitThe maximum number of simultaneously open files for each server process.Runtime.max_files_per_process
Max Fsm PagestraitThe maximum number of disk pages for which free space is tracked.Runtime.max_fsm_pages
Max Fsm RelationstraitThe maximum number of tables and indexes for which free space is tracked.Runtime.max_fsm_relations
Max Function ArgstraitShows the maximum number of function arguments.Runtime.max_function_args
Max Identifier LengthtraitShows the maximum identifier lengthRuntime.max_identifier_length
Max Index KeystraitShows the maximum number of index keys.Runtime.max_index_keys
Max Locks Per TransactiontraitThe maximum number of locks per transaction.Runtime.max_locks_per_transaction
Max Prepared TransactionstraitThe maximum number of simultaneously prepared transactions.Runtime.max_prepared_transactions
Max Stack DepthtraitThe maximum size of the server's execution stack; default unit is kilobytesRuntime.max_stack_depth
Password EncryptiontraitEncrypt passwords.Runtime.password_encryption
PorttraitThe TCP port the server listens onRuntime.port
Post Auth DelaytraitWaits the specified amount of time on connection startup after authentication; default unit is secondsRuntime.post_auth_delay
Pre Auth DelaytraitWaits the specified amount of time on connection startup before authentication; default unit is secondsRuntime.pre_auth_delay
Random Page CosttraitThe planner's estimate of the cost of a nonsequentially fetched disk page; measured on the same scale as the seq_page_cost configuration parameterRuntime.random_page_cost
Redirect StderrtraitStart a subprocess to capture stderr output into log filesRuntime.redirect_stderr
Regex FlavortraitThe regular expression flavor.Runtime.regex_flavor
Search PathtraitThe schema search order for names that are not schema-qualified.Runtime.search_path
Seq Page CosttraitThe planner's estimate of the cost of a sequentially fetched disk page; measured on an arbitrary scale.Runtime.seq_page_cost
Server EncodingtraitThe server (database) character set encoding.Runtime.server_encoding
Server VersiontraitShows the PostgreSQL version.Runtime.server_version
Server Version NumtraitShows the PostgreSQL version as an integer (e.g. 80204 translates to 8.2.4).Runtime.server_version_num
Shared BufferstraitThe amount of memory for the shared memory buffers used by the serverRuntime.shared_buffers
Shared Preload LibrariestraitLists shared libraries to preload into server.Runtime.shared_preload_libraries
Silent ModetraitRuns the server silently.Runtime.silent_mode
Sql InheritancetraitCauses subtables to be included by default in various commands.Runtime.sql_inheritance
SsltraitEnables SSL connections.Runtime.ssl
Standard Conforming Stringstrait'...' strings treat backslashes literally.Runtime.standard_conforming_strings
Statement TimeouttraitThe maximum allowed duration of any statement; default unit is millisecondsRuntime.statement_timeout
Stats Block LeveltraitCollects block-level statistics on database activity.Runtime.stats_block_level
Stats Command StringtraitCollects information about executing commands.Runtime.stats_command_string
Stats Reset On Server StarttraitZeroes collected statistics on server restart.Runtime.stats_reset_on_server_start
Stats Row LeveltraitCollects row-level statistics on database activity.Runtime.stats_row_level
Stats Start CollectortraitStarts the server statistics-collection subprocess.Runtime.stats_start_collector
Superuser Reserved ConnectionstraitThe number of connection slots reserved for superusersRuntime.superuser_reserved_connections
Tcp Keepalives CounttraitMaximum number of TCP keepalive retransmits; '0' selects the system defaultRuntime.tcp_keepalives_count
Tcp Keepalives IdletraitAmount of time between issuing TCP keepalives; '0' selects the system default; default unit is secondsRuntime.tcp_keepalives_idle
Tcp Keepalives IntervaltraitAmount of time between TCP keepalive retransmits; '0' selects the system default; default unit is secondsRuntime.tcp_keepalives_interval
Temp BufferstraitThe maximum number of temporary buffers used by each session.Runtime.temp_buffers
TimeZonetraitThe time zone for displaying and interpreting time stamps.Runtime.TimeZone
Timezone AbbreviationstraitSelects a file of time zone abbreviationsRuntime.timezone_abbreviations
Trace NotifytraitGenerates debugging output for LISTEN and NOTIFY.Runtime.trace_notify
Trace SorttraitEmit information about resource usage in sorting.Runtime.trace_sort
Transaction IsolationtraitThe current transaction's isolation level.Runtime.transaction_isolation
Transaction Read OnlytraitThe current transaction's read-only status.Runtime.transaction_read_only
Transform Null EqualstraitTreats expr=NULL as expr IS NULLRuntime.transform_null_equals
Unix Socket DirectorytraitThe directory where the Unix-domain socket will be createdRuntime.unix_socket_directory
Unix Socket GrouptraitThe owning group of the Unix-domain socketRuntime.unix_socket_group
Unix Socket PermissionstraitThe access permissions of the Unix-domain socketRuntime.unix_socket_permissions
Update Process TitletraitUpdates the process title to show the active SQL command.Runtime.update_process_title
Vacuum Cost DelaytraitVacuum cost delay; default unit is milliseconds; range 0-1000Runtime.vacuum_cost_delay
Vacuum Cost LimittraitVacuum cost (in credits) amount available before napping.Runtime.vacuum_cost_limit
Vacuum Cost Page DirtytraitVacuum cost (in credits) for a page dirtied by vacuum; range 0-10000Runtime.vacuum_cost_page_dirty
Vacuum Cost Page HittraitVacuum cost (in credits) for a page found in the buffer cache; range 0-10000Runtime.vacuum_cost_page_hit
Vacuum Cost Page MisstraitVacuum cost (in credits) for a page not found in the buffer cache; range 0-10000Runtime.vacuum_cost_page_miss
Vacuum Freeze Min AgetraitMinimum age (in transactions) at which VACUUM should freeze a table row.Runtime.vacuum_freeze_min_age
Wal BufferstraitThe number of disk-page buffers in shared memory for WALRuntime.wal_buffers
Wal Sync MethodtraitSelects the method used for forcing WAL updates out to disk.Runtime.wal_sync_method
Work MemtraitThe maximum memory to be used for query workspaces; default unit is kilobytesRuntime.work_mem
Zero Damaged PagestraitContinues processing past damaged page headers.Runtime.zero_damaged_pages

Note

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

Configuration Properties

Table 2.30. 

NameDescriptionRequiredInternal Name
PortSets the TCP port the server listens on; default value is '5432'. no port
Max_connectionsSets the maximum number of concurrent connections; default value is '100'. no max_connections
Shared_buffersSets the number of the shared memory buffers used by the server; default value is typically '1000'. no shared_buffers
Max_fsm_pagesMaximum FSM Pages, must be a minimum of max_fsm_relations*16, 6 bytes each) no max_fsm_pages
Log_destinationAvailable options depend on operating system; default value is 'stderr' no log_destination
Redirect_stderrEnable capturing of stderr into log files; enabled by default no redirect_stderr
Stats_start_collectorneeded for block or row stats; enabled by default no stats_start_collector
Stats_block_levelEnables the collection of block-level statistics on database activity; if this option is enabled, the data that is produced can be accessed via the pg_stat and pg_statio family of system views; disabled by default no stats_block_level
Stats_row_levelEnables the collection of row-level statistics on database activity; if this option is enabled, the data that is produced can be accessed via the pg_stat and pg_statio family of system views; disabled by default no stats_row_level
AutovacuumEnable autovacuum subprocess? (requires stats_start_collector and stats_row_level to also be on); enabled by default no autovacuum

Note

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

Operations

Table 2.31. Metrics

NameDescription
List Process StatisticsList statistics about the currently executing postgres backends. state column result is only available with Postgres 9.2+

Package Types

none

2.3.1. Postgres - Database Service

Overview

Table 2.32. Overview

Description: 
Singleton: no
Plugin:Postgres

Child Resource Types

Connection Properties

Table 2.33. 

NameDescriptionRequiredInternal Name
Database Name  yes databaseName

Note

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

Metrics

Table 2.34. Metrics

NameTypeDescriptionInternal Name
BackendsmeasurementNumber of active server processes for databasenumbackends
Transactions CommittedmeasurementTransactions committed in databasexact_commit
Transactions Committed per MinutemeasurementTransactions committed in databasexact_commit
Transactions Rolled BackmeasurementTransactions rolled back in databasexact_rollback
Transactions Rolled Back per MinutemeasurementTransactions rolled back in databasexact_rollback
Blocks ReadmeasurementNumber of disk block fetch requests for databaseblks_read
Blocks Read per MinutemeasurementNumber of disk block fetch requests for databaseblks_read
Blocks HitmeasurementNumber of disk block fetch requests found in cache for database blks_hit
Blocks Hit per MinutemeasurementNumber of disk block fetch requests found in cache for database blks_hit
SizemeasurementDisk space used by the databasesize

Note

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

Configuration Properties

none

Operations

Table 2.35. Metrics

NameDescription
Reset StatisticsResets the statistics in this database
Invoke SqlExecute arbitrary SQL
Remove orphan large objectsRemoves orphaned large objects from pg_largeobject

Package Types

none

2.3.1.1. Postgres - Table Service

Overview

Table 2.36. Overview

Description:Database table
Singleton: no
Plugin:Postgres
Child Resource Types
none
Connection Properties

Table 2.37. 

NameDescriptionRequiredInternal Name
Schema Name  yes schemaName
Table Name  yes tableName

Note

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

Table 2.38. Metrics

NameTypeDescriptionInternal Name
Sequential ScansmeasurementNumber of sequential scans done against this table (when an index scan was not possible)seq_scan
Sequential Scans per MinutemeasurementNumber of sequential scans done against this table (when an index scan was not possible)seq_scan
Sequential Rows ReadmeasurementNumber of rows read by sequential scansseq_tup_read
Sequential Rows Read per MinutemeasurementNumber of rows read by sequential scansseq_tup_read
Index ScansmeasurementNumber of index scans done against this tableidx_scan
Index Scans per MinutemeasurementNumber of index scans done against this tableidx_scan
Index Scan Rows ReadmeasurementNumber of index entries returned by index scansidx_tup_fetch
Index Scan Rows Read per MinutemeasurementNumber of index entries returned by index scansidx_tup_fetch
Heap Blocks ReadmeasurementThe number of heap blocks read that were not a buffer cache hitheap_blks_read
Heap Blocks Read per MinutemeasurementThe number of heap blocks read that were not a buffer cache hitheap_blks_read
Heap Blocks HitmeasurementThe number of heap block requests that were found in the buffer cacheheap_blks_hit
Heap Blocks Hit per MinutemeasurementThe number of heap block requests that were found in the buffer cacheheap_blks_hit
Index Blocks ReadmeasurementThe number of index blocks fetched that were not a buffer cache hitidx_blks_read
Index Blocks Read per MinutemeasurementThe number of index blocks fetched that were not a buffer cache hitidx_blks_read
Index Blocks HitmeasurementThe number of index block requests that were found in the buffer cacheidx_blks_hit
Index Blocks Hit per MinutemeasurementThe number of index block requests that were found in the buffer cacheidx_blks_hit
Toast Blocks ReadsmeasurementThe number of toast blocks fetched that were not a buffer cache hittoast_blks_read
Toast Blocks Reads per MinutemeasurementThe number of toast blocks fetched that were not a buffer cache hittoast_blks_read
Toast Blocks HitmeasurementThe number of toast block requests that were found in the buffer cachetoast_blks_hit
Toast Blocks Hit per MinutemeasurementThe number of toast block requests that were found in the buffer cachetoast_blks_hit
Toast Index Blocks ReadmeasurementThe number of toast index blocks fetched that were not a buffer cache hittidx_blks_read
Toast Index Blocks Read per MinutemeasurementThe number of toast index blocks fetched that were not a buffer cache hittidx_blks_read
Toast Index Blocks HitmeasurementThe number of toast index block requests that were found in the buffer cachetidx_blks_hit
Toast Index Blocks Hit per MinutemeasurementThe number of toast index block requests that were found in the buffer cachetidx_blks_hit
Row InsertsmeasurementThe number of rows ever inserted into this tablen_tup_ins
Row Inserts per MinutemeasurementThe number of rows ever inserted into this tablen_tup_ins
Row UpdatesmeasurementThe number of rows ever updated on this tablen_tup_upd
Row Updates per MinutemeasurementThe number of rows ever updated on this tablen_tup_upd
Row DeletesmeasurementThe number of rows ever deleted from this tablen_tup_del
Row Deletes per MinutemeasurementThe number of rows ever deleted from this tablen_tup_del
Table SizemeasurementThe size in bytes of the data in the tabletable_size
Total SizemeasurementThe size in bytes of the data and all associated indexes and toast tablestotal_size
RowsmeasurementThe count of rows in the table. Warning: This may be an expensive operationrows
Approximate rowsmeasurementThe approximate count of rows in the table. This is basically the number of rows of the last ANALYZE of the table. This metric is not expensive.rows_approx

Note

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

Table 2.39. 

NameDescriptionRequiredInternal Name
Schema Name  yes schemaName
Table Name  yes tableName
Columns  yes columns

Note

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

Table 2.40. Metrics

NameDescription
VacuumVacuum the table
Package Types
none

2.3.1.2. Postgres - Query Service

Overview

Table 2.41. Overview

Description: 
Singleton: no
Plugin:Postgres
Child Resource Types
none
Connection Properties

Table 2.42. 

NameDescriptionRequiredInternal Name
TableThe table to discover and to be queried on for metric data yes table
NameInitial name of the resource when manually added. This is also part of the resource key - make this unique if you want two Query resources based on the same table. no name
DescriptionInitial description of resource when manually added no description
Metric QueryThe query that will gather metric data. This must return two columns, a string column whose value is 'metricColumn' and then a numeric column whose value is the metric to be collected. no metricQuery

Note

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

Table 2.43. Metrics

NameTypeDescriptionInternal Name
Metric ValuemeasurementThe metric value for this Query. If Metric Query is not specified, this is not collected.metricColumn

Note

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

2.3.2. Postgres - User Service

Overview

Table 2.44. Overview

Description:A User in the Postgres System
Singleton: no
Plugin:Postgres

Child Resource Types

none

Connection Properties

none

Metrics

Table 2.45. Metrics

NameTypeDescriptionInternal Name
Total User ConnectionsmeasurementThe total number of user connections in the system, whether actively querying or idletotal
Active User ConnectionsmeasurementThe number of user connections in the system actively queryingactive

Note

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

Configuration Properties

Table 2.46. 

NameDescriptionRequiredInternal Name
Inherit RightsInherit rights from parent roles. yes inheritRights
Super UserIs a super user. yes superuser
Can Create Database TypesImplied for a super user. yes canCreateDatabaseObjects
Can Create RolesImplied for a super user. yes canCreateRoles
Can Update System Catalogs DirectlyEven a superuser cannot update system catalogs unless this property is true. False is implied for a non super user. yes canModifyCatalogDirectly
User connection limit  yes connectionLimit
User  yes user
Can Login  yes canLogin
Password  yes password

Note

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

Operations

none

Package Types

none

2.4. Abstract Database Plugin

Table 2.47. Basic Details

Internal Name:Database
Description:Abstract plugin supporting concrete database plugins
Version:4.4.0

Top-Level Resource Types

This plugin does not define any Resource types. It it probably an "abstract plugin", that is, one that provides Resource components and/or discovery components that can be used by other plugins.

2.5. Script - Server

Overview

Table 2.48. Overview

Description:A resource with a command line executable or script as its management interface
Singleton: no
Plugin:Script

Child Resource Types

none

Autodiscovery Process Scans

none

Connection Properties

Table 2.49. 

NameDescriptionRequiredInternal Name
ExecutableThe full path to the command line executable or script yes executable
Working DirectoryWhen the executable is invoked, this will be its working directory. no workingDirectory
Environment VariablesEnvironment variables that are set when executing the executable no environmentVariables
Availability Execute CheckIf specified and true, the ability to successfully execute the executable can determine whether or not the managed resource is considered up and available. If you set this to true, you normally do not set the availability regex settings in order to allow availability to be determined based solely on the successful execution, regardless of the exit code or output. If this is false, setting one of the avail regex settings will override it as if it were true. no availabilityExecuteCheck
Availability Exit Code RegexIf specified, the executable must return an exit code that matches this regular expression if the managed resource is to be considered up and available no availabilityExitCodeRegex
Availability Output RegexIf specified, the executable must output text that matches this regular expression if the managed resource is to be considered up and available. Expression is evaluated by Pattern.find() so match actually means first match found in text. Pattern `OK` matches multiline text `Service status\n is OK`. By default ^$ represent start/end of output text. To match start/end of line add (?m). eg. `(?m)^ is OK$`. To match whole multi-line output use (?s), eg. `(?s)Service.*OK`. no availabilityOutputRegex
Availability ArgumentsIf the executable needs to be executed in order to determine availability, these are the arguments that will be passed to the executable. If you do not specify the regex settings and you set the execute check setting to false, the executable will not be executed and these arguments will not be used - in this case, availability will be determined by the mere existence of the executable file. no availabilityArguments
Version ArgumentsThe arguments to pass to the executable that will help determine the version of the managed resource no versionArguments
Version RegexThe regex that can pick out the version from the executable output. If the regex has a captured group, its matched content will be used as the version. If there is no captured group, the entire output will be used as the version. no versionRegex
Fixed VersionIf specified, this will be the version of the managed resource - the executable will not be invoked to determine it. no fixedVersion
Description ArgumentsThe arguments to pass to the executable that will help determine the managed resource description. This can be arguments to enable verbose version output. no descriptionArguments
Description RegexThe regex that can pick out the description from the executable output. If the regex has a captured group, its matched content will be used as the description. If there is no captured group, the entire output will be used as the description. no descriptionRegex
Fixed DescriptionIf specified, this will be the description of the managed resource - the executable will not be invoked to determine it. no fixedDescription
Enable Quoting of Arguments
  1. In unquoted text: the escape character preserves the value of any following character
  2. In double-quoted text: the escape character escapes " and itself otherwise is both the escape character and the following character are left intact
  3. In single-quoted text: no escaping can occur
yes quotingEnabled
Escape CharacterThe escape character to be used when parsing arguments. By default the escape character is backslash. yes escapeCharacter

Note

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

Metrics

none

Configuration Properties

none

Operations

Table 2.50. Metrics

NameDescription
ExecuteExecutes the executable with a set of arguments and returns the output and exit code.

Package Types

none

Chapter 3. Enterprise Application Platform Resources

There are certain server types that are supported by default in JBoss Operations Network, both for JBoss and non-JBoss resource types.
The JBoss resources here are included with JBoss ON by default through the EAP plug-in pack. Additional JBoss resources can be managed by JBoss ON by installing additional plug-in packs.

3.1. Red Hat JBoss Enterprise Application Platform 4.x (EAP 4) and JBoss Application Server 3.x/4.x Plugin

Table 3.1. Basic Details

Internal Name:JBossAS
Description:Supports management and monitoring of JBoss AS 3.x (3.2.3 and later) and 4.x, and of EAP/SOA-P 4.x
Version:4.4.0

Top-Level Resource Types

3.1.1. JBossAS - Server

Overview

Table 3.2. Overview

Description:JBoss Application Server
Singleton: no
Plugin:JBossAS

Note

h3. 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|http://jira.jboss.com/jira/browse/JBAS-4736] and [JBAS-4955|http://jira.jboss.com/jira/browse/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}}: {code} run -b 12.34.56.78 ... {code} or by explicitly specifying a value for {{java.rmi.server.hostname}} via {{-D}} or {{-P}}, e.g.: {code} run -Djboss.bind.address=12.34.56.78 -Djava.rmi.server.hostname=12.34.56.78 ... {code} Otherwise, you will not be able to manage the instance via JON. {note} 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. {note} h3. 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: {code} <session> <ejb-name>Ability</ejb-name> <local-jndi-name>flower.AbilityLocal</local-jndi-name> {code} You might change this to: {code} <session> <ejb-name>Ability</ejb-name> <local-jndi-name>Ability</local-jndi-name> {code} And then add an MBean flowsys-naming-alias-service.xml: {code} <mbean code="org.jboss.naming.NamingAlias" name=":service=naming-alias"> <attribute name="ToName">flower.AbilityLocal</attribute> <attribute name="FromName">Ability</attribute> </mbean> {code} 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.

Child Resource Types

Autodiscovery Process Scans

Table 3.3. Metrics

NameQuery
JBoss4process|basename|match=^java.*,arg|org.jboss.Main|match=.*

Connection Properties

Table 3.4. 

NameDescriptionRequiredInternal Name
Naming Provider URLThe JNP URL with which to connect to the JBoss Application Server instance (e.g. jnp://127.0.0.1:1099). yes namingURL
PrincipalThe name of the principal (i.e. user) to authenticate. no principal
CredentialsThe credentials (i.e. password) that should be used to authenticate the principal. no credentials
JBoss Home DirectoryThe absolute path to the directory where JBossAS is installed (e.g. /opt/jboss-4.2.2.GA). yes jbossHomeDir
Configuration PathThe 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 SetThe 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 PrefixA prefix applied to script execution commands; this prefix is applied verbatim. The full path of the executable is required (e.g. /usr/bin/sudo). For applicable platforms, this is typically a sudo command, so a sudo user must be configured appropriately for the specified command. Ignored if not set. no scriptPrefix
Start ScriptThe 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 ScriptThe 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 MethodThe method used to execute the Shutdown operation; defaults to 'JMX MBean'. no shutdownMethod
Binding AddressThe 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 PathThe 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
Start Wait MaxThe time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to start up. The default is 5 minutes. no startWaitMax
Stop Wait MaxThe time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to stop. The default is 2.5 minutes. no stopWaitMax
Log Event Sources  yes logEventSources
Snapshot Config EnabledIf true, take a snapshot of the configuration yes snapshotConfigEnabled
Snapshot Config DirectoryThe 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 RegexIf 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 RecursiveIf true, the snapshot will include files located in subdirectories under the config directory. yes snapshotConfigRecursive
Snapshot Log EnabledIf true, take a snapshot of the log files yes snapshotLogEnabled
Snapshot Log DirectoryThe 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 RegexIf 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 RecursiveIf true, the snapshot will include files located in subdirectories under the log directory. yes snapshotLogRecursive
Snapshot Data EnabledIf true, take a snapshot of the data files yes snapshotDataEnabled
Snapshot Data DirectoryThe 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 RegexIf 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 RecursiveIf true, the snapshot will include files located in subdirectories under the data directory. yes snapshotDataRecursive
Snapshot Additional Files ListAdditional files to be included in the snapshot report yes snapshotAdditionalFilesList
TypeThe type of the connection. yes type
Shutdown MBean NameName of the MBean to use when shutting down this server through JMX. yes shutdownMbeanName
Shutdown MBean OperationName 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
JBoss AS JVM NameThe 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 3.5. Metrics

NameTypeDescriptionInternal Name
Partition Nametraitthe name of the cluster partition this app server instance belongs topartitionName
Version Nametraitthe 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 Datetraitthe date this app server was builtjboss.system:type=Server:BuildDate
Start Datetraitthe date and time this app server instance was startedjboss.system:type=Server:StartDate
Active Thread CountmeasurementThe current number of active threads for this app server instancejboss.system:type=ServerInfo:ActiveThreadCount
Active Thread Group CountmeasurementThe current number of active thread groups for this app server instancejboss.system:type=ServerInfo:ActiveThreadGroupCount
JVM Free MemorymeasurementAn approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytesjboss.system:type=ServerInfo:FreeMemory
JVM Max MemorymeasurementThe 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 returnedjboss.system:type=ServerInfo:MaxMemory
JVM Total MemorymeasurementThe total amount of memory currently available in the app server JVM for current and future objects, measured in bytesjboss.system:type=ServerInfo:TotalMemory
Total TransactionsmeasurementTotal number of transactions since last restartjboss:service=TransactionManager:TransactionCount
Total Transactions per MinutemeasurementTotal number of transactions since last restartjboss:service=TransactionManager:TransactionCount
Transactions CommittedmeasurementNumber of transactions commited since last restartjboss:service=TransactionManager:CommitCount
Transactions Committed per MinutemeasurementNumber of transactions commited since last restartjboss:service=TransactionManager:CommitCount
Transactions RolledbackmeasurementNumber of transactions commited since last restartjboss:service=TransactionManager:RollbackCount
Transactions Rolledback per MinutemeasurementNumber of transactions commited since last restartjboss:service=TransactionManager:RollbackCount

Note

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

Configuration Properties

none

Operations

Table 3.6. Metrics

NameDescription
StartStart this application server. The script used is specified in the Operations group of connection properties.
ShutdownShutdown this application server via script or JMX depending on the settings in the Operations and Advanced groups of connection properties.
RestartShutdown and then start this application server.

Package Types

Table 3.7. Package Types

NameCategoryDescription
Cumulative PatchDeployableAutomatically installable application server patches
Jar LibraryDeployableLibrary Jar files deployed in JBoss AS

3.1.1.1. JBossAS - Embedded Tomcat Server

Overview

Table 3.8. Overview

Description:Tomcat Web Application Container embedded in a JBossAS Server
Singleton: yes
Plugin:JBossAS
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.1.1.1.1. JBossAS - Connector Service
Overview

Table 3.9. Overview

Description: 
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.10. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
PortPort this connector listens on. yes port
AddressAddress this connector listens on. yes address
SchemeThe 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 3.11. Metrics

NameTypeDescriptionInternal Name
Maximum Request TimemeasurementMaximum time it took to process a requestjboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:maxTime
Request countmeasurementTotal number of requests processed since last restart.jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:requestCount
Request count per MinutemeasurementTotal number of requests processed since last restart.jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:requestCount
Error countmeasurementNumber of errors while processing since last restart.jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:errorCount
Error count per MinutemeasurementNumber of errors while processing since last restart.jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:errorCount
Threads ActivemeasurementThreads Activejboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:currentThreadsBusy
Threads AllocatedmeasurementThreads Allocatedjboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:currentThreadCount
Maximum ThreadstraitMaximum number of threads that can be allocated for the thread pool of this connectorjboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:maxThreads

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.1.1.2. JBossAS - VHost Service
Overview

Table 3.12. Overview

Description:A virtual host in the web container
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.13. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName

Note

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

Table 3.14. Metrics

NameTypeDescriptionInternal Name
AliasestraitThe aliases for this virtual hostjboss.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

3.1.1.2. JBossAS - Datasource Service

Overview

Table 3.15. Overview

Description: 
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.16. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe name of this datasource yes name

Note

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

Table 3.17. Metrics

NameTypeDescriptionInternal Name
Total ConnectionsmeasurementTotal Number of Connections for the Connection Pool, both active and in-active.ConnectionCount
Available ConnectionsmeasurementNumber of available connections in the connection pool in-active and waiting.AvailableConnectionCount
Active ConnectionsmeasurementNumber of Connections currently supporting clients.InUseConnectionCount
Connections CreatedmeasurementNumber of Connections created since the Connection Pool was created.ConnectionCreatedCount
Connections Created per MinutemeasurementNumber of Connections created since the Connection Pool was created.ConnectionCreatedCount
Connections DestroyedmeasurementNumber of Connections destroyed since the Connection Pool was created.ConnectionDestroyedCount
Connections Destroyed per MinutemeasurementNumber 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 3.18. 

NameDescriptionRequiredInternal Name
Type  yes type
JNDI NameThe JNDI name under which the DataSource wrapper will be bound. yes jndi-name
Driver ClassThe fully qualified name of the JDBC driver or datasource class. Not used for XA-Datasources no driver-class
Connection UrlThe JDBC driver connection URL string. Needed for Tx and Non-Tx datasources no 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 IsolationThe Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. no transaction-isolation
Blocking Timeout MillisIndicates 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 MinutesIndicates 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 SizeThe number of prepared statements per connection in an LRU cache. no prepared-statement-cache-size
Valid Connection Checker Class NameAn 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 ContextIndicates 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 DomainIndicates 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 SqlSpecify an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Exception Sorter Class NameAn 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 SqlSpecify 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 StatementsWhether 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 ClassThe datasource class for XA connections. no xa-datasource-class
Connection Property  no connection-property
No Tx Separate PoolsWhether 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 TxWhether 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 ValueAllows 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 3.19. Metrics

NameDescription
FlushResets 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

3.1.1.3. JBossAS - ConnectionFactory Service

Overview

Table 3.20. Overview

Description: 
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.21. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe 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 3.22. Metrics

NameTypeDescriptionInternal Name
Available Connection CountmeasurementNumber of available connections.AvailableConnectionCount
Connection CountmeasurementConnection CountConnectionCount
Connection Created CountmeasurementConnection Created CountConnectionCreatedCount
Connection Destroyed CountmeasurementConnection Destroyed CountConnectionDestroyedCount
In Use Connection CountmeasurementMumber of connections currently in use.InUseConnectionCount
Max Connections In Use CountmeasurementMaximum number of maximum connections that have been in use.MaxConnectionsInUseCount
Max SizemeasurementMax SizeMaxSize
Min SizemeasurementMin SizeMinSize

Note

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

Table 3.23. 

NameDescriptionRequiredInternal Name
Connection Factory TypeConnection Factory Type (Tx or no Tx) yes type
JNDI NameThe JNDI Name under which the DataSource wrapper will be bound. yes jndi-name
User NameThis 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
PasswordThis 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 SizeIndicates the minimum number of connections the pool should hold. no min-pool-size
Maximum Pool SizeIndicates the maximum number of connections the pool should hold. no max-pool-size
Application Managed SecuritySpecifying 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 ApplicationIndicates 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 Nameused to identify the RAR deployment matching the display-name in the ra.xml no adapter-display-name
DependsThe 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 NameThis 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 DefinitionThis is the connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. yes connection-definition
Type MappingsThis 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 ContextIndicates if the JNDI name should be prefixed with java:. no use-java-context
Transaction TypeWhether to use local or xa transactions. If nothing is specified, the default of local will be used. no transaction-type
No Tx Separate PoolsThe 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 TransactionWhether the connection should be locked into the transaction. no track-connection-by-tx
isSameRM Override ValueAllows 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 MinimumWhether on not to use strict minumum. no use-strict-min
PrefillPrefill the Pool with Connection objects, or lazy load objects in the pool no prefill
Blocking Timeout in MillisecondsIndicates 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 TimeoutMaximum time in minutes a connection can be idle before it is closed. no idle-timeout-minutes
XA Resource TimeoutMaximum time in minutes an XA Resource can be idle before it is removed. no xa-resource-timeout
New Connection SQLSpecify an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Check Valid Connection SQLSpecify 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 PropertyConfiguration 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

3.1.1.4. JBossAS - JBossMQ Service

Overview

Table 3.24. Overview

Description:The JBossMQ subsystem
Singleton: yes
Plugin:JBossAS
Child Resource Types
Connection Properties

Table 3.25. 

NameDescriptionRequiredInternal 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 3.26. Metrics

NameTypeDescriptionInternal Name
JMS Message Cache HitsmeasurementThe number of cache hits to the JMS Message Cachejboss.mq:service=MessageCache:CacheHits
JMS Message Cache Hits per MinutemeasurementThe number of cache hits to the JMS Message Cachejboss.mq:service=MessageCache:CacheHits
JMS Message Cache MissesmeasurementThe number of cache misses to the JMS Message Cachejboss.mq:service=MessageCache:CacheMisses
JMS Message Cache Misses per MinutemeasurementThe number of cache misses to the JMS Message Cachejboss.mq:service=MessageCache:CacheMisses
JMS Message Cache Current Memory UsagemeasurementThe total memory currently in use by the JMS Message Cachejboss.mq:service=MessageCache:CurrentMemoryUsage
JMS Message Cache High Memory MarkmeasurementThe peak amount of memory the JMS Message Cache has actively used since server startjboss.mq:service=MessageCache:HighMemoryMark
JMS Message Cache Max Memory MarkmeasurementThe maximum amount of memory the JMS Message Cache is allowed to usejboss.mq:service=MessageCache:MaxMemoryMark
JMS Message Cache SizemeasurementThe number of messages currently in the JMS Message Cachejboss.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
3.1.1.4.1. JBossAS - JMQ JMS Queue Service
Overview

Table 3.27. Overview

Description: 
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.28. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe name of this queue yes name

Note

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

Table 3.29. Metrics

NameTypeDescriptionInternal Name
Messages in QueuemeasurementThe number of undelivered messages in the queue.QueueDepth
Receivers CountmeasurementThe number of ClientConsumers waiting for a message.ReceiversCount
Scheduled Message CountmeasurementThe number of messages waiting to be scheduledScheduledMessageCount
In Process Message CountmeasurementThe 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 3.30. 

NameDescriptionRequiredInternal Name
Destination ManagerThe JMX object name of the destination manager configured for the server. yes DestinationManager
Security ManagerThe JMX object name of the security manager that is being used to validate client requests. no SecurityManager
Expiry DestinationBy 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 NameThe 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 MemoryDon't persist messages and avoid message softening when using the NullPersistenceManager no InMemory
Redelivery LimitThe 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 DelayThe length of time in milliseconds to wait before a message is redelivered after a nack no RedeliveryDelay
Message Counter History Day LimitSets 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 DepthThe 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 RetriesSpecifies the number of times uncommitted transactions are to be resolved before failing. Default 0 - zero (from JBoss-4.0.3). no RecoveryRetries
Security ConfigurationsThis 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 NameName of the queue to be used in the JMX object name. yes MBeanName
JNDI BindingBinding 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 3.31. Metrics

NameDescription
Remove All MessagesClears all Messages in the Queue
Reset Message CounterClears the MessageCounter data for this Queue
Reset Message Counter HistoryClears the MessageCounter history data for this Queue
List Messages by SelectorLists the Messages in the Queue by Selector (if provided). Selector is not required.
List Scheduled MessagesLists the Scheduled Messages by Selector (if provided). Selector is not required.
List In Process MessagesLists the Messages in process by Selector (if provided). Selector is not required.
Package Types
none
3.1.1.4.2. JBossAS - JMQ JMS Topic Service
Overview

Table 3.32. Overview

Description: 
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.33. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe name of this topic yes name

Note

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

Table 3.34. Metrics

NameTypeDescriptionInternal Name
All Message CountermeasurementReturns the total message count for all subscriptions.AllMessageCount
Durable Message CountmeasurementTotal number of messages for all durable subscriptions.DurableMessageCount
Non-durable Message CountmeasurementTotal number of messages for all non-durable subscriptions.NonDurableMessageCount
All Subscription CountmeasurementNumber of subscriptions waiting for a message.AllSubscriptionsCount
Durable Subscription CountmeasurementNumber of durable subscriptions waiting for a message.DurableSubscriptionsCount
Non-durable Subscription CountmeasurementNumber 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 3.35. 

NameDescriptionRequiredInternal Name
Destination ManagerThe JMX object name of the destination manager configured for the server. yes DestinationManager
Security ManagerThe JMX object name of the security manager that is being used to validate client requests. no SecurityManager
Expiry DestinationBy 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 NameThe 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 MemoryDon't persist messages and avoid message softening when using the NullPersistenceManager. no InMemory
Redelivery LimitThe 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 DelayThe length of time in milliseconds to wait before a message is redelivered after a nack. no RedeliveryDelay
Message Counter History Day LimitSets 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 DepthThe 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 RetriesSpecifies the number of times uncommitted transactions are to be resolved before failing. Default 0 - zero (from JBoss-4.0.3). no RecoveryRetries
Security ConfigurationsThis 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 NameName of the queue to be used as the JMX object name. yes MBeanName
JNDI BindingBinding 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 3.36. Metrics

NameDescription
Remove All MessagesClears all Subscriptions
List All SubscriptionsLists all the Subscriptions.
List Durable SubscriptionsLists all the durable subscriptions.
List Non-durable SubscriptionsLists all the non-durable subscriptions.
Reset Message CounterClears the message counter data for all topic subscriptions.
Reset Message Counter HistoryClears the message counter history data for this topic.
List Messages by ID and SelectorList the messages for a subscription by ID and with an optional selector.
Get Non-durable Message CountGets the message count for non-durable messages by client ID and subscription ID.
List Non-durable MessagesLists the non-durable messages by client ID, subscription ID, and an optional selector.
Get Durable Message CountGets the message count for durable messages by client ID and subscription ID.
List Durable MessagesLists the durable messages by client ID, subscription ID, and an optional selector.
Get Non-durable Scheduled Message CountGets the message count for non-durable scheduled messages by client ID and subscription ID.
List Non-durable Scheduled MessagesLists the non-durable scheduled messages by client ID, subscription ID, and an optional selector.
Get Durable Scheduled Message CountGets the message count for durable scheduled messages by client ID and subscription ID.
List Durable Scheduled MessagesLists the durable scheduled messages by client ID, subscription ID, and an optional selector.
Get Non-durable In-process Message CountGets the message count for non-durable in-process messages by client Id and subscription Id
List Non-durable In-process MessagesLists the non-durable in-process messages by client ID, subscription ID, and an optional selector.
Get Durable In-process Message CountGets the message count for durable in-process messages by client ID and subscription Id
List Durable In-process MessagesLists the durable in-process messages by client ID, subscription ID, and an optional selector.
Package Types
none

3.1.1.5. JBossAS - JBossMessaging Service

Overview

Table 3.37. Overview

Description:The JBoss Messaging subsystem
Singleton: yes
Plugin:JBossAS
Child Resource Types
Connection Properties

Table 3.38. 

NameDescriptionRequiredInternal 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 3.39. Metrics

NameTypeDescriptionInternal Name
Version of the ProvidertraitThe version of JBoss Messaging in usejboss.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
3.1.1.5.1. JBossAS - JBM JMS Queue Service
Overview

Table 3.40. Overview

Description: 
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.41. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe name of this queue yes name

Note

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

Table 3.42. Metrics

NameTypeDescriptionInternal Name
Messages in QueuemeasurementThe number of messages in the queue.MessageCount
Consumer CountmeasurementThe number of ClientConsumers waiting for a message.ConsumerCount
Scheduled Message CountmeasurementThe number of scheduled messages in the QueueScheduledMessageCount
Created programmaticallytraitWas this Queue created dynamicallyCreatedProgrammatically
Delivering CountmeasurementThe number of messages currently being deliveredDeliveringCount

Note

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

Table 3.43. 

NameDescriptionRequiredInternal Name
Server PeerThe ObjectName of the server peer this destination was deployed on. yes ServerPeer
Dead Letter QueueThe DLQ for this queue, overrides the default DLQ on the server peer. no DLQ
Expiry QueueBy 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 NameThe 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
ClusteredIs this a clustered destination? no Clustered
Max Delivery AttemptsThe 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 DelayThe length of time in milliseconds to wait before a message is redelivered after a nack no RedeliveryDelay
Message Counter History Day LimitSets 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 SizeThe maximum number of messages this queue can hold before they are dropped (-1 = infinite) no MaxSize
Full SizeThe in-memory message limit, can only be set when queue is stopped no FullSize
Page SizeThe paging size, can only be set when queue is stopped no PageSize
Down Cache SizeThe write-cache size, can only be set when queue is stopped no DownCacheSize
Security ConfigurationsThis 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 NameName of the queue to be used in the JMX object name. yes MBeanName
JNDI BindingBinding 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 3.44. Metrics

NameDescription
Remove All MessagesClears all Messages in the Queue
Reset Message CounterClears the MessageCounter data for this Queue
Reset Message Counter HistoryClears the MessageCounter history data for this Queue
List Messages by SelectorLists the Messages in the Queue by Selector (if provided). Selector is not required.
List All MessagesLists All Messages by Selector (if provided). Selector is not required.
List Durable MessagesLists Durable Messages by Selector (if provided). Selector is not required.
List Non-Durable MessagesLists Non-Durable Messages by Selector (if provided). Selector is not required.
Package Types
none
3.1.1.5.2. JBossAS - JBM JMS Topic Service
Overview

Table 3.45. Overview

Description: 
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.46. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe name of this topic yes name

Note

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

Table 3.47. Metrics

NameTypeDescriptionInternal Name
All Message CountermeasurementReturns the total message count for all subscriptions.AllMessageCount
Durable Message CountmeasurementTotal number of messages for all durable subscriptions.DurableMessageCount
Non-durable Message CountmeasurementTotal number of messages for all non-durable subscriptions.NonDurableMessageCount
All Subscription CountmeasurementNumber of subscriptions waiting for a message.AllSubscriptionsCount
Durable Subscription CountmeasurementNumber of durable subscriptions waiting for a message.DurableSubscriptionsCount
Non-durable Subscription CountmeasurementNumber of non-durable subscriptions waiting for a message.NonDurableSubscriptionsCount
Created programmaticallytraitWas this Topic created dynamicallyCreatedProgrammatically

Note

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

Table 3.48. 

NameDescriptionRequiredInternal Name
Server PeerThe ObjectName of the server peer this destination was deployed on. yes ServerPeer
Dead Letter QueueThe DLQ for this queue, overrides the default DLQ on the server peer. no DLQ
Expiry QueueBy 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 NameThe 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
ClusteredIs this a clustered destination? no Clustered
Max Delivery AttemptsThe 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 DelayThe length of time in milliseconds to wait before a message is redelivered after a NACK no RedeliveryDelay
Message Counter History Day LimitSets 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 SizeThe maximum number of messages this queue can hold before they are dropped (-1 = infinite) no MaxSize
Full SizeThe in-memory message limit, can only be set when queue is stopped no FullSize
Page SizeThe paging size, can only be set when queue is stopped no PageSize
Down Cache SizeThe write-cache size, can only be set when queue is stopped no DownCacheSize
Security ConfigurationsThis 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 NameName of the queue to be used in the JMX object name. yes MBeanName
JNDI BindingBinding 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 3.49. Metrics

NameDescription
Remove All MessagesClears all Subscriptions
List All SubscriptionsLists all the Subscriptions.
List Durable SubscriptionsLists all the durable subscriptions.
List Non-durable SubscriptionsLists all the non-durable subscriptions.
List Messages by ID and SelectorList the messages for a subscription by ID and with an optional selector.
List Non-durable MessagesLists the non-durable messages by subscription ID and an optional selector.
List Durable MessagesLists the durable messages by subscription ID and an optional selector.
Package Types
none

3.1.1.6. JBossAS - EJB3 Session Bean Service

Overview

Table 3.50. Overview

Description:An EJB3 Stateless or Stateful Session Bean
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.51. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe 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 3.52. Metrics

NameTypeDescriptionInternal Name
Current CountmeasurementThe total number of currently pooled instances of this EJB3 Session BeanCurrentSize
Create CountmeasurementThe number of instances of this EJB3 Session Bean that have been created since server startCreateCount
Create Count per MinutemeasurementThe number of instances of this EJB3 Session Bean that have been created since server startCreateCount
Remove CountmeasurementThe number of instances of this EJB3 Session Bean that have been removed since server startRemoveCount
Remove Count per MinutemeasurementThe number of instances of this EJB3 Session Bean that have been removed since server startRemoveCount
Available CountmeasurementThe number of pooled instances of this EJB3 Session Bean in the method-ready stateAvailableCount
Max SizemeasurementThe maximum number of instances that are allowed to be pooledMaxSize
Method Invocation TimecalltimeThe 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 3.53. Metrics

NameDescription
View Method StatsView 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

3.1.1.7. JBossAS - Stateless Session EJB Service

Overview

Table 3.54. Overview

Description:An EJB 1.x or 2.x Stateless Session Bean
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.55. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe 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 3.56. Metrics

NameTypeDescriptionInternal Name
Create CallsmeasurementThe 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 MinutemeasurementThe 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 CallsmeasurementThe 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 MinutemeasurementThe 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 BeansmeasurementThe number of pooled instances of this EJB 1.x or 2.x Stateless Session Bean in the method-ready state{stats.methodReadyCount.current}
Pool SizemeasurementThe 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 SizemeasurementThe maximum number of instances that are allowed to be pooled{{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}MaxSize}
Method Invocation Timecalltimethe minimum, maximum, and average invocation times for each of the methods exposed by this EJBMethodInvocationTime

Note

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

3.1.1.8. JBossAS - Stateful Session EJB Service

Overview

Table 3.57. Overview

Description:An EJB 1.x or 2.x Stateful Session Bean
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.58. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe 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 3.59. Metrics

NameTypeDescriptionInternal Name
Create CallsmeasurementThe 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 MinutemeasurementThe 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 CallsmeasurementThe 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 MinutemeasurementThe 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 BeansmeasurementThe number of pooled instances of this EJB 1.x or 2.x Stateful Session Bean in the method-ready state{stats.methodReadyCount.current}
Passive BeansmeasurementThe number of pooled instances of this EJB 1.x or 2.x Stateful Session Bean in the passivated state{stats.passiveCount.current}
Method Invocation Timecalltimethe minimum, maximum, and average invocation times for each of the methods exposed by this EJBMethodInvocationTime

Note

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

3.1.1.9. JBossAS - Entity EJB Service

Overview

Table 3.60. Overview

Description:An EJB 1.x or 2.x Entity Bean
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.61. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe 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 3.62. Metrics

NameTypeDescriptionInternal Name
Create CallsmeasurementThe 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 MinutemeasurementThe number of instances of this EJB 1.x or 2.x Entity Bean that have been created since server start{stats.createCount.count}
Remove CallsmeasurementThe 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 MinutemeasurementThe 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 BeansmeasurementThe number of pooled instances of this EJB 1.x or 2.x Entity Bean in the method-ready state{stats.methodReadyCount.current}
Pooled BeansmeasurementThe total number of currently pooled instances of this EJB 1.x or 2.x Entity Bean{stats.pooledCount.current}
Cache SizemeasurementThe 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 CountmeasurementThe 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 MinutemeasurementThe 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 SizemeasurementThe 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 SizemeasurementThe 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

3.1.1.10. JBossAS - Message Driven EJB Service

Overview

Table 3.63. Overview

Description:An EJB 1.x or 2.x Message Driven Bean
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.64. 

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
NameThe 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 3.65. Metrics

NameTypeDescriptionInternal Name
Create CallsmeasurementThe 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 MinutemeasurementThe 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 CallsmeasurementThe 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 MinutemeasurementThe 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 BeansmeasurementThe 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 MinutemeasurementThe 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

3.1.1.11. JBossAS - Enterprise Application (EAR) Service

Overview

Table 3.66. Overview

Description:Enterprise Application
Singleton: no
Plugin:JBossAS
Child Resource Types
Connection Properties

Table 3.67. 

NameDescriptionRequiredInternal Name
NameThe 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 3.68. Metrics

NameTypeDescriptionInternal Name
PathtraitThe absolute path of this EAR file or directoryApplication.path
Exploded?traitWhether 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 3.69. Metrics

NameDescription
RevertTries to revert this enterprise application from a saved backup in the same directory and with a name ending in .bak
Package Types

Table 3.70. Package Types

NameCategoryDescription
EAR FileDeployable 
3.1.1.11.1. JBossAS - Embedded Web Application (WAR) Service
Overview

Table 3.71. Overview

Description:Web Application embedded inside of an Enterprise Application
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.72. 

NameDescriptionRequiredInternal Name
NameThe name of this WAR yes name
Filename  yes filename
Object Name  yes objectName
Context Rootthis WAR's context root - used as a unique path prefix for URLs corresponding to this WAR no contextRoot
Virtual HostThe (virtual) host that this application is running on. If no virtual host is set, this defaults to 'localhost' no vHost
Jboss Web Namethe objectName for the jboss.web WebModule that will be used to fire operations no jbossWebName
Response Time Log Filethe full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludesa space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transformsa 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 3.73. Metrics

NameTypeDescriptionInternal Name
Pathtraitthe absolute path of this WAR file or directoryApplication.path
Exploded?traitwhether this WAR is deployed exploded (i.e. as a directory)Application.exploded
Context Roottraitthis WAR's context root - used as a unique path prefix for URLs corresponding to this WARContextRoot
HTTP Response Timecalltimethe minimum, maximum, and average response times for HTTP requests serviced by this webappResponseTime
Min. Servlet Resp. TimemeasurementMinimum response time of a servletServlet.MinResponseTime
Avg. Servlet Resp. TimemeasurementAverage response time of a servletServlet.AvgResponseTime
Max. Servlet Resp. TimemeasurementMaximum response time of a servletServlet.MaxResponseTime
Total processing timemeasurementTotal processing time of the webappServlet.TotalTime
Total processing time per MinutemeasurementTotal processing time of the webappServlet.TotalTime
Requests servedmeasurementNumber of requests served by servletsServlet.NumRequests
Requests served per MinutemeasurementNumber of requests served by servletsServlet.NumRequests
Errors while processingmeasurementNumber of errors while processingServlet.NumErrors
Errors while processing per MinutemeasurementNumber of errors while processingServlet.NumErrors
Currently Active SessionsmeasurementNumber active sessions for the webapp right nowSession.activeSessions
Maximum number of Active SessionsmeasurementMaximum number of active sessions for the webappSession.maxActive
Sessions createdmeasurementNumber of sessions created for the webappSession.sessionCounter
Sessions created per MinutemeasurementNumber of sessions created for the webappSession.sessionCounter
Expired SessionsmeasurementNumber of expired sessions for the webappSession.expiredSessions
Expired Sessions per MinutemeasurementNumber of expired sessions for the webappSession.expiredSessions
Rejected SessionsmeasurementNumber of sessions rejected for the webappSession.rejectedSessions
Rejected Sessions per MinutemeasurementNumber of sessions rejected for the webappSession.rejectedSessions
Session Average alive timemeasurementAverage alive time of a SessionsSession.sessionAverageAliveTime
Max Session alive timemeasurementMaximum alive time of a SessionsSession.sessionMaxAliveTime
VhosttraitVirtual hosts this app runs onVhost.name

Note

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

Table 3.74. Metrics

NameDescription
Startstarts 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)
Stopstops 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)
Reloadreloads this webapp; NOTE: if the webapp is not in the started state, this operation will fail
Package Types
none

3.1.1.12. JBossAS - Web Application (WAR) Service

Overview

Table 3.75. Overview

Description:Web Application
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.76. 

NameDescriptionRequiredInternal Name
NameThe name of this WAR yes name
Filename  yes filename
Object Name  yes objectName
Context Rootthis WAR's context root - used as a unique path prefix for URLs corresponding to this WAR no contextRoot
Virtual HostThe (virtual) host that this application is running on. If no virtual host is set, this defaults to 'localhost' no vHost
Jboss Web Namethe objectName for the jboss.web WebModule that will be used to fire operations no jbossWebName
Response Time Log Filethe 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 Excludesa space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transformsa 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 3.77. Metrics

NameTypeDescriptionInternal Name
Pathtraitthe absolute path of this WAR file or directoryApplication.path
Exploded?traitwhether this WAR is deployed exploded (i.e. as a directory)Application.exploded
Context Roottraitthis WAR's context root - used as a unique path prefix for URLs corresponding to this WARContextRoot
HTTP Response Timecalltimethe minimum, maximum, and average response times for HTTP requests serviced by this webappResponseTime
Min. Servlet Resp. TimemeasurementMinimum response time of a servletServlet.MinResponseTime
Avg. Servlet Resp. TimemeasurementAverage response time of a servletServlet.AvgResponseTime
Max. Servlet Resp. TimemeasurementMaximum response time of a servletServlet.MaxResponseTime
Total processing timemeasurementTotal processing time of the webappServlet.TotalTime
Total processing time per MinutemeasurementTotal processing time of the webappServlet.TotalTime
Requests servedmeasurementNumber of requests served by servletsServlet.NumRequests
Requests served per MinutemeasurementNumber of requests served by servletsServlet.NumRequests
Errors while processingmeasurementNumber of errors while processingServlet.NumErrors
Errors while processing per MinutemeasurementNumber of errors while processingServlet.NumErrors
Currently Active SessionsmeasurementNumber active sessions for the webapp right nowSession.activeSessions
Maximum number of Active SessionsmeasurementMaximum number of active sessions for the webappSession.maxActive
Sessions createdmeasurementNumber of sessions created for the webappSession.sessionCounter
Sessions created per MinutemeasurementNumber of sessions created for the webappSession.sessionCounter
Expired SessionsmeasurementNumber of expired sessions for the webappSession.expiredSessions
Expired Sessions per MinutemeasurementNumber of expired sessions for the webappSession.expiredSessions
Rejected SessionsmeasurementNumber of sessions rejected for the webappSession.rejectedSessions
Rejected Sessions per MinutemeasurementNumber of sessions rejected for the webappSession.rejectedSessions
Session Average alive timemeasurementAverage alive time of a SessionsSession.sessionAverageAliveTime
Max Session alive timemeasurementMaximum alive time of a SessionsSession.sessionMaxAliveTime
VhosttraitVirtual hosts this app runs onVhost.name

Note

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

Table 3.78. Metrics

NameDescription
Startstarts 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)
Stopstops 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)
Reloadreloads this webapp; NOTE: if the webapp is not in the started state, this operation will fail
RevertTries to revert this web application from a saved backup in the same directory and with a name ending in .bak
Package Types

Table 3.79. Package Types

NameCategoryDescription
WAR FileDeployable 

3.1.1.13. JBossAS - EJB3 Entity Tree Cache Service

Overview

Table 3.80. Overview

Description:The entity cache
Singleton: no
Plugin:JBossAS
Child Resource Types
Connection Properties

Table 3.81. 

NameDescriptionRequiredInternal 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 3.82. Metrics

NameTypeDescriptionInternal Name
Number Of Locks HeldmeasurementThe number of entities locked for update / replication across the (clustered) tree cacheNumberOfLocksHeld
Number Of NodesmeasurementThe total number of entities currently cached across the (clustered) tree cacheNumberOfNodes

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.1.13.1. JBossAS - EJB3 Entity Tree Cache Interceptor Service
Overview

Table 3.83. Overview

Description:The entity cache interceptor
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.84. 

NameDescriptionRequiredInternal 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 3.85. Metrics

NameTypeDescriptionInternal Name
Hit Miss RatiomeasurementReturns the hit/miss ratio for the cache. This ratio is defined as hits/(hits + misses).HitMissRatio
Read Write RatiomeasurementReturns the read/write ratio for the cache. This ratio is defined as (hits + misses)/stores.ReadWriteRatio
HitsmeasurementReturns the number of requests made to this cache which it could answer without interrogating the underlying data storeHits
MissesmeasurementReturns the number of requests made to this cache which required interrogating the underlying data storeMisses
EvictionsmeasurementReturns the number of elements purged from this cache in accordance with its specific eviction policyEvictions
Number Of Locks HeldmeasurementThe number of elements locked by this interceptor for update / replication across the (clustered) tree cacheNumberOfLocksHeld
Number Of NodesmeasurementThe total number of entities currently cached across the (clustered) tree cacheNumberOfNodes
Average Write TimemeasurementThe average time it takes to insert or update elements for the cacheAverageWriteTime
Time Since ResetmeasurementThe amount of time since this cache was reset / clearedTimeSinceReset
Average Read TimemeasurementThe average time it takes to read elements for the cache, includes AverageReadTime
StoresmeasurementNumber of store / writes into this cache made by this interceptorStores
Number Of AttributesmeasurementThe total number of attributes (properties of an entity) currently cached across the (clustered) tree cacheNumberOfAttributes
Elapsed TimemeasurementThe amount of time since this cache was createdElapsedTime

Note

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

3.1.1.14. JBossAS - Script Service

Overview

Table 3.86. Overview

Description:provides the ability to execute a script that performs some task related to its parent JBossAS server
Singleton: no
Plugin:JBossAS
Child Resource Types
none
Connection Properties

Table 3.87. 

NameDescriptionRequiredInternal Name
Paththe absolute path to the script file yes path
Environment Variablesthe 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 3.88. Metrics

NameDescription
Execute Scriptexecute 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

3.2. Red Hat JBoss Enterprise Application Platform 5.x (EAP 5) and JBoss Application Server 5.x/6.x Plugin

Table 3.89. Basic Details

Internal Name:JBossAS5
Description:provides management and monitoring of JBoss AS 6.x and JBoss EAP/EWP/SOA-P 5.x
Version:4.4.0

Top-Level Resource Types

3.2.1. JBossAS5 - JBossAS Server

Overview

Table 3.90. Overview

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

Note

The server can be started, restarted, or stopped via the Start, Restart, and Shutdown operations. The Start and Restart operations start the server by executing the server start script, typically run.sh on UNIX or run.bat on Windows. The following connection settings can be used to configure the start script execution: * Start Script - the absolute path of the start script (e.g. "/opt/jboss-eap-5.0/jboss-as/bin/run.sh") * Script Prefix - a prefix command line to be prepended to the start script command line (e.g. "nohup sudo -u jboss -g jboss") the prefix is also prepsended to the stop script command line if the Stop operation is configured to stop the app server via script. * Start Script Arguments - arguments to be passed to the start script (e.g. "--configuration=production") * Start Script Environment - environment variables to be set in the start script's environment (e.g. "JAVA_HOME=/usr/java/jdk1.6.0_30") These settings are automatically initialized by the JBossAS5 plugin discovery code to match the currently running server process' command line and environment. For more detailed descriptions of the settings, see the Connection Settings section below.

Child Resource Types

Autodiscovery Process Scans

Table 3.91. Metrics

NameQuery
jbossasprocess|basename|match=^java.*,arg|org.jboss.Main|match=.*

Connection Properties

Table 3.92. 

NameDescriptionRequiredInternal Name
Naming Provider URLThe 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
PrincipalThe name of the principal (i.e. user) to authenticate. no principal
CredentialsThe credentials (i.e. password) that should be used to authenticate the principal. no credentials
JBoss Home DirectoryThe absolute path to the directory where JBoss AS or EAP is installed (e.g. /opt/jboss-5.1.0.GA). yes homeDir
Server Home DirThe 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 NameThe name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {serverHomeDir}. If the 'startScriptArgs' property is not set, this property will be used by the Start and Restart operations as the value of the -c option that is passed to the start script. However, this property is deprecated for that purpose and 'startScriptArgs' should be used instead. no serverName
Client UrlThe URL of the server's client JAR library directory; if not specified, it will default to {homeDir}/client. no clientUrl
Lib UrlThe URL of the server's main JAR library directory; if not specified, it will default to {homeDir}/lib. no libUrl
Common Lib UrlThe URL of the server's common JAR library directory; if not specified, it will default to {homeDir}/common/lib. no commonLibUrl
Script PrefixA prefix applied to script execution commands; this prefix is applied verbatim. The full path of the executable is required (e.g. /usr/bin/sudo). For applicable platforms, this is typically a sudo command, so a sudo user must be configured appropriately for the specified command. Ignored if not set. no scriptPrefix
Start ScriptThe 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
Start Script Environment VariablesThe variables that the Start and Restart operations will add to the environment of the server start script. Each name=value pair should be on a new line. Variable values should *not* be enclosed in quotes (e.g. JAVA_OPTS=-Xms512M -Xmx1024M). On UNIX systems, the typical minimum set of environment variables is: PATH=/usr/bin:/bin . And on Windows the typical minimum set is: PATH=C:\Windows\System32;C:\Windows , OS=Windows_NT , SYSTEMROOT=C:\Windows . In addition, it is good practice to set JAVA_HOME to the absolute path of the install directory of the JRE or JDK you wish to use to run the AS7 instance. However, if JAVA_HOME is not specified, the start script will attempt to find java in the PATH. There is currently a 2000 character limit for this value. no startScriptEnv
Start Script ArgumentsThe arguments that the Start and Restart operations will pass to the server start script. Each argument should be on a new line - for example: --server-config=standalone-ha-full.xml. As an exception, the value of a space-delimited option can optionally be on the same line as the option - for example: -c default. There is currently a 2000 character limit for this value. no startScriptArgs
Shutdown ScriptThe 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 MethodThe method used to execute the Shut Down operation; defaults to 'JMX MBean'. 'JMX MBean' is the preferred shutdown method and should be used unless there is a specific use case for using a script. no shutdownMethod
Bind AddressThe 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'. If the 'startScriptArgs' property is not set, this property will be used by the Start and Restart operations as the value of the -b option that is passed to the start script. However, this property is deprecated for that purpose and 'startScriptArgs' should be used instead. no bindAddress
Java HomeThe absolute path to a JRE or JDK installation directory containing the JVM that should be used by the operations that start and/or shut down this JBoss AS server; for the Shutdown operation to work when the shutdown method is set to 'shutdown script', the property must be set. For the Start operation, this property is deprecated and will be ignored if the 'startScriptEnv' property is set. no javaHome
Start Wait MaxThe time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to start up. The default is 5 minutes. no startWaitMax
Stop Wait MaxThe time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to stop. The default is 2.5 minutes. no stopWaitMax
Shutdown MBean NameName of the MBean to use when shutting down this server through JMX. yes shutdownMBeanName
Shutdown MBean OperationName 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
Service Availability Refresh IntervalThe amount of time, in minutes, that can elapse for service resource (e.g., EJBs, data sources) availability checks without having to refresh the managed object from the JBoss server. The information used to perform availability checks is cached. This property determines how frequently that data needs to be reloaded from the JBoss server. Any time the managed object is loaded from the server, like for collecting metrics, the availability information is updated and the interval is reset. no serviceAvailabilityRefreshInterval
JBoss AS JVM NameThe 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 3.93. Metrics

NameTypeDescriptionInternal Name
Cluster Partition Nametraitthe name of the cluster partition this server belongs toMCBean|ServerConfig|*|partitionName
Server Nametraitthe name of the active profile (i.e. configuration set) this server is usingMCBean|ServerConfig|*|serverName
Server Home Dirtraitthe 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 Nametraitthe code name for this app server's version (AS 5.0 = Morpheus, AS 5.1 = The Oracle, AS 6.x = Neo)MCBean|MCServer|*|versionName
Build Datetraitthe date this app server was builtMCBean|MCServer|*|buildDate
Start Datetraitthe date and time this app server instance was startedMCBean|MCServer|*|startDate
Active Thread CountmeasurementThe current number of active threads for this app server instanceMCBean|ServerInfo|*|activeThreadCount
Active Thread Group CountmeasurementThe current number of active thread groups for this app server instanceMCBean|ServerInfo|*|activeThreadGroupCount
JVM Free MemorymeasurementAn approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytesMCBean|ServerInfo|*|freeMemory
JVM Max MemorymeasurementThe 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 returnedMCBean|ServerInfo|*|maxMemory
JVM Total MemorymeasurementThe total amount of memory currently available in the app server JVM for current and future objects, measured in bytesMCBean|ServerInfo|*|totalMemory
Total TransactionsmeasurementTotal number of transactions since last restartMCBean|JTA|*|transactionCount
Total Transactions per MinutemeasurementTotal number of transactions since last restartMCBean|JTA|*|transactionCount
Transactions CommittedmeasurementNumber of transactions committed since last restartMCBean|JTA|*|commitCount
Transactions Committed per MinutemeasurementNumber of transactions committed since last restartMCBean|JTA|*|commitCount
Transactions Rolled BackmeasurementNumber of transactions rolled back since last restartMCBean|JTA|*|rollbackCount
Transactions Rolled Back per MinutemeasurementNumber of transactions rolled back since last restartMCBean|JTA|*|rollbackCount

Note

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

Configuration Properties

none

Operations

Table 3.94. Metrics

NameDescription
StartStart 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 DownShut 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.
RestartShut down (if started) and then start this application server.

Package Types

Table 3.95. Package Types

NameCategoryDescription
Cumulative PatchDeployableAutomatically installable application server patches
JAR LibraryDeployableLibrary Jar files deployed in JBoss AS

3.2.1.1. JBossAS5 - JBoss Web Service

Overview

Table 3.96. Overview

Description:JBoss Web Servlet Container
Singleton: yes
Plugin:JBossAS5
Child Resource Types
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.2.1.1.1. JBossAS5 - Connector Service
Overview

Table 3.97. Overview

Description:a JBoss Web Connector
Singleton: no
Plugin:JBossAS5
Child Resource Types
none
Connection Properties

Table 3.98. 

NameDescriptionRequiredInternal Name
Component Type  yes componentType
Component Subtype  yes componentSubtype
Component Name  yes componentName
Protocolthis connector's protocol (e.g. jk, ajp, http) yes protocol
Addressthe IP address this connector listens on yes address
Portthe 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 3.99. Metrics

NameTypeDescriptionInternal Name
Maximum Request Timemeasurementthe maximum time it took to process a request since the last restartmaxTime
Request Countmeasurementthe total number of requests processed since the last restartrequestCount
Request Count per Minutemeasurementthe total number of requests processed since the last restartrequestCount
Error Countmeasurementthe number of errors while processing requests since the last restarterrorCount
Error Count per Minutemeasurementthe number of errors while processing requests since the last restarterrorCount
Current Active Threadsmeasurementthe number of threads for this connector that are currently activeThreadPool|currentThreadsBusy
Current Thread Countmeasurementthe number of threads for this connector that currently existThreadPool|currentThreadCount
Maximum ThreadstraitMaximum number of threads that can be allocated for the thread pool of this connectorThreadPool|maxThreads

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.1.1.2. JBossAS5 - Virtual Host Service
Overview

Table 3.100. Overview

Description:a JBoss Web virtual host
Singleton: no
Plugin:JBossAS5
Child Resource Types
none
Connection Properties

Table 3.101. 

NameDescriptionRequiredInternal Name
Component Type  yes componentType
Component Subtype  yes componentSubtype
Component Name  yes componentName
Namethe 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 3.102. Metrics

NameTypeDescriptionInternal Name
Aliasestraitthe aliases for this virtual host, if anyaliases

Note

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

3.2.1.2. JBossAS5 - No Tx Datasource Service

Overview

Table 3.103. Overview

Description:No Transaction Datasources deployed in the instance of JBoss AS
Singleton: no
Plugin:JBossAS5
Child Resource Types
none
Connection Properties

Table 3.104. 

NameDescriptionRequiredInternal Name
Component Type  yes componentType
Component Subtype  yes componentSubtype
Component Name  yes componentName
Template Name  yes templateName
Component Name PropertyThe 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 3.105. Metrics

NameTypeDescriptionInternal Name
Run StatetraitRun StaterunState
Connection Available?traitcould a connection to the underlying data provider be obtained? Please see the documentation before enabling this metriccustom.connectionAvailable
Pool JNDI Nametraitthe JNDI name of the connection pool for this datasourcepoolJndiName
Available Connection Countmeasurementthe maximum number of connections that are availableavailableConnectionCount
Connection Countmeasurementthe number of connections that are currently in the poolconnectionCount
Connection Created Countmeasurementthe number of connections that have been created since the datasource was last startedconnectionCreatedCount
Connection Destroyed Countmeasurementthe number of connections that have been destroyed since the datasource was last startedconnectionDestroyedCount
In Use Connection Countmeasurementthe number of connections that are currently in useinUseConnectionCount
Local TransactiontraitLocal Transactionlocal-transaction
Max Connections In Use Countmeasurementthe most connections that have been simultaneously in use since this datasource was startedmaxConnectionsInUseCount
Max SizemeasurementMax SizemaxSize
Min SizemeasurementMin SizeminSize

Note

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

Table 3.106. 

NameDescriptionRequiredInternal Name
JNDI NameThe global JNDI Name under which to bind the datasource yes jndi-name
UsernameThe default username when creating a new connection. no user-name
PasswordThe default password when creating a new connection. no password
Minimum Pool SizeThe minimum number of connections the pool should hold. The default is 0. no min-pool-size
Maximum Pool SizeThe maximum number of connections the pool should hold. The default is 10. no max-pool-size
JDBC Driver ClassThe fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver"). yes driver-class
Connection URLThe 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 PropertiesArbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method. no connection-properties
Allocation RetryThe number of times that allocating a connection should be tried before throwing an exception. The default is 0. no allocation-retry
Allocation Retry Wait MillisThe time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). no allocation-retry-wait-millis
Background ValidationSpecify 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 MillisThe 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 MillisecondsIndicates 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 TimeoutThe maximum time, in minutes, a connection may be idle before being closed. The default is 30. no idle-timeout-minutes
Is Same RM Override ValueIf set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). no isSameRM-override-value
Jmx Invoker NameThe ObjectName of the JMX Invoker MBean associated with this datasource. no jmx-invoker-name
MetadataMetadata properties. no metadata
No Tx Separate PoolsIf 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
PrefillWhether 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 SettingsSecurity settings for connections in the pool. no security-domain
Statistics FormatterThe 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 MappingThe name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. no type-mapping
Use Java ContextIndicates 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 MinWhether idle connections below the min-pool-size should be closed. The default is No. no use-strict-min
Validate On MatchThe 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 SQLThe SQL statement to use to check the validity of a pool connection. no check-valid-connection-sql
Connection DefinitionThe connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". no connection-definition
Exception Sorter Class NameThe 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 SQLAn 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 SizeThe 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 TimeoutAny configured query timeout in seconds. A value of 0 means no timeout. The default is 0. no query-timeout
Rar NameThe 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 TimeoutWhether 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 StatementsShould prepared statements be shared? The default is No. no share-prepared-statements
Stale Connection Checker Class NameFully qualified name of the Java class used to check if a connection has become stale. no stale-connection-checker-class-name
Track StatementsWhether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". no track-statements
Transaction IsolationThe Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. no transaction-isolation
Url DelimiterSpecifies 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 NameThe 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 LockAny 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 NameThe 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 3.107. Metrics

NameDescription
FlushFlush the connections in the pool
List Formatted Sub Pool StatisticsObtain a formatted sub pool statistics report
List StatisticsObtain a statistics report
Test ConnectionTest if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained
Package Types
none

3.2.1.3. JBossAS5 - Local Tx Datasource Service

Overview

Table 3.108. Overview

Description:Local Transaction Datasources deployed in the instance of JBoss AS
Singleton: no
Plugin:JBossAS5
Child Resource Types
none
Connection Properties

Table 3.109. 

NameDescriptionRequiredInternal Name
Component Type  yes componentType
Component Subtype  yes componentSubtype
Component Name  yes componentName
Template Name  yes templateName
Component Name PropertyThe 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 3.110. Metrics

NameTypeDescriptionInternal Name
Run StatetraitRun StaterunState
Connection Available?traitcould a connection to the underlying data provider be obtained? Please see the documentation before enabling this metriccustom.connectionAvailable
Pool JNDI Nametraitthe JNDI name of the connection pool for this datasourcepoolJndiName
Available Connection Countmeasurementthe maximum number of connections that are availableavailableConnectionCount
Connection Countmeasurementthe number of connections that are currently in the poolconnectionCount
Connection Created Countmeasurementthe number of connections that have been created since the datasource was last startedconnectionCreatedCount
Connection Destroyed Countmeasurementthe number of connections that have been destroyed since the datasource was last startedconnectionDestroyedCount
In Use Connection Countmeasurementthe number of connections that are currently in useinUseConnectionCount
Local TransactiontraitLocal Transactionlocal-transaction
Max Connections In Use Countmeasurementthe most connections that have been simultaneously in use since this datasource was startedmaxConnectionsInUseCount
Max SizemeasurementMax SizemaxSize
Min SizemeasurementMin SizeminSize

Note

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

Table 3.111. 

NameDescriptionRequiredInternal Name
JNDI NameThe global JNDI Name under which to bind the datasource yes jndi-name
UsernameThe default username when creating a new connection. no user-name
PasswordThe default password when creating a new connection. no password
Minimum Pool SizeThe minimum number of connections the pool should hold. The default is 0. no min-pool-size
Maximum Pool SizeThe maximum number of connections the pool should hold. The default is 10. no max-pool-size
JDBC Driver ClassThe fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver"). yes driver-class
Connection URLThe 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 PropertiesArbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method. no connection-properties
Allocation RetryThe number of times that allocating a connection should be tried before throwing an exception. The default is 0. no allocation-retry
Allocation Retry Wait MillisThe time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). no allocation-retry-wait-millis
Background ValidationSpecify 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 MillisThe 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 MillisecondsIndicates 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 TimeoutThe maximum time, in minutes, a connection may be idle before being closed. The default is 30. no idle-timeout-minutes
Is Same RM Override ValueIf set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). no isSameRM-override-value
Jmx Invoker NameThe ObjectName of the JMX Invoker MBean associated with this datasource. no jmx-invoker-name
MetadataMetadata properties. no metadata
No Tx Separate PoolsIf 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
PrefillWhether 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 SettingsSecurity settings for connections in the pool. no security-domain
Statistics FormatterThe 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 MappingThe name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. no type-mapping
Use Java ContextIndicates 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 MinWhether idle connections below the min-pool-size should be closed. The default is No. no use-strict-min
Validate On MatchThe 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 SQLThe SQL statement to use to check the validity of a pool connection. no check-valid-connection-sql
Connection DefinitionThe connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". no connection-definition
Exception Sorter Class NameThe 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 SQLAn 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 SizeThe 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 TimeoutAny configured query timeout in seconds. A value of 0 means no timeout. The default is 0. no query-timeout
Rar NameThe 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 TimeoutWhether 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 StatementsShould prepared statements be shared? The default is No. no share-prepared-statements
Stale Connection Checker Class NameFully qualified name of the Java class used to check if a connection has become stale. no stale-connection-checker-class-name
Track StatementsWhether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". no track-statements
Transaction IsolationThe Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. no transaction-isolation
Url DelimiterSpecifies 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 NameThe 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 LockAny 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 NameThe 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 3.112. Metrics

NameDescription
FlushFlush the connections in the pool
List Formatted Sub Pool StatisticsObtain a formatted sub pool statistics report
List StatisticsObtain a statistics report
Test ConnectionTest if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained
Package Types
none

3.2.1.4. JBossAS5 - XA Datasource Service

Overview

Table 3.113. Overview

Description:XA Datasources deployed in the instance of JBoss AS
Singleton: no
Plugin:JBossAS5
Child Resource Types
none
Connection Properties

Table 3.114. 

NameDescriptionRequiredInternal Name
Component Type  yes componentType
Component Subtype  yes componentSubtype
Component Name  yes componentName
Template Name  yes templateName
Component Name PropertyThe 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 3.115. Metrics

NameTypeDescriptionInternal Name
Run StatetraitRun StaterunState
Connection Available?traitcould a connection to the underlying data provider be obtained? Please see the documentation before enabling this metriccustom.connectionAvailable
Pool JNDI Nametraitthe JNDI name of the connection pool for this datasourcepoolJndiName
Available Connection Countmeasurementthe maximum number of connections that are availableavailableConnectionCount
Connection Countmeasurementthe number of connections that are currently in the poolconnectionCount
Connection Created Countmeasurementthe number of connections that have been created since the datasource was last startedconnectionCreatedCount
Connection Destroyed Countmeasurementthe number of connections that have been destroyed since the datasource was last startedconnectionDestroyedCount
In Use Connection Countmeasurementthe number of connections that are currently in useinUseConnectionCount
Local TransactiontraitLocal Transactionlocal-transaction
Max Connections In Use Countmeasurementthe most connections that have been simultaneously in use since this datasource was startedmaxConnectionsInUseCount
Max SizemeasurementMax SizemaxSize
Min SizemeasurementMin SizeminSize

Note

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