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
Tyler Kelly
tkelly@redhat.comJared Morgan
jmorgan@redhat.comZach Rhoads
zach@redhat.comElla Deon Ballard
dlackey@redhat.comAbstract
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-5 | June 30, 2015 | Jared Morgan | |
| |||
| Revision 3.3-10 | November 17, 2014 | Jared Morgan | |
| |||
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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.3. Metrics
| Name | Description |
|---|---|
| Run Autodiscovery | Run an immediate discovery to search for new resources |
| View Process List | View 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.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.6. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.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.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | Directory 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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Directory usage | measurement | Disk usage of this directory | usage |
| Number of files | measurement | Number of files in the directory | files |
| Number of items | measurement | Number 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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.18. Metrics
| Name | Description |
|---|---|
| Run Autodiscovery | Run an immediate discovery to search for new resources |
| View Process List | View 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.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.21. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.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.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | Directory 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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Directory usage | measurement | Disk usage of this directory | usage |
| Number of files | measurement | Number of files in the directory | files |
| Number of items | measurement | Number 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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.33. Metrics
| Name | Description |
|---|---|
| Run Autodiscovery | Run an immediate discovery to search for new resources |
| View Process List | View 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.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.36. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.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.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | Directory 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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Directory usage | measurement | Disk usage of this directory | usage |
| Number of files | measurement | Number of files in the directory | files |
| Number of items | measurement | Number 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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.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
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.48. Metrics
| Name | Description |
|---|---|
| Run Autodiscovery | Run an immediate discovery to search for new resources |
| View Process List | View 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.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Enable Content Discovery | If true, attempts will be made to discover installed packages on this platform | yes | enableContentDiscovery |
| Enable Internal Yum Server | If true, an internal yum server will be started in order to process yum content requests made on the local machine. | yes | enableInternalYumServer |
| Yum server port | The port the plugin will listen on in order to process yum requests. This is ignored if the internal yum server is not enabled. | yes | yumPort |
| Metadata Cache Timeout | The time, in seconds, that the package metadata will always be considered valid. After the cache has lived this long or longer, the cache will be checked to see if it is stale, and if so, will be refreshed. | no | metadataCacheTimeout |
| Logs | yes | logs |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.51. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
| Distribution Name | trait | name of the Linux distribution | distro.name |
| Distribution Version | trait | version of the Linux distribution | distro.version |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.52. Metrics
| Name | Description |
|---|---|
| Run Autodiscovery | Run an immediate discovery to search for new resources |
| View Process List | View running processes on this system |
| Clean Yum Metadata Cache | Deletes all cached package metadata |
Package Types
Table 1.53. Package Types
| Name | Category | Description |
|---|---|---|
| RPM File | Deployable | Red 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.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |