Red Hat Training

A Red Hat training course is available for Red Hat JBoss Operations Network

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 table