vFabric Cloud Application Platform 5.0
Supported Platforms and Configurations
Getting Started with vFabric Cloud Application Platform
Quick Start Guide
Introducing vFabric Cloud Application Platform 5.0
vFabric Platform Application Services and Packages
vFabric tc Server 2.6 (Spring Edition)
EM4J 1.0 for Improved Memory Management of Java Workloads
Spring Insight Operations 1.5 Engineered for vSphere, Spring, and Production Environments
vFabric Hyperic 4.6
tc Server Plug-In for Easier Management and Monitoring
Spring Insight Plug-In for Detailed Application Metrics
vFabric GemFire 6.6 (Application Cache Node)
HTTP Session Replication
vFabric RabbitMQ 2.4
vFabric Web Server 5.0
vFabric SQLFire 1.0
Simplified VM-Based Licensing Model
Integration with vSphere
Engineered for Spring-Built Applications
vFabric Licensing
How Licensing Works with Standalone vFabric Components
How Licensing Works with vFabric Standard and vFabric Advanced
Using the vFabric License Check Tool
Check the Validity of an Existing License Key
Display the Component Events File in Readable Format
License Usage Reporting
Installing vFabric Platform
vSphere, JVM, and Operating System Support
Install vFabric License Server on Your vCenter Server
Activate vFabric Platform Licenses
RHEL: Installing vFabric Components from the VMware YUM Repository
Important Information About Installing Using RPMs
Install the vFabric Repository RPMs
Pre-Installation Instructions
Pre-Installation Instructions for vFabric Hyperic Server: Create Properties File
Pre-Installation Instructions for vFabric RabbitMQ: Install Erlang
Install vFabric Components: General Instructions
Post-Installation Instructions
Post-Installation Instructions for tc Server
Post-Installation Instructions for Spring Insight Operations (Agent and Dashboard)
Post-Installation Instructions for Web Server
Post-Installation Instructions for GemFire
Post-Installation Instructions for SQLFire
Post-Installation Instructions for RabbitMQ
Post-Installation Instructions for Hyperic Server
Post-Installation Instructions for Hyperic Agent
Windows/Linux: Example Walkthrough of Installing Component from Download Page
Monitor vFabric License Usage
Upgrade vFabric License Server
Uninstall vFabric License Server from vCenter Server
RHEL: Upgrade vFabric Components From the VMware YUM Repository
Supported Platforms and Configurations
Getting Started with vFabric Cloud Application Platform
Quick Start Guide
Introducing vFabric Cloud Application Platform 5.0
vFabric Platform Application Services and Packages
vFabric tc Server 2.6 (Spring Edition)
EM4J 1.0 for Improved Memory Management of Java Workloads
Spring Insight Operations 1.5 Engineered for vSphere, Spring, and Production Environments
vFabric Hyperic 4.6
tc Server Plug-In for Easier Management and Monitoring
Spring Insight Plug-In for Detailed Application Metrics
vFabric GemFire 6.6 (Application Cache Node)
HTTP Session Replication
vFabric RabbitMQ 2.4
vFabric Web Server 5.0
vFabric SQLFire 1.0
Simplified VM-Based Licensing Model
Integration with vSphere
Engineered for Spring-Built Applications
vFabric Licensing
How Licensing Works with Standalone vFabric Components
How Licensing Works with vFabric Standard and vFabric Advanced
Using the vFabric License Check Tool
Check the Validity of an Existing License Key
Display the Component Events File in Readable Format
License Usage Reporting
Installing vFabric Platform
vSphere, JVM, and Operating System Support
Install vFabric License Server on Your vCenter Server
Activate vFabric Platform Licenses
RHEL: Installing vFabric Components from the VMware YUM Repository
Important Information About Installing Using RPMs
Install the vFabric Repository RPMs
Pre-Installation Instructions
Pre-Installation Instructions for vFabric Hyperic Server: Create Properties File
Pre-Installation Instructions for vFabric RabbitMQ: Install Erlang
Install vFabric Components: General Instructions
Post-Installation Instructions
Post-Installation Instructions for tc Server
Post-Installation Instructions for Spring Insight Operations (Agent and Dashboard)
Post-Installation Instructions for Web Server
Post-Installation Instructions for GemFire
Post-Installation Instructions for SQLFire
Post-Installation Instructions for RabbitMQ
Post-Installation Instructions for Hyperic Server
Post-Installation Instructions for Hyperic Agent
Windows/Linux: Example Walkthrough of Installing Component from Download Page
Monitor vFabric License Usage
Upgrade vFabric License Server
Uninstall vFabric License Server from vCenter Server
RHEL: Upgrade vFabric Components From the VMware YUM Repository
vFabric Web Server 5.0
vFabric Web Server Installation and Configuration
Overview of vFabric Web Server
Complete Packages and Modules in vFabric Web Server 5.0
mod_fcgid Implementation of Connector to FastCGI
Open SSL 0.9.8r Supports SSLFIPS and SSLInsecureRenegotiation Directives
Supported Platforms
Installing vFabric Web Server
RHEL: Install vFabric Web Server from the VMware Package Repository
Linux: Install vFabric Web Server from a Self-Extracting ZIP
Windows: Install vFabric Web Server from a ZIP File
Description of vFabric Web Server Installation
Creating and Using vFabric Web Server Instances
Description of vFabric Web Server Instances
Create vFabric Web Server Instances
newserver Prompts and Command Reference
Linux: Start and Stop vFabric Web Server Instances
Windows: Start and Stop vFabric Web Server Instances
Serve a Sample HTML File from Your vFabric Web Server Instance
Configuring vFabric Web Server Instances
Using Sample Configuration Files to Enable Features and Modify Configuration
Configure Load Balancing Between Two or More tc Runtime Instances
Additional Documentation
vFabric Web Server Installation and Configuration
Overview of vFabric Web Server
Complete Packages and Modules in vFabric Web Server 5.0
mod_fcgid Implementation of Connector to FastCGI
Open SSL 0.9.8r Supports SSLFIPS and SSLInsecureRenegotiation Directives
Supported Platforms
Installing vFabric Web Server
RHEL: Install vFabric Web Server from the VMware Package Repository
Linux: Install vFabric Web Server from a Self-Extracting ZIP
Windows: Install vFabric Web Server from a ZIP File
Description of vFabric Web Server Installation
Creating and Using vFabric Web Server Instances
Description of vFabric Web Server Instances
Create vFabric Web Server Instances
newserver Prompts and Command Reference
Linux: Start and Stop vFabric Web Server Instances
Windows: Start and Stop vFabric Web Server Instances
Serve a Sample HTML File from Your vFabric Web Server Instance
Configuring vFabric Web Server Instances
Using Sample Configuration Files to Enable Features and Modify Configuration
Configure Load Balancing Between Two or More tc Runtime Instances
Additional Documentation
vFabric tc Server 2.6
Getting Started with vFabric tc Server
Quick Start
Overview of tc Server
Usability Enhancements to Apache Tomcat
Easy Configuration and Monitoring with the Hyperic tc Server Plug-In
Agile Application Development with Spring Insight Developer
Application Cluster Monitoring with Spring Insight Operations
Enhanced Diagnostics
tc Server Command-Line Interface and Scripts
tc Server Editions
Developer Edition
Standard Edition
Spring Edition
How tc Server and Hyperic Work Together
Related Documentation
Comparing tc Runtime and Apache Tomcat
Standard Application Server Features
Enterprise Application Server Features
Advanced Configuration Features
Operations Features
Installing vFabric tc Server
Meeting System Software Requirements for tc Server
Required: Install JDK or JRE
Possibly Required: Install a Database Server
Possibly Required: Install GNUtar
Installing tc Server as Part of vFabric Cloud Application Platform
Install tc Server Developer Edition
Install tc Server Standard Edition (tc Runtime Only)
Install tc Server Standard Edition and Hyperic Management Components
Activate a Local vFabric tc Server License
Overview of tc Server Directories, Variables, and Configuration Files
tc Server Variables
tc Runtime Instance Directory Structure
tc Runtime Instance Configuration Files
Enabling Bash Completion for tc Server Scripts
Setting Up Unix Users for tc Server and Hyperic
Creating Users and Groups for Hyperic Agent and tc Server
Setting the tc Server User in Hyperic
Enabling Hyperic Agent Access to su or sudo
Deploying Web Applications on Unix Systems
Post-Installation Tasks
Creating a New tc Runtime Instance
Creating tc Runtime Instances: Typical Steps
tcruntime-instance.sh Reference
The create Command
The modify-version Command
The upgrade Command
The list Command
Getting Help for tcruntime-instance
Pinning tc Runtime Instances to a Specific Version
Best Practice: Naming tc Runtime Instances
Creating a tc Runtime Instance with a Template
Templates Provided by tc Runtime
Differences Between the Separate and Combined Layouts
Starting and Stopping tc Runtime Instances
Unix: Starting and Stopping tc Runtime Instances Interactively Using tcruntime-ctl.sh
Unix: Starting tc Runtime Instances Automatically at System Boot Time
About Users and Permissions
Installing the init.d.sh Script
Using the /etc/init.d Script
Windows: Starting and Stopping tc Runtime Instances as Windows Services
Windows Java Service Wrapper
tcruntime-ctl Command Reference
Windows: Setting the Logon-as-Service Right for a Windows User
Windows: Installing the Hyperic Server and Agents as Windows Services
Starting and Stopping the Hyperic Server and Agents
Unix: Starting and Stopping the Hyperic Server and Agent
Windows: Starting and Stopping the Hyperic Server and Agent
Getting Started with the Hyperic User Interface
Deploying Applications to tc Runtime Instances
Deploying Applications Using Tomcat Manager (Developer Edition Only)
Deploying Multiple Versions of the Same Application
Uninstalling tc Server: Typical Steps
Uninstalling Hyperic Server
Uninstalling Hyperic Agent
Uninstalling tc Runtime
Upgrade and Migration Guide
Upgrading a 2.0.X, 2.1.X, or 2.5.X tc Server Installation to 2.6
Upgrade Hyperic Server to Hyperic 4.6
Install Hyperic Agent 4.6
Install tc Server 2.6
Upgrade Existing tc Runtime Instances to 2.6
Upgrading a 2.6.X tc Runtime to the Latest Version
Understanding the Overall tc Server Upgrade Process
tc Runtime Upgrade Procedure
Tutorial: Using Hyperic to Configure and Manage tc Runtime Instances
Before You Begin
Restart a tc Runtime Instance
Reconfigure a tc Runtime Instance
Deploy a Web Application to a tc Server Runtime Instance
Add tc Runtime Instances to the Favorite Resources Portlet
Create an Hyperic Group of Multiple tc Runtime Instances
Monitoring tc Runtime Instances
Manage the Preconfigured Deadlock Detected Alert
Tutorial: Very Simple HelloWorld Web Application
Before You Begin
Creating and Deploying the HelloWorld Web Application
Java Source of the Hello.java Servlet
Description of the Hello Servlet
JSP Source for the hello.jsp JSP
Description of the hello.jsp
Sample web.xml File
Description of the web.xml File
Sample Default index.html File
Ant Build File to Compile and Package the Example
Description of the build.xml File
Troubleshooting
Hyperic: Resources Not Showing up in the Hyperic User Interface
Hyperic: Errors When Trying to Add an Auto-Discovered Resource
Hyperic Agent: Errors When Starting on Solaris
tc Runtime: Hot Redeploy/Stop/Undeploy on Windows Fails
tc Runtime: Error When Running a Web Application on tc Runtime and Using SpringSource Tool Suite
tc Runtime: JVM Performing a Full GC
vFabric tc Server Administration
Overview of tc Server Administration
Configuring and Monitoring tc Runtime Instances Using Hyperic
User Permissions Required to Use the tc Server Hyperic Plug-in Features
Managing tc Runtime-Related Hyperic Alerts
Viewing and Changing the Preconfigured Alerts
Viewing and Changing the Metric Collection Interval
Deadlock Detection
Excessive Time in Garbage Collection
Enabling the Slow or Failed Request Alert
Enabling JDBC Connection Monitoring
Securing the Hyperic Server
Configuring a tc Runtime Instance Manually
Configuration Files and Templates
Simple tc Runtime Configuration
Description of the Basic server.xml File
Adding a System Properties Listener
Setting Up a High-Concurrency JDBC Datasource
Comparing the DBCP Datasource and the tc Runtime Datasource
Configuring the tc Runtime High-Concurrency JDBC Datasource
Description of the High Concurrency JDBC Datasource
Configuring SSL
Description of the SSL Connector
Using an APR Connector to Configure SSL
Creating a Simple Keystore File For Both SSL and OpenSSL
Using the Apache Portable Runtime (APR)
Comparing the APR-Enabled server.xml File with Out-of-the-Box server.xml
Configuring Logging for tc Runtime
Configuring the JULI Implementation of java.util.logging
Logging Levels for java.util.logging
Configuring Asynchronous Logging
Asynchronous Logging System Properties
Configuring log4j
Specifying Included Packages With log4j Logging
Configuring a Web Application with log4j Logging
Updating Logging Parameters Dynamically
Setting a New Logging Level for a Logger
Example: Create a New Log File and Redirect Debug Output To It
Obfuscating Passwords in tc Runtime Configuration Files
Using Base64 Encoding to Obfuscate Passwords
Using a Passphrase to Encrypt Passwords
Storing Passphrases and Encrypted Properties in Separate Files
Being Prompted for the Passphrase When you Start the Instance
General Security Best Practices
Configuring an Oracle DataSource With Proxied Usernames
Reporting Status for a Deployed Application, Host, or Engine
Enabling Thread Diagnostics
Using the tc Server Command-Line Interface
Overview of tcsadmin
HQ API Command-Line Interface (hqapi.sh)
Tips for Windows Users
Downloading the tcsadmin Command-Line Interface
General Syntax of the tcsadmin Command-Line Interface
List of Commands
Connection Parameters
Using Special Characters as Parameter Values
Group Command Behavior
Exit Codes
Getting Help
Inventory Commands
list-servers
modify-server
list-groups
create-group
add-server-to-group
remove-server-from-group
delete-group
Application Management Commands
list-applications
deploy-application
start-application
stop-application
reload-application
undeploy-application
tc Runtime and Group Configuration Commands
get-file
put-file
list-jvm-options
set-jvm-options
tc Runtime and Group Control Commands: Reference
start
stop
restart
Creating tc Runtime Templates
Parts of a Template
README.txt
Environment
Automatic Boilerplate Decoration
Memory and Stack Size JAVA_OPTS Filtering
JVM Type Specific Properties
OS Family Specific Properties
VM Architecture Specific Properties
Combining Values in Qualified Properties
XML Configuration Fragments
Logging Properties Fragment
Other Files
Property Substitution
Implicit Properties
Configuration Prompts
Platform Specificity
Files Excluded on Unix
Files Excluded on Windows
Template Files Excluded
Splitting a Template for Tomcat Versions
Enabling Clustering for High Availability
Additional Cluster Documentation from Apache
High-Level Steps for Creating and Using tc Runtime Clusters
Web Application Requirements for Using Session Replication
Network Considerations
Configuring a Simple tc Runtime Cluster
Advanced Cluster Configuration Options
Changing the Default Multicast Address and Port
Changing the Maximum Time After Which an Unresponsive Cluster Member Is Dropped
Replicating a Session to a Single Backup Member
Elastic Memory for Java
What is Elastic Memory for Java?
How ESXi and EM4J Improve Memory Utilization
Transparent Page Sharing
Memory Compression
VMware Tools Balloon
EM4J Balloon
How EM4J Affects Memory and Application Performance
Setting Up Elastic Memory for Java
Platform Support
EM4J Considerations and Limitations
Enable EM4J in the Virtual Machine
Create and Start an EM4J-Enabled tc Runtime Instance
Configure an EM4J-Enabled tc Runtime Instance
Using Elastic Memory for Java with Apache Tomcat
Configuring Java Applications for VMware
Configuring and Sizing a Virtual Machine for Java Applications
Over-Committing Memory with EM4J
Distributing Multiple tc Runtime Instances Among Virtual Machines
Monitoring and Managing EM4J
Monitoring Memory with vSphere Client
Monitoring Memory with vSphere Web Client
Setting Up the vSphere Web Client for EM4J
Download and Install the vSphere Web Client EM4J Plug-in
Setting the Required JVM System Properties
Running the Console Guest Collector
Disabling the vSphere Web Client EM4J Plug-in
Viewing Java Workloads in the vSphere Web Client
Summary Tab
Alerts Tab
Resource Management Tab
Monitoring Memory with the EM4J MBeans
Viewing EM4J MBeans with Hyperic Server
Viewing EM4J MBeans with JConsole
BalloonConfig
VmBalloonState
JvmBalloonState
BalloonInternals
EM4J and DRS or vMotion
Virtual Machine Suspend and Resume
Spring Insight Developer
What Is Spring Insight Developer?
What You Can Do with Spring Insight
Agile Development
QA Rear View Mirror
Load and Performance Testing
Extended Customization with the Spring Insight Developer Kit
Browser Performance Data from Integration with Google SpeedTracer
How Spring Insight Works
Supported Environments
Installing and Configuring Spring Insight Developer
Installing Spring Insight Developer
Configuring Spring Insight
Increasing Memory when Using Spring Insight
Using Spring Insight
Before You Begin
Invoking Spring Insight in your Browser
Browsing all Applications and End Points
Viewing Recent Activity of Your Application
Filtering Trace Details
Exporting and Importing Traces
Customizing End Point Thresholds
Viewing Spring Insight Data In Google Speed Tracer
Using Annotations To Customize Spring Insight Data For Your Application
@InsightOperation Reference
@InsightEndPoint Reference
Example of Using the Spring Insight Annotations
Getting the Annotation JAR File
Overview of Spring Insight Development
Prerequisites for Installing the Spring Insight Developer Kit
Installing the Spring Insight Developer Kit
Using the Spring Insight Plug-ins
Relationships Among Spring Insight Objects and Plug-ins
Building and Deploying the Sample Plug-in
Using the Sample Plug-in
Sample Plug-in Files
CashMoneyOperation.java
CashMoneyOperationCollectionAspect.aj
insight-plugin-myplugin.xml
cash_money_operation.ftl
Collecting Runtime Data
Operation Rendering in the UI
EndPointAnalyzer
Building a Plug-in from the Source Code
Tutorial: Creating an Insight Plug-in with the Insight Development Kit
Core Plug-in Reference
annotation
grails
hibernate
jdbc
method-endpoint
servlet
spring-core
spring-tx
spring-web
tomcat
Server-Based Instrumentation
Spring Insight Operations
Introduction to Spring Insight Operations
How Spring Insight Operations Works
Difference Between Spring Insight Operations and Spring Insight Developer
Use Cases for Spring Insight Developer and Spring Insight Operations
Agile Development
QA Rear-View Mirror
Testing Load and Performance
Extended Customization with the Spring Insight Developer Kit
Browser Performance Data from Integration with Google SpeedTracer
Production Application Monitoring and Troubleshooting
Supported Environments
Installing and Configuring Spring Insight Operations
Download tc Server and Spring Insight Operations
Install and Start Spring Insight Dashboard
Install and Start Spring Insight Agent
Connect to the Spring Insight Dashboard Server
Configure Spring Insight Dashboard Server Users
Configure Spring Insight Operations
Properties File for Spring Insight Dashboard
Properties File for Spring Insight Agent
(Optional) Configure the Spring Insight Dashboard to Authenticate with LDAP
(Optional) Configure Spring Insight for SSL
Set Up SSL for Spring Insight Dashboard
Set Up SSL for Spring Insight Agents
(Optional) Increase tc Runtime Memory
Using Spring Insight Operations
Before You Begin
Invoking Spring Insight Operations in your Browser
Browsing all Applications, Servers, and End Points
Viewing Recent Activity of Your Application
Filtering Trace Details
Exporting and Importing Traces
Customizing End Point Thresholds
Viewing Spring Insight Data In Google Speed Tracer
Getting Started with vFabric tc Server
Quick Start
Overview of tc Server
Usability Enhancements to Apache Tomcat
Easy Configuration and Monitoring with the Hyperic tc Server Plug-In
Agile Application Development with Spring Insight Developer
Application Cluster Monitoring with Spring Insight Operations
Enhanced Diagnostics
tc Server Command-Line Interface and Scripts
tc Server Editions
Developer Edition
Standard Edition
Spring Edition
How tc Server and Hyperic Work Together
Related Documentation
Comparing tc Runtime and Apache Tomcat
Standard Application Server Features
Enterprise Application Server Features
Advanced Configuration Features
Operations Features
Installing vFabric tc Server
Meeting System Software Requirements for tc Server
Required: Install JDK or JRE
Possibly Required: Install a Database Server
Possibly Required: Install GNUtar
Installing tc Server as Part of vFabric Cloud Application Platform
Install tc Server Developer Edition
Install tc Server Standard Edition (tc Runtime Only)
Install tc Server Standard Edition and Hyperic Management Components
Activate a Local vFabric tc Server License
Overview of tc Server Directories, Variables, and Configuration Files
tc Server Variables
tc Runtime Instance Directory Structure
tc Runtime Instance Configuration Files
Enabling Bash Completion for tc Server Scripts
Setting Up Unix Users for tc Server and Hyperic
Creating Users and Groups for Hyperic Agent and tc Server
Setting the tc Server User in Hyperic
Enabling Hyperic Agent Access to su or sudo
Deploying Web Applications on Unix Systems
Post-Installation Tasks
Creating a New tc Runtime Instance
Creating tc Runtime Instances: Typical Steps
tcruntime-instance.sh Reference
The create Command
The modify-version Command
The upgrade Command
The list Command
Getting Help for tcruntime-instance
Pinning tc Runtime Instances to a Specific Version
Best Practice: Naming tc Runtime Instances
Creating a tc Runtime Instance with a Template
Templates Provided by tc Runtime
Differences Between the Separate and Combined Layouts
Starting and Stopping tc Runtime Instances
Unix: Starting and Stopping tc Runtime Instances Interactively Using tcruntime-ctl.sh
Unix: Starting tc Runtime Instances Automatically at System Boot Time
About Users and Permissions
Installing the init.d.sh Script
Using the /etc/init.d Script
Windows: Starting and Stopping tc Runtime Instances as Windows Services
Windows Java Service Wrapper
tcruntime-ctl Command Reference
Windows: Setting the Logon-as-Service Right for a Windows User
Windows: Installing the Hyperic Server and Agents as Windows Services
Starting and Stopping the Hyperic Server and Agents
Unix: Starting and Stopping the Hyperic Server and Agent
Windows: Starting and Stopping the Hyperic Server and Agent
Getting Started with the Hyperic User Interface
Deploying Applications to tc Runtime Instances
Deploying Applications Using Tomcat Manager (Developer Edition Only)
Deploying Multiple Versions of the Same Application
Uninstalling tc Server: Typical Steps
Uninstalling Hyperic Server
Uninstalling Hyperic Agent
Uninstalling tc Runtime
Upgrade and Migration Guide
Upgrading a 2.0.X, 2.1.X, or 2.5.X tc Server Installation to 2.6
Upgrade Hyperic Server to Hyperic 4.6
Install Hyperic Agent 4.6
Install tc Server 2.6
Upgrade Existing tc Runtime Instances to 2.6
Upgrading a 2.6.X tc Runtime to the Latest Version
Understanding the Overall tc Server Upgrade Process
tc Runtime Upgrade Procedure
Tutorial: Using Hyperic to Configure and Manage tc Runtime Instances
Before You Begin
Restart a tc Runtime Instance
Reconfigure a tc Runtime Instance
Deploy a Web Application to a tc Server Runtime Instance
Add tc Runtime Instances to the Favorite Resources Portlet
Create an Hyperic Group of Multiple tc Runtime Instances
Monitoring tc Runtime Instances
Manage the Preconfigured Deadlock Detected Alert
Tutorial: Very Simple HelloWorld Web Application
Before You Begin
Creating and Deploying the HelloWorld Web Application
Java Source of the Hello.java Servlet
Description of the Hello Servlet
JSP Source for the hello.jsp JSP
Description of the hello.jsp
Sample web.xml File
Description of the web.xml File
Sample Default index.html File
Ant Build File to Compile and Package the Example
Description of the build.xml File
Troubleshooting
Hyperic: Resources Not Showing up in the Hyperic User Interface
Hyperic: Errors When Trying to Add an Auto-Discovered Resource
Hyperic Agent: Errors When Starting on Solaris
tc Runtime: Hot Redeploy/Stop/Undeploy on Windows Fails
tc Runtime: Error When Running a Web Application on tc Runtime and Using SpringSource Tool Suite
tc Runtime: JVM Performing a Full GC
vFabric tc Server Administration
Overview of tc Server Administration
Configuring and Monitoring tc Runtime Instances Using Hyperic
User Permissions Required to Use the tc Server Hyperic Plug-in Features
Managing tc Runtime-Related Hyperic Alerts
Viewing and Changing the Preconfigured Alerts
Viewing and Changing the Metric Collection Interval
Deadlock Detection
Excessive Time in Garbage Collection
Enabling the Slow or Failed Request Alert
Enabling JDBC Connection Monitoring
Securing the Hyperic Server
Configuring a tc Runtime Instance Manually
Configuration Files and Templates
Simple tc Runtime Configuration
Description of the Basic server.xml File
Adding a System Properties Listener
Setting Up a High-Concurrency JDBC Datasource
Comparing the DBCP Datasource and the tc Runtime Datasource
Configuring the tc Runtime High-Concurrency JDBC Datasource
Description of the High Concurrency JDBC Datasource
Configuring SSL
Description of the SSL Connector
Using an APR Connector to Configure SSL
Creating a Simple Keystore File For Both SSL and OpenSSL
Using the Apache Portable Runtime (APR)
Comparing the APR-Enabled server.xml File with Out-of-the-Box server.xml
Configuring Logging for tc Runtime
Configuring the JULI Implementation of java.util.logging
Logging Levels for java.util.logging
Configuring Asynchronous Logging
Asynchronous Logging System Properties
Configuring log4j
Specifying Included Packages With log4j Logging
Configuring a Web Application with log4j Logging
Updating Logging Parameters Dynamically
Setting a New Logging Level for a Logger
Example: Create a New Log File and Redirect Debug Output To It
Obfuscating Passwords in tc Runtime Configuration Files
Using Base64 Encoding to Obfuscate Passwords
Using a Passphrase to Encrypt Passwords
Storing Passphrases and Encrypted Properties in Separate Files
Being Prompted for the Passphrase When you Start the Instance
General Security Best Practices
Configuring an Oracle DataSource With Proxied Usernames
Reporting Status for a Deployed Application, Host, or Engine
Enabling Thread Diagnostics
Using the tc Server Command-Line Interface
Overview of tcsadmin
HQ API Command-Line Interface (hqapi.sh)
Tips for Windows Users
Downloading the tcsadmin Command-Line Interface
General Syntax of the tcsadmin Command-Line Interface
List of Commands
Connection Parameters
Using Special Characters as Parameter Values
Group Command Behavior
Exit Codes
Getting Help
Inventory Commands
list-servers
modify-server
list-groups
create-group
add-server-to-group
remove-server-from-group
delete-group
Application Management Commands
list-applications
deploy-application
start-application
stop-application
reload-application
undeploy-application
tc Runtime and Group Configuration Commands
get-file
put-file
list-jvm-options
set-jvm-options
tc Runtime and Group Control Commands: Reference
start
stop
restart
Creating tc Runtime Templates
Parts of a Template
README.txt
Environment
Automatic Boilerplate Decoration
Memory and Stack Size JAVA_OPTS Filtering
JVM Type Specific Properties
OS Family Specific Properties
VM Architecture Specific Properties
Combining Values in Qualified Properties
XML Configuration Fragments
Logging Properties Fragment
Other Files
Property Substitution
Implicit Properties
Configuration Prompts
Platform Specificity
Files Excluded on Unix
Files Excluded on Windows
Template Files Excluded
Splitting a Template for Tomcat Versions
Enabling Clustering for High Availability
Additional Cluster Documentation from Apache
High-Level Steps for Creating and Using tc Runtime Clusters
Web Application Requirements for Using Session Replication
Network Considerations
Configuring a Simple tc Runtime Cluster
Advanced Cluster Configuration Options
Changing the Default Multicast Address and Port
Changing the Maximum Time After Which an Unresponsive Cluster Member Is Dropped
Replicating a Session to a Single Backup Member
Elastic Memory for Java
What is Elastic Memory for Java?
How ESXi and EM4J Improve Memory Utilization
Transparent Page Sharing
Memory Compression
VMware Tools Balloon
EM4J Balloon
How EM4J Affects Memory and Application Performance
Setting Up Elastic Memory for Java
Platform Support
EM4J Considerations and Limitations
Enable EM4J in the Virtual Machine
Create and Start an EM4J-Enabled tc Runtime Instance
Configure an EM4J-Enabled tc Runtime Instance
Using Elastic Memory for Java with Apache Tomcat
Configuring Java Applications for VMware
Configuring and Sizing a Virtual Machine for Java Applications
Over-Committing Memory with EM4J
Distributing Multiple tc Runtime Instances Among Virtual Machines
Monitoring and Managing EM4J
Monitoring Memory with vSphere Client
Monitoring Memory with vSphere Web Client
Setting Up the vSphere Web Client for EM4J
Download and Install the vSphere Web Client EM4J Plug-in
Setting the Required JVM System Properties
Running the Console Guest Collector
Disabling the vSphere Web Client EM4J Plug-in
Viewing Java Workloads in the vSphere Web Client
Summary Tab
Alerts Tab
Resource Management Tab
Monitoring Memory with the EM4J MBeans
Viewing EM4J MBeans with Hyperic Server
Viewing EM4J MBeans with JConsole
BalloonConfig
VmBalloonState
JvmBalloonState
BalloonInternals
EM4J and DRS or vMotion
Virtual Machine Suspend and Resume
Spring Insight Developer
What Is Spring Insight Developer?
What You Can Do with Spring Insight
Agile Development
QA Rear View Mirror
Load and Performance Testing
Extended Customization with the Spring Insight Developer Kit
Browser Performance Data from Integration with Google SpeedTracer
How Spring Insight Works
Supported Environments
Installing and Configuring Spring Insight Developer
Installing Spring Insight Developer
Configuring Spring Insight
Increasing Memory when Using Spring Insight
Using Spring Insight
Before You Begin
Invoking Spring Insight in your Browser
Browsing all Applications and End Points
Viewing Recent Activity of Your Application
Filtering Trace Details
Exporting and Importing Traces
Customizing End Point Thresholds
Viewing Spring Insight Data In Google Speed Tracer
Using Annotations To Customize Spring Insight Data For Your Application
@InsightOperation Reference
@InsightEndPoint Reference
Example of Using the Spring Insight Annotations
Getting the Annotation JAR File
Overview of Spring Insight Development
Prerequisites for Installing the Spring Insight Developer Kit
Installing the Spring Insight Developer Kit
Using the Spring Insight Plug-ins
Relationships Among Spring Insight Objects and Plug-ins
Building and Deploying the Sample Plug-in
Using the Sample Plug-in
Sample Plug-in Files
CashMoneyOperation.java
CashMoneyOperationCollectionAspect.aj
insight-plugin-myplugin.xml
cash_money_operation.ftl
Collecting Runtime Data
Operation Rendering in the UI
EndPointAnalyzer
Building a Plug-in from the Source Code
Tutorial: Creating an Insight Plug-in with the Insight Development Kit
Core Plug-in Reference
annotation
grails
hibernate
jdbc
method-endpoint
servlet
spring-core
spring-tx
spring-web
tomcat
Server-Based Instrumentation
Spring Insight Operations
Introduction to Spring Insight Operations
How Spring Insight Operations Works
Difference Between Spring Insight Operations and Spring Insight Developer
Use Cases for Spring Insight Developer and Spring Insight Operations
Agile Development
QA Rear-View Mirror
Testing Load and Performance
Extended Customization with the Spring Insight Developer Kit
Browser Performance Data from Integration with Google SpeedTracer
Production Application Monitoring and Troubleshooting
Supported Environments
Installing and Configuring Spring Insight Operations
Download tc Server and Spring Insight Operations
Install and Start Spring Insight Dashboard
Install and Start Spring Insight Agent
Connect to the Spring Insight Dashboard Server
Configure Spring Insight Dashboard Server Users
Configure Spring Insight Operations
Properties File for Spring Insight Dashboard
Properties File for Spring Insight Agent
(Optional) Configure the Spring Insight Dashboard to Authenticate with LDAP
(Optional) Configure Spring Insight for SSL
Set Up SSL for Spring Insight Dashboard
Set Up SSL for Spring Insight Agents
(Optional) Increase tc Runtime Memory
Using Spring Insight Operations
Before You Begin
Invoking Spring Insight Operations in your Browser
Browsing all Applications, Servers, and End Points
Viewing Recent Activity of Your Application
Filtering Trace Details
Exporting and Importing Traces
Customizing End Point Thresholds
Viewing Spring Insight Data In Google Speed Tracer
vFabric GemFire 6.6
vFabric GemFire User's Guide
Documentation Roadmap
Getting Started with vFabric GemFire
System Requirements
Supported Configurations and Host Machine Requirements
Dependencies on Linux RPM Packages
Running vFabric GemFire in Pure Java Mode
Installing vFabric GemFire
Installing GemFire as Part of vFabric Cloud Application Platform
Installing GemFire Standalone
Upgrading vFabric GemFire
Setting Up the Product Examples
vFabric GemFire Tutorial
Tutorial Introduction
vFabric GemFire Features Demonstrated in the Tutorial
Tutorial Contents and Organization
Running the Tutorial
Exploring Other Features with the Tutorial
Hello World Example
Introduction to the Hello World Example
Walkthrough of the Example Files
gemfire.properties
xml/HelloWorld.xml
HelloWorldProducer.java and helloworld/HelloWorldConsumer.java
helloworld/SimpleCacheListener.java
QuickStart Examples
Introduction to Examples
Replicated Caching Example
Server Managed Caching Example
Partitioned Data Caching Example
Reliable Event Notification Examples
Interest Registration Example
Continuous Querying Example
Durable Event Messaging Example
Persisting Data to Disk Example
Overflowing Data to Disk Example
Cache Expiration Example
Cache Eviction Example
Querying Example
Transactions Example
Delta Propagation Example
Function Execution Example
Secure Client Example
Multiple Secure Client Example
Distributed Locking Example
Benchmark Examples
Peer-to-Peer Benchmark Example
Client Server Benchmark Example
Benchmark Parameters
Troubleshooting Checklist
Additional Information Resources
Main Features of vFabric GemFire
Basic Configuration and Programming
Distributed System and Cache Configuration
Distributed System Members
Options for Configuring the Distributed System
Options for Configuring the Cache and Data Regions
Local and Remote Membership and Caching
Cache Management
Introduction to Cache Management
Managing a Peer or Server Cache
Managing a Client Cache
Managing a Cache in a Secure System
Managing RegionServices for Multiple Secure Users
Data Regions
Data Region Management
Creating a Region Through the cache.xml File
Creating a Region Through the API
Region Naming
Region Shortcuts and Custom Named Region Attributes
Storing and Retrieving Region Shortcuts and Custom Named Region Attributes
Managing Region Attributes
Creating Custom Attributes for Regions and Entries
Data Entries
Managing Data Entries
Requirements for Using Custom Classes in Data Caching
Topologies and Communication
Topology and Communication General Concepts
Topology Types
Planning Topology and Communication
How Member Discovery Works
How Communication Works
Using Bind Addresses
Choosing Between IPv4 and IPv6
Peer-to-Peer Configuration
Configuring Peer-to-Peer Discovery
Configuring Peer Communication
Client/Server Configuration
Standard Client/Server Deployment
How Server Discovery Works
How Client/Server Connections Work
Configuring a Client/Server System
Configuring Servers Into Logical Groups
Client/Server Example Configurations
Fine-Tuning Your Client/Server Configuration
Multi-site Configuration
How Multi-site Systems Work
Multi-site Topologies
Configuring a Multi-site System
Configuring Load Balancing for a Multi-site System
Developing with vFabric GemFire
Region Data Storage and Distribution
Storage and Distribution Options
Region Types
Region Data Stores and Data Accessors
Partitioned Regions
How Partitioning Works
Configuring Partitioned Regions
Configuring the Number of Buckets for a Partitioned Region
How Custom Partitioning and Data Collocation Work
Custom-Partition Your Region Data
Collocate Data from Different Partitioned Regions
How Partitioned Region High Availability Works
Configure High Availability for a Partitioned Region
Set the Number of Redundant Copies
Configure Redundancy Zones for Members
Set Enforce Unique Host
Configure Member Crash Redundancy Recovery for a Partitioned Region
Configure Member Join Redundancy Recovery for a Partitioned Region
How Client Single-Hop Access to Server-Partitioned Regions Works
Configure Client Single-Hop Access to Server-Partitioned Regions
Rebalancing Partitioned Region Data
Distributed and Replicated Regions
How Distribution Works
Options for Region Distribution
How Replication and Preloading Work
Configure Distributed, Replicated, and Preloaded Regions
Locking in Global Regions
General Region Data Management
Persistence and Overflow
How Persistence and Overflow Work
Configure Region Persistence and Overflow
Overflow Configuration Examples
Eviction
How Eviction Works
Configure Data Eviction
Expiration
How Expiration Works
Configure Data Expiration
Outside Data Sources
How Data Loaders Work
Implement a Data Loader
Data Serialization
Overview of Data Serialization
vFabric GemFire PDX Serialization
GemFire PDX Serialization Features
High Level Steps for Using PDX Serialization
Using Automatic Reflection-Based PDX Serialization
Customizing Serialization with Class Pattern Strings
Extending the ReflectionBasedAutoSerializer
Serializing Your Domain Object with a PdxSerializer
Implementing PdxSerializable in Your Domain Object
Programming Your Application to Use PdxInstances
Using PdxInstanceFactory to Create PdxInstances
Persisting PDX Metadata to Disk
Using PDX Objects as Region Entry Keys
vFabric GemFire Data Serialization (DataSerializable and DataSerializer)
Standard Java Serialization
Events and Event Handling
How Events Work
Peer-to-Peer Event Distribution
Client-to-Server Event Distribution
How Multi-site Event Distribution Works
List of Event Handlers and Events
Implementing GemFire Event Handlers
Implementing Cache Event Handlers
Implementing Write-Behind Cache Event Handling
How to Safely Modify the Cache from an Event Handler Callback
Cache Event Handler Examples
Implementing Administrative Event Handlers
Configuring Peer-to-Peer Event Messaging
Configuring Client/Server Event Messaging
Configuring Highly Available Servers
Highly Available Client/Server Event Messaging
Implementing Durable Client/Server Messaging
Durable Client/Server Event Messaging
Tuning Client/Server Event Messaging
Conflate the Server Subscription Queue
Limit the Server's Subscription Queue Memory Use
Tune the Client's Subscription Message Tracking Timeout
Configuring Multi-site Event Messaging
Configuring Highly Available Gateway Queues
Configuring Gateway Queue Concurrency Levels and Order Policy
Conflating a Multi-Site Gateway Queue
Delta Propagation
How Delta Propagation Works
When to Avoid Delta Propagation
Delta Propagation Properties
Implementing Delta Propagation
Errors In Delta Propagation
Delta Propagation Example
Querying
GemFire Querying FAQ and Examples
Basic Querying
Advantages of OQL
Writing and Executing a Query in vFabric GemFire
Building a Query String
IMPORT Statement
FROM Clause
WHERE Clause
SELECT Statement
Query Language Features
Supported Character Sets
Supported Keywords
Case Sensitivity
Comments in Query Strings
Query Language Grammar
Operators
Reserved Words
Supported Literals
Query Language Restrictions and Unsupported Features
Advanced Querying
Performance Considerations
Using Query Bind Parameters
Working with Indexes
Creating Indexes
Creating Key Indexes
Maintaining Indexes (Synchronously or Asynchronously)
Guidelines for Using Indexes
Using Indexes with Overflow Regions
Index Samples
Querying Partitioned Regions
Partitioned Region Query Restrictions
Using ORDER BY on Partitioned Regions
Partitioned Region Queries and Large Result Sets
Querying a Partitioned Region on a Single Node
Query Debugging
Continuous Querying
How Continuous Querying Works
Implementing Continuous Querying
Managing Continuous Querying
Transactions
How Transactions Work
Transaction Coding Examples
Basic Suspend and Resume Transaction Example
Basic Transaction Example
Transaction Run in Multiple Regions
Transactional Function Example
Running a Transaction in vFabric GemFire
vFabric GemFire Transaction Semantics
Cache Design for Transactions
Working with vFabric Transactions
Transaction Events
Application Plug-Ins and Transactions
Transactions by Region Type
Client Transactions
Suspending and Resuming Transactions
Comparing Transactional and Non-Transactional Operations
Queries and Indexes with Transactions
Collections and Region.Entry Instances in Transactions
Using Eviction and Expiration Operations
Using JTA Transactions with vFabric
Monitoring and Troubleshooting Transactions
Function Execution
Use Cases for Function Execution
How Function Execution Works
Executing a Function in vFabric GemFire
Managing vFabric GemFire
Heap Use and Management
How the Resource Manager Works
Control Heap Use with the Resource Manager
Resource Manager Example Configurations
Disk Storage
How Disk Stores Work
Disk Store File Names and Extensions
Disk Store Operation Logs
Design and Configure Disk Stores
Disk Store Configuration Parameters
Modifying the Default Disk Store
Managing How Data is Written to Disk
Disk Store Optimization, Availability, Startup, and Shutdown
Optimizing Availability and Performance in a System with Disk Stores
How Shutdown and Startup Work in a System with Disk Stores
Starting a System with Disk Stores
Shutting Down a System with Disk Stores
Disk Store Management
Disk Store Management Commands and Operations
Validating a Disk Store
Running Compaction on Disk Store Log Files
Synchronizing Your Offline Disk Store with Your Cache
Handling Missing Disk Stores
Back Up and Restore a Disk Store
Network Partitioning
How Network Partitioning Management Works
Failure Detection and Membership Views
Membership Coordinators, Lead Members and Member Weighting
Network Partitioning Scenarios
Configure vFabric GemFire to Handle Network Partitioning
Preventing Network Partitions
Security
Introduction to vFabric GemFire Security
Implement Security
Authentication
How Authentication Works
Implement Authentication
JMX and Authentication
Encrypt Credentials with Diffie-Hellman
Authentication Examples
Authorization
How Authorization Works
Implement Authorized Access Control for the Cache
Performance and Programming Considerations
Authorization Example
SSL
How SSL Works
Implement SSL
SSL Sample Implementation
Java Management Extensions (JMX)
Overview of the JMX Agent
Example Configuration
Starting the vFabric JMX Agent
vFabric JMX Agent Command-Line Arguments
Admin Distributed System Properties
E-mail Notification Properties
Stopping the vFabric GemFire JMX Agent
JMX Connectors
HttpAdaptor
RMIConnectorServer
Configuring SSL for JMX Agent External Communications
Properties and Log Files
vFabric GemFire JMX MBeans
Programming Example
Monitoring and Tuning
Monitoring Tools
API Interfaces and Classes
Programming Examples
Performance Controls
Data Serialization
Setting Cache Timeouts
Controlling Socket Use
Management of Slow Receivers
Increasing the Ratio of Cache Hits
System Member Performance
Distributed System Member Properties
JVM Memory Settings and System Performance
Garbage Collection and System Performance
Connection Thread Settings and Performance
Slow Receivers with TCP/IP
Preventing Slow Receivers
Managing Slow Receivers
Slow distributed-ack Messages
Socket Communication
Setting Socket Buffer Sizes
Ephemeral TCP Port Limits
Making Sure You Have Enough Sockets
TCP/IP Peer-to-Peer Handshake Timeouts
UDP Communication
Multicast Communication
Provisioning Bandwidth for Multicast
Testing Multicast Speed Limits
Configuring Multicast Speed Limits
Run-time Considerations for Multicast
Troubleshooting the Multicast Tuning Process
Maintaining Cache Consistency
Logging
How Logging Works
Naming, Searching, and Creating Log Files
Set Up Logging
Statistics
How Statistics Work
Transient Region and Entry Statistics
Application-Defined Statistics
Configure and Use Statistics
GemFire Statistics List
Troubleshooting and System Recovery
Producing Data Files for System Recovery
Diagnosing System Problems
System Failure and Recovery
Recovering from Application or Cache Server Crashes
Recovering from Crashes with a Peer-to-Peer Configuration
Recovering from Crashes with a Client/Server Configuration
Recovering from Machine Crashes
Recovering from Network Outages
Deploying and Running vFabric GemFire
vFabric GemFire Licensing
Licensing Introduction
Licensing Options for vFabric GemFire
How GemFire Manages Licensing
How to Install vFabric GemFire Licensing
Deploying vFabric GemFire Configuration Files
Main Steps to Deploying Configuration Files
Default File Specifications and Search Locations
Changing the File Specifications
Deploying Configuration Files in JAR Files
Managing vFabric GemFire System Output Files
Starting Up and Shutting Down Your System
Introduction to Startup and Shutdown
Starting Up Your System
Shutting Down the System
vFabric GemFire Command-Line Utility
gfsh
Requirements and Limitations
gfsh Installation and Configuration
gfsh Files and Directories
Starting gfsh
gfsh Command Line Options
Example
gfsh Standard Commands
cd
class
clear
connect
debug
echo
fetch
get
help
index
local
ls
key
mkdir
next
pr
property
put
pwd
refresh
rm
rmdir
select
show
size
value
which
gfsh Advanced Commands
bcp
db
deploy
gc
rebalance
vFabric GemFire Locator Process
vFabric GemFire cacheserver
Firewall Considerations
Firewalls and Connections
Firewalls and Ports
Locators, Gateways, and Ports
Tools and Modules
HTTP Session Management Modules
Advantages of Using GemFire for Session Management
GemFire HTTP Session Management Quick Start
Common Topologies for HTTP Session Management
Session State Log Files
HTTP Session Management Module for tc Server
Installing the Module for tc Server
Setting Up the Module for tc Server
Changing vFabric GemFire Default Configuration (tc Server)
Interactive Mode Reference for tc Server
Additional Information for HTTP Session Management
HTTP Session Management Module for Tomcat
Installing the Module for Tomcat
Setting Up the Module for Tomcat
Changing vFabric GemFire Default Configuration (Tomcat)
Common Configuration Changes (Tomcat)
HTTP Session Management Module for AppServers
Installing the Module for AppServers
Setting Up the Module for AppServers
Changing vFabric GemFire Default Configuration (AppServers)
Common Configuration Changes (AppServers)
Hibernate Cache Module
Why Use Gemfire with Hibernate?
Installing the Hibernate Cache Module
Setting Up the Hibernate Cache Module
Advanced Configuration (Hibernate Cache Module)
Changing vFabric GemFire Default Configuration (Hibernate Cache Module)
Using Hibernate Cache Module with HTTP Session Management Module
Disk File Converter
Running DiskFileConverter
Reference
gemfire.properties (vFabric GemFire Property File)
cache.xml (Declarative Cache Configuration File)
Region Attributes List
JMX Agent Configuration Properties
Server Configuration Properties
Client Configuration Properties
Gateway Configuration Properties
Exceptions and System Failures
Memory Requirements for Cached Data
Glossary
vFabric GemFire User's Guide
Documentation Roadmap
Getting Started with vFabric GemFire
System Requirements
Supported Configurations and Host Machine Requirements
Dependencies on Linux RPM Packages
Running vFabric GemFire in Pure Java Mode
Installing vFabric GemFire
Installing GemFire as Part of vFabric Cloud Application Platform
Installing GemFire Standalone
Upgrading vFabric GemFire
Setting Up the Product Examples
vFabric GemFire Tutorial
Tutorial Introduction
vFabric GemFire Features Demonstrated in the Tutorial
Tutorial Contents and Organization
Running the Tutorial
Exploring Other Features with the Tutorial
Hello World Example
Introduction to the Hello World Example
Walkthrough of the Example Files
gemfire.properties
xml/HelloWorld.xml
HelloWorldProducer.java and helloworld/HelloWorldConsumer.java
helloworld/SimpleCacheListener.java
QuickStart Examples
Introduction to Examples
Replicated Caching Example
Server Managed Caching Example
Partitioned Data Caching Example
Reliable Event Notification Examples
Interest Registration Example
Continuous Querying Example
Durable Event Messaging Example
Persisting Data to Disk Example
Overflowing Data to Disk Example
Cache Expiration Example
Cache Eviction Example
Querying Example
Transactions Example
Delta Propagation Example
Function Execution Example
Secure Client Example
Multiple Secure Client Example
Distributed Locking Example
Benchmark Examples
Peer-to-Peer Benchmark Example
Client Server Benchmark Example
Benchmark Parameters
Troubleshooting Checklist
Additional Information Resources
Main Features of vFabric GemFire
Basic Configuration and Programming
Distributed System and Cache Configuration
Distributed System Members
Options for Configuring the Distributed System
Options for Configuring the Cache and Data Regions
Local and Remote Membership and Caching
Cache Management
Introduction to Cache Management
Managing a Peer or Server Cache
Managing a Client Cache
Managing a Cache in a Secure System
Managing RegionServices for Multiple Secure Users
Data Regions
Data Region Management
Creating a Region Through the cache.xml File
Creating a Region Through the API
Region Naming
Region Shortcuts and Custom Named Region Attributes
Storing and Retrieving Region Shortcuts and Custom Named Region Attributes
Managing Region Attributes
Creating Custom Attributes for Regions and Entries
Data Entries
Managing Data Entries
Requirements for Using Custom Classes in Data Caching
Topologies and Communication
Topology and Communication General Concepts
Topology Types
Planning Topology and Communication
How Member Discovery Works
How Communication Works
Using Bind Addresses
Choosing Between IPv4 and IPv6
Peer-to-Peer Configuration
Configuring Peer-to-Peer Discovery
Configuring Peer Communication
Client/Server Configuration
Standard Client/Server Deployment
How Server Discovery Works
How Client/Server Connections Work
Configuring a Client/Server System
Configuring Servers Into Logical Groups
Client/Server Example Configurations
Fine-Tuning Your Client/Server Configuration
Multi-site Configuration
How Multi-site Systems Work
Multi-site Topologies
Configuring a Multi-site System
Configuring Load Balancing for a Multi-site System
Developing with vFabric GemFire
Region Data Storage and Distribution
Storage and Distribution Options
Region Types
Region Data Stores and Data Accessors
Partitioned Regions
How Partitioning Works
Configuring Partitioned Regions
Configuring the Number of Buckets for a Partitioned Region
How Custom Partitioning and Data Collocation Work
Custom-Partition Your Region Data
Collocate Data from Different Partitioned Regions
How Partitioned Region High Availability Works
Configure High Availability for a Partitioned Region
Set the Number of Redundant Copies
Configure Redundancy Zones for Members
Set Enforce Unique Host
Configure Member Crash Redundancy Recovery for a Partitioned Region
Configure Member Join Redundancy Recovery for a Partitioned Region
How Client Single-Hop Access to Server-Partitioned Regions Works
Configure Client Single-Hop Access to Server-Partitioned Regions
Rebalancing Partitioned Region Data
Distributed and Replicated Regions
How Distribution Works
Options for Region Distribution
How Replication and Preloading Work
Configure Distributed, Replicated, and Preloaded Regions
Locking in Global Regions
General Region Data Management
Persistence and Overflow
How Persistence and Overflow Work
Configure Region Persistence and Overflow
Overflow Configuration Examples
Eviction
How Eviction Works
Configure Data Eviction
Expiration
How Expiration Works
Configure Data Expiration
Outside Data Sources
How Data Loaders Work
Implement a Data Loader
Data Serialization
Overview of Data Serialization
vFabric GemFire PDX Serialization
GemFire PDX Serialization Features
High Level Steps for Using PDX Serialization
Using Automatic Reflection-Based PDX Serialization
Customizing Serialization with Class Pattern Strings
Extending the ReflectionBasedAutoSerializer
Serializing Your Domain Object with a PdxSerializer
Implementing PdxSerializable in Your Domain Object
Programming Your Application to Use PdxInstances
Using PdxInstanceFactory to Create PdxInstances
Persisting PDX Metadata to Disk
Using PDX Objects as Region Entry Keys
vFabric GemFire Data Serialization (DataSerializable and DataSerializer)
Standard Java Serialization
Events and Event Handling
How Events Work
Peer-to-Peer Event Distribution
Client-to-Server Event Distribution
How Multi-site Event Distribution Works
List of Event Handlers and Events
Implementing GemFire Event Handlers
Implementing Cache Event Handlers
Implementing Write-Behind Cache Event Handling
How to Safely Modify the Cache from an Event Handler Callback
Cache Event Handler Examples
Implementing Administrative Event Handlers
Configuring Peer-to-Peer Event Messaging
Configuring Client/Server Event Messaging
Configuring Highly Available Servers
Highly Available Client/Server Event Messaging
Implementing Durable Client/Server Messaging
Durable Client/Server Event Messaging
Tuning Client/Server Event Messaging
Conflate the Server Subscription Queue
Limit the Server's Subscription Queue Memory Use
Tune the Client's Subscription Message Tracking Timeout
Configuring Multi-site Event Messaging
Configuring Highly Available Gateway Queues
Configuring Gateway Queue Concurrency Levels and Order Policy
Conflating a Multi-Site Gateway Queue
Delta Propagation
How Delta Propagation Works
When to Avoid Delta Propagation
Delta Propagation Properties
Implementing Delta Propagation
Errors In Delta Propagation
Delta Propagation Example
Querying
GemFire Querying FAQ and Examples
Basic Querying
Advantages of OQL
Writing and Executing a Query in vFabric GemFire
Building a Query String
IMPORT Statement
FROM Clause
WHERE Clause
SELECT Statement
Query Language Features
Supported Character Sets
Supported Keywords
Case Sensitivity
Comments in Query Strings
Query Language Grammar
Operators
Reserved Words
Supported Literals
Query Language Restrictions and Unsupported Features
Advanced Querying
Performance Considerations
Using Query Bind Parameters
Working with Indexes
Creating Indexes
Creating Key Indexes
Maintaining Indexes (Synchronously or Asynchronously)
Guidelines for Using Indexes
Using Indexes with Overflow Regions
Index Samples
Querying Partitioned Regions
Partitioned Region Query Restrictions
Using ORDER BY on Partitioned Regions
Partitioned Region Queries and Large Result Sets
Querying a Partitioned Region on a Single Node
Query Debugging
Continuous Querying
How Continuous Querying Works
Implementing Continuous Querying
Managing Continuous Querying
Transactions
How Transactions Work
Transaction Coding Examples
Basic Suspend and Resume Transaction Example
Basic Transaction Example
Transaction Run in Multiple Regions
Transactional Function Example
Running a Transaction in vFabric GemFire
vFabric GemFire Transaction Semantics
Cache Design for Transactions
Working with vFabric Transactions
Transaction Events
Application Plug-Ins and Transactions
Transactions by Region Type
Client Transactions
Suspending and Resuming Transactions
Comparing Transactional and Non-Transactional Operations
Queries and Indexes with Transactions
Collections and Region.Entry Instances in Transactions
Using Eviction and Expiration Operations
Using JTA Transactions with vFabric
Monitoring and Troubleshooting Transactions
Function Execution
Use Cases for Function Execution
How Function Execution Works
Executing a Function in vFabric GemFire
Managing vFabric GemFire
Heap Use and Management
How the Resource Manager Works
Control Heap Use with the Resource Manager
Resource Manager Example Configurations
Disk Storage
How Disk Stores Work
Disk Store File Names and Extensions
Disk Store Operation Logs
Design and Configure Disk Stores
Disk Store Configuration Parameters
Modifying the Default Disk Store
Managing How Data is Written to Disk
Disk Store Optimization, Availability, Startup, and Shutdown
Optimizing Availability and Performance in a System with Disk Stores
How Shutdown and Startup Work in a System with Disk Stores
Starting a System with Disk Stores
Shutting Down a System with Disk Stores
Disk Store Management
Disk Store Management Commands and Operations
Validating a Disk Store
Running Compaction on Disk Store Log Files
Synchronizing Your Offline Disk Store with Your Cache
Handling Missing Disk Stores
Back Up and Restore a Disk Store
Network Partitioning
How Network Partitioning Management Works
Failure Detection and Membership Views
Membership Coordinators, Lead Members and Member Weighting
Network Partitioning Scenarios
Configure vFabric GemFire to Handle Network Partitioning
Preventing Network Partitions
Security
Introduction to vFabric GemFire Security
Implement Security
Authentication
How Authentication Works
Implement Authentication
JMX and Authentication
Encrypt Credentials with Diffie-Hellman
Authentication Examples
Authorization
How Authorization Works
Implement Authorized Access Control for the Cache
Performance and Programming Considerations
Authorization Example
SSL
How SSL Works
Implement SSL
SSL Sample Implementation
Java Management Extensions (JMX)
Overview of the JMX Agent
Example Configuration
Starting the vFabric JMX Agent
vFabric JMX Agent Command-Line Arguments
Admin Distributed System Properties
E-mail Notification Properties
Stopping the vFabric GemFire JMX Agent
JMX Connectors
HttpAdaptor
RMIConnectorServer
Configuring SSL for JMX Agent External Communications
Properties and Log Files
vFabric GemFire JMX MBeans
Programming Example
Monitoring and Tuning
Monitoring Tools
API Interfaces and Classes
Programming Examples
Performance Controls
Data Serialization
Setting Cache Timeouts
Controlling Socket Use
Management of Slow Receivers
Increasing the Ratio of Cache Hits
System Member Performance
Distributed System Member Properties
JVM Memory Settings and System Performance
Garbage Collection and System Performance
Connection Thread Settings and Performance
Slow Receivers with TCP/IP
Preventing Slow Receivers
Managing Slow Receivers
Slow distributed-ack Messages
Socket Communication
Setting Socket Buffer Sizes
Ephemeral TCP Port Limits
Making Sure You Have Enough Sockets
TCP/IP Peer-to-Peer Handshake Timeouts
UDP Communication
Multicast Communication
Provisioning Bandwidth for Multicast
Testing Multicast Speed Limits
Configuring Multicast Speed Limits
Run-time Considerations for Multicast
Troubleshooting the Multicast Tuning Process
Maintaining Cache Consistency
Logging
How Logging Works
Naming, Searching, and Creating Log Files
Set Up Logging
Statistics
How Statistics Work
Transient Region and Entry Statistics
Application-Defined Statistics
Configure and Use Statistics
GemFire Statistics List
Troubleshooting and System Recovery
Producing Data Files for System Recovery
Diagnosing System Problems
System Failure and Recovery
Recovering from Application or Cache Server Crashes
Recovering from Crashes with a Peer-to-Peer Configuration
Recovering from Crashes with a Client/Server Configuration
Recovering from Machine Crashes
Recovering from Network Outages
Deploying and Running vFabric GemFire
vFabric GemFire Licensing
Licensing Introduction
Licensing Options for vFabric GemFire
How GemFire Manages Licensing
How to Install vFabric GemFire Licensing
Deploying vFabric GemFire Configuration Files
Main Steps to Deploying Configuration Files
Default File Specifications and Search Locations
Changing the File Specifications
Deploying Configuration Files in JAR Files
Managing vFabric GemFire System Output Files
Starting Up and Shutting Down Your System
Introduction to Startup and Shutdown
Starting Up Your System
Shutting Down the System
vFabric GemFire Command-Line Utility
gfsh
Requirements and Limitations
gfsh Installation and Configuration
gfsh Files and Directories
Starting gfsh
gfsh Command Line Options
Example
gfsh Standard Commands
cd
class
clear
connect
debug
echo
fetch
get
help
index
local
ls
key
mkdir
next
pr
property
put
pwd
refresh
rm
rmdir
select
show
size
value
which
gfsh Advanced Commands
bcp
db
deploy
gc
rebalance
vFabric GemFire Locator Process
vFabric GemFire cacheserver
Firewall Considerations
Firewalls and Connections
Firewalls and Ports
Locators, Gateways, and Ports
Tools and Modules
HTTP Session Management Modules
Advantages of Using GemFire for Session Management
GemFire HTTP Session Management Quick Start
Common Topologies for HTTP Session Management
Session State Log Files
HTTP Session Management Module for tc Server
Installing the Module for tc Server
Setting Up the Module for tc Server
Changing vFabric GemFire Default Configuration (tc Server)
Interactive Mode Reference for tc Server
Additional Information for HTTP Session Management
HTTP Session Management Module for Tomcat
Installing the Module for Tomcat
Setting Up the Module for Tomcat
Changing vFabric GemFire Default Configuration (Tomcat)
Common Configuration Changes (Tomcat)
HTTP Session Management Module for AppServers
Installing the Module for AppServers
Setting Up the Module for AppServers
Changing vFabric GemFire Default Configuration (AppServers)
Common Configuration Changes (AppServers)
Hibernate Cache Module
Why Use Gemfire with Hibernate?
Installing the Hibernate Cache Module
Setting Up the Hibernate Cache Module
Advanced Configuration (Hibernate Cache Module)
Changing vFabric GemFire Default Configuration (Hibernate Cache Module)
Using Hibernate Cache Module with HTTP Session Management Module
Disk File Converter
Running DiskFileConverter
Reference
gemfire.properties (vFabric GemFire Property File)
cache.xml (Declarative Cache Configuration File)
Region Attributes List
JMX Agent Configuration Properties
Server Configuration Properties
Client Configuration Properties
Gateway Configuration Properties
Exceptions and System Failures
Memory Requirements for Cached Data
Glossary
vFabric SQLFire 1.0
Supported Configurations and System Requirements
Getting Started with vFabric SQLFire
Overview of vFabric SQLFire
Data Flow Diagram
GemFire, Apache Derby, and SQL Components
Understanding the SQLFire Distributed System
vFabric SQLFire Members
Servers, Peer Clients, and Server Groups
Discovery Mechanisms
Group Membership Service
Replicated Tables and Partitioned Tables
Parallel Execution of Data-Aware Stored Procedures
Cache Plug-ins for External Data Connections
Installing vFabric SQLFire
Installation Note for vFabric Platform Customers
RHEL Only: Install vFabric SQLFire from the VMWare YUM Repository
Install vFabric SQLFire from a JAR File
Activating vFabric SQLFire Licensing
Understand vFabric SQLFire License Options
Choose a License Option Based on Topology
How vFabric SQLFire Manages Licensing
Install and Configure vFabric SQLFire Licenses
Verify Your License and Check Your License Usage
Upgrading vFabric SQLFire
RHEL Only: Upgrade vFabric SQLFire from the VMWare YUM Repository
Upgrade Issues
Connect to vFabric SQLFire with JDBC Tools
Tutorials
Main Steps
Create a SQLFire Cluster
Connect to the Cluster Using SQLF
Create Replicated Tables and Execute Queries
Implement a Partitioning Strategy
Persist Tables to Disk
Add Servers to the Cluster and Stop Servers
Perform Additional Tasks
vFabric SQLFire Features and Benefits
Managing Your Data in vFabric SQLFire
Designing vFabric SQLFire Databases
Design Principles of Scalable, Partition-Aware Databases
Identify Entity Groups and Partitioning Keys
Use Entity Groups Instead of "Sharding"
Replicate Code Tables
Dealing with Many-to-Many Relationships
Example: Adapting a Database Schema for SQLFire
Using Server Groups to Manage Data
Server Groups Overview
Adding Members to Server Groups
Assigning Tables to Server Groups
Partitioning Tables
How Table Partitioning Works
Understanding Where Data Is Stored
Failure and Redundancy
Creating Partitioned Tables
Partitioning Examples
Colocating Related Rows from Multiple Tables
Making a Partitioned Table Highly Available
Limiting the Memory Consumption on a Member
Rebalancing Partitioned Data on SQLFire Members
Managing Replication Failures
Replicating Tables
How SQLFire Replicates Tables
Deciding When to Use Replicated Tables
Creating Replicated Tables
Estimating Memory Requirements
Estimating SQLFire Overhead
Viewing Memory Usage in SYS.MEMORYANALYTICS
Enabling SYS.MEMORYANALYTICS
Understanding Table and Index Values
Displaying the Total Memory Footprint
Using Disk Stores to Persist Data
Overview of Disk Stores
What SQLFire Writes to the Disk Store
Disk Store State
Disk Store Directories
Disk Store Persistence Attributes
Disk Store File Names and Extensions
Disk Store Operation Logs
Factors Contributing to High Disk Throughput
Guidelines for Designing Disk Stores
Creating a Disk Store or Using the Default
Persist Table Data to a Disk Store
Optimizing Availability and Performance
Starting System with Disk Stores
Start a System with Disk Stores
Disk Store Management
Validate a Disk Store
Compacting Disk Store Log Files
Backing Up and Restoring Online Disk Stores
Backing Up and Restoring Offline Disk Stores
Handling Missing Disk Stores
Exporting and Importing Data with vFabric SQLFire
Using SQLF Commands to Export and Import Data
Export, Alter, and Import a Database Schema Using SQLF
Using Apache DdlUtils to Import Data
Overview of DdlUtils
Export, Alter, and Import a Database Schema Using DdlUtils
Example build.xml File
Using Table Functions to Import Data as a SQLFire Tables
Overview of SQLFire Table Functions
Preferred getXXX() methods for SQLFire Table Functions
Example Table Function
Developing Applications with SQLFire
Starting SQLFire Servers with the FabricServer Interface
Starting a Network Server
Developing Java Clients and Peers
Connect to a SQLFire Server with the Thin Client JDBC Driver
Start a SQLFire Peer with the Peer Client JDBC Driver
Using SQLFire as an Embedded JDBC Datasource
Storing and Loading JAR Files in SQLFire
Class Loading Overview
Create JAR Files for Your Application
Manage JAR Files in SQLFire
Code Your Applications
Alternate Methods for Managing JAR Files
Developing ADO.NET Client Applications
About the ADO.NET Driver
ADO.NET Driver Classes
Installing and Using the ADO.NET driver
Connecting to SQLFire with the ADO.NET Driver
Managing Connections
Executing SQL Commands
Working with Result Sets
Storing a Table
Storing Multiple Tables
Specifying Command Parameters with SQLFParameter
Updating Row Data
Adding Rows to a Table
Managing SQLFire Transactions
Performing Batch Updates
Generic Coding with the SQLFire ADO.NET Driver
Using SQLFire.NET Designer
Installing SQLFire.NET Designer
Connecting to a SQLFire Distributed System
Editing Tables
Understanding the Data Consistency Model
Data Consistency Concepts
No Ordering Guarantee for DML in Separate Threads
Updates on Any Row Are Atomic and Isolated
Atomicity for Bulk Updates
Using Distributed Transactions in Your Applications
Overview of SQLFire Distributed Transactions
Supported Transaction Isolation Levels
Transactions and DDL Statements
Handling Member Failures
Sequence of Events for a Distributed Transaction
SQLFire Transaction Design
Best Practices for Using Transactions
Transaction Functionality and Limitations
Using Data-Aware Stored Procedures
Configuring a Procedure
Configuring a Custom Result Processor
Invoking a Procedure
High Availability for SQLFire Procedures
Default Result Processor
Example JDBC Client
Using the Procedure Provider API
Procedure Parameters
Populating OUT and INOUT Parameters
Populating Result Sets
Using the <local> and <global> Escape Syntax with Nested Queries
Using the Custom Result Processor API
Implementing the ProcedureResultProcessor Interface
Example Result Processor: MergeSort
Procedure Implementation
Merge Sort Result Processor
Programming User-Defined Types
Caching Data with vFabric SQLFire
SQLFire Cache Strategies
Using a RowLoader to Load Existing Data
How SQLFire Invokes a RowLoader
Implementing the RowLoader Interface
Using the JDBCRowLoader Example
Evicting Table Data from SQLFire
How LRU Eviction Works
Limitations of Eviction
Eviction in Partitioned Tables
Create a Table with Eviction Settings
Handling DML Events Synchronously
Writer and Listener Cache Plug-ins
Example Writer Implementation
Example Listener Implementation
Handling DML Events Asynchronously
How the AsyncEventListener Works
Implementation Requirements
Implementing an AsyncEventListener
Using DBSynchronizer to Apply DML to an RDBMS
How DBSynchronizer Works
Restrictions and Limitations
Configuring DBSynchronizer
Suppressing Event Callbacks for a vFabric SQLFire Connection
Deploying vFabric SQLFire
SQLFire Deployment Models
Embedded Peer-to-Peer Deployment
Client-Server Deployment
Multi-site Deployment
How Multi-site Systems Work
Supported and Unsupported Topologies
How Multi-site Event Distribution Works
Supported and Unsupported Topologies
Steps to Plan and Configure a Deployment
Configuring Discovery Mechanisms
Using Locators
Start and Stop Locators
Start SQLFire Peers and Servers Using Locators
Connect to a Distributed System Using Locators
Configure Multicast Discovery
Starting and Configuring SQLFire Servers
Start and Stop SQLFire Servers Using sqlf
Specify the Server Working Directory
Specify Client Connection Information
Define Server Groups
Execute SQL When You Start a Server
Using Additional Boot Properties
Configuring SQLFire Properties
Configuring Multi-site (WAN) Deployments
About Gateways
About High Availability for WAN Deployments
Limitations of Multi-Site Replication
Prerequisites for WAN Replication
Steps to Configure a Multi-site Deployment
Configure Locators for WAN Member Discovery
Create and Start Gateway Sender
Create Tables with Gateway Senders
Create a Gateway Receiver
Start and Stop Gateway Senders
Add and Remove Gateway Senders and Receivers
Configuring Authentication and Authorization
Configuring User Authentication
User Authentication and Member Ownership
Enable User Authentication
Creating Users for BUILTIN Authentication
Create System Users
Encrypt the Password of a System User
Change a System User Password
Create Distributed System Users
Configuring LDAP Directory Service
Configure SQLFire to Use Your LDAP Directory Service
Guest Access to Search for DNs
LDAP Restrictions and Performance Guidelines
JNDI-Specific Properties for External Directory Services
JMX and Authentication
User Names in Authentication and Authorization
User Names and Authorization Identifiers
Conversion of User Name to Authorization Identifier
SQLFire Member JVM Owner
Configuring User Authorization
Set the SQL Standard Authorization Mode
Set the Default Connection Access Mode
Set the Authorizations for Individual Users
Read-only and Full Access Permissions
User Authorization Exceptions
Set User Permissions for Database Objects in SQL Standard Authorization
Configuring Network Encryption and Authentication with SSL/TLS
Generate Key Pairs and Certificates
Start the Server with SSL/TLS
Run a Client with SSL/TLS
Managing and Monitoring vFabric SQLFire
Configuring and Using SQLFire Log Files
Log Message Format
Severity Levels
Using java.util.logging.Logger for Application Log Messages
Using Trace Flags for Advanced Debugging
Querying SQLFire System Tables and Indexes
Getting Information About SQLFire Members
Getting Information About User Tables
Evaluating Query Execution Plans and Query Statistics
Capture the Query Execution Plan for Individual Statements
Capture Query Execution Plans for All Statements
View Query Plans and Statistics
SQLFire Query Execution Plan Codes
Overriding Optimizer Choices
Evaluating System and Application Performance
Collecting System Statistics
Collecting Application Statistics
Using VSD to Analyze Statistics
Transaction Performance
Table Performance
SQL Statement Performance
Application Performance
Memory Usage
CPU Usage
Using Java Management Extensions (JMX)
Overview of the vFabric SQLFire JMX Agent
Example Configuration
Starting the JMX Agent
Agent Properties File and Log Files
Basic JMX Agent Properties
Distributed System Properties for JMX Agent
E-mail Notification Properties for the JMX Agent
Stopping the JMX Agent
Configuring JMX Connectors and Adapters
RMIConnectorServer Properties
MX4J/Http Adaptor Properties
SSL Communication Properties
vFabric SQLFire MBeans
Best Practices for Tuning Performance
Tune Application Logic
Reduce Distribution Overhead
Reduce Overhead of Eviction to Disk
Minimize Update Latency for Replicated Tables
Tune FabricServers
Tuning Disk I/O
Running SQLFire in Virtualized Environments
Detecting and Handling Network Segmentation ("Split Brain")
vFabric SQLFire Reference
Configuration Properties
JDBC API
Mapping java.sql.Types to SQL Types
java.sql.BatchUpdateException Class
java.sql.Connection Interface
java.sql.DatabaseMetaData Interface
java.sql.Driver Interface
java.sql.DriverManager.getConnection Method
java.sql.PreparedStatement Interface
java.sql.ResultSet Interface
java.sql.SavePoint Class
java.sql.SQLException Class
java.sql.Statement Class
javax.sql.XADataSource
sqlf Launcher Commands
sqlf backup
sqlf compact-all-disk-stores
sqlf compact-disk-store
sqlf encrypt-password
sqlf install-jar
sqlf list-missing-disk-stores
sqlf locator
sqlf Logging Support
sqlf merge-logs
sqlf remove-jar
sqlf replace-jar
sqlf revoke-missing-disk-store
sqlf server
sqlf shut-down-all
sqlf stats
sqlf validate-disk-store
sqlf version
sqlf write-data-dtd-to-file
sqlf write-data-to-db
sqlf write-data-to-xml
sqlf write-schema-to-db
sqlf write-schema-to-sql
sqlf write-schema-to-xml
sqlf Interactive Commands
absolute
after last
async
autocommit
before first
close
commit
connect
connect client
connect peer
describe
disconnect
driver
elapsedtime
execute
exit
first
get scroll insensitive cursor
GetCurrentRowNumber
help
last
LocalizedDisplay
MaximumDisplayWidth
next
prepare
previous
protocol
relative
remove
rollback
run
set connection
show
wait for
SQLFire API
CredentialInitializer
UserAuthenticator
Procedure Implementation Interfaces
ProcedureExecutionContext
OutgoingResultSet
Procedure Result Processor Interfaces
ProcedureResultProcessor
ProcedureProcessorContext
IncomingResultSet
SQL Language Reference
Keywords and Identifiers
Standard SQL Identifiers
SQL Statements
ALTER TABLE
CALL (PROCEDURE)
CREATE Statements
CREATE ASYNCEVENTLISTENER
CREATE DISKSTORE
CREATE FUNCTION
CREATE GATEWAYRECEIVER
CREATE GATEWAYSENDER
CREATE GLOBAL HASH INDEX
CREATE INDEX
CREATE PROCEDURE
CREATE SCHEMA
CREATE SYNONYM
CREATE TABLE
CREATE TRIGGER
CREATE TYPE
CREATE VIEW
DECLARE GLOBAL TEMPORARY TABLE
DELETE
EXPLAIN
DROP statements
DROP ASYNCEVENTLISTENER
DROP GATEWAYRECEIVER
DROP GATEWAYSENDER
DROP FUNCTION
DROP INDEX
DROP PROCEDURE
DROP SCHEMA
DROP TABLE
DROP TRIGGER
DROP TYPE
DROP VIEW
GRANT
INSERT
Query
REVOKE
SELECT
SET ISOLATION
SET SCHEMA
UPDATE
SQL Clauses
FOR UPDATE Clause
FROM Clause
GROUP BY Clause
HAVING Clause
OFFSET and FETCH FIRST Clauses
ORDER BY Clause
WHERE Clause
SQL Expressions
SelectExpression
TableExpression
VALUES Expression
Expression Precedence
Boolean Expressions
Dynamic Parameters
Where Dynamic Parameters Are Allowed
JOIN Operations
INNER JOIN Operation
LEFT OUTER JOIN Operation
RIGHT OUTER JOIN Operation
Built-in Functions
Standard Built-in Functions
Aggregates (set functions)
ABS or ABSVAL function
ACOS function
ASIN function
ATAN function
ATAN2 function
AVG function
BIGINT function
CASE expressions
CAST function
CEIL or CEILING function
CHAR function
COALESCE function
Concatenation operator
COS function
COSH function
COT function
COUNT function
COUNT(*) function
CURRENT DATE function
CURRENT_DATE function
CURRENT ISOLATION function
CURRENT_ROLE function
CURRENT SCHEMA function
CURRENT TIME function
CURRENT_TIME function
CURRENT TIMESTAMP function
CURRENT_TIMESTAMP function
CURRENT_USER function
DATE function
DAY function
DEGREES function
DOUBLE function
EXP function
FLOOR function
HOUR function
INTEGER function
LCASE or LOWER function
LENGTH function
LN or LOG function
LOG10 function
LOCATE function
LTRIM function
MAX function
MIN function
MINUTE function
MOD function
MONTH function
NULLIF expressions
PI function
RADIANS function
RANDOM function
RAND function
RTRIM function
SECOND function
SESSION_USER function
SIGN function
SIN function
SINH function
SMALLINT function
SQRT function
SUBSTR function
SUM function
TAN function
TANH function
TIME function
TIMESTAMP function
TRIM function
UCASE or UPPER function
USER function
VARCHAR function
XMLEXISTS operator
XMLPARSE operator
XMLQUERY operator
XMLSERIALIZE operator
YEAR function
SQLFire Built-in Functions
DSID Function
GROUPS Function
GROUPSINTERSECT Function
GROUPSINTERSECTION Function
GROUPSUNION Function
Built-in System Procedures
Standard Built-in Procedures
SYSCS_UTIL.EMPTY_STATEMENT_CACHE
SYSCS_UTIL.EXPORT_QUERY
SYSCS_UTIL.EXPORT_TABLE
SYSCS_UTIL.IMPORT_TABLE
SYSCS_UTIL.SET_EXPLAIN_CONNECTION
SYSCS_UTIL.SET_STATISTICS_TIMING
SYSCS_UTIL.SET_USER_ACCESS
JAR Installation Procedures
SQLJ.INSTALL_JAR
SQLJ.REMOVE_JAR
SQLJ.REPLACE_JAR
Callback Configuration Procedures
SYS.ADD_LISTENER
SYS.ATTACH_LOADER
SYS.ATTACH_WRITER
SYS.REBALANCE_ALL_BUCKETS
SYS.REMOVE_LISTENER
SYS.REMOVE_LOADER
SYS.REMOVE_WRITER
SYS.START_ASYNC_EVENT_LISTENER
SYS.STOP_ASYNC_EVENT_LISTENER
Heap Eviction Configuration Procedures
SYS.SET_EVICTION_HEAP_PERCENTAGE
SYS.SET_EVICTION_HEAP_PERCENTAGE_SG
WAN Configuration Procedures
SYS.START_GATEWAYSENDER
SYS.STOP_GATEWAYSENDER
Data Types
SQL Standards Conformance
System Tables
ASYNCEVENTLISTENERS table
GATEWAYRECEIVERS table
GATEWAYSENDERS table
MEMBERS system table
MEMORYANALYTICS system table
STATEMENTPLANS system table
SYSALIASES system table
SYSCHECKS system table
SYSCOLPERMS system table
SYSCOLUMNS system table
SYSCONGLOMERATES system table
SYSCONSTRAINTS system table
SYSDEPENDS system table
SYSDISKSTORES system table
SYSFILES system table
SYSFOREIGNKEYS system table
SYSKEYS system table
SYSROLES system table
SYSROUTINEPERMS system table
SYSSCHEMAS system table
SYSSTATEMENTS system table
SYSSTATISTICS system table
SYSTABLEPERMS system table
SYSTABLES system table
SYSTRIGGERS system table
SYSVIEWS system table
Exception Messages and SQL States
ADO.NET Driver Reference
SQLFire Data Types in ADO.NET
VMware.Data.SQLFire.BatchUpdateException
VMWare.Data.SQLFire.SQLFClientConnection
VMware.Data.SQLFire.SQLFCommand
VMware.Data.SQLFire.SQLFCommandBuilder
VMware.Data.SQLFire.SQLFType
VMware.Data.SQLFire.SQLFDataAdapter
VMware.Data.SQLFire.SQLFDataReader
VMware.Data.SQLFire.SQLFException
VMware.Data.SQLFire.SQLFParameter
VMware.Data.SQLFire.SQLFParameterCollection
VMware.Data.SQLFire.SQLFTransaction
vFabric SQLFire Limitations
SQL Language Limitations
Query Capabilities and Limitations
ADO.NET Driver Limitations
Troubleshooting Common Problems
vFabric SQLFire Glossary
Supported Configurations and System Requirements
Getting Started with vFabric SQLFire
Overview of vFabric SQLFire
Data Flow Diagram
GemFire, Apache Derby, and SQL Components
Understanding the SQLFire Distributed System
vFabric SQLFire Members
Servers, Peer Clients, and Server Groups
Discovery Mechanisms
Group Membership Service
Replicated Tables and Partitioned Tables
Parallel Execution of Data-Aware Stored Procedures
Cache Plug-ins for External Data Connections
Installing vFabric SQLFire
Installation Note for vFabric Platform Customers
RHEL Only: Install vFabric SQLFire from the VMWare YUM Repository
Install vFabric SQLFire from a JAR File
Activating vFabric SQLFire Licensing
Understand vFabric SQLFire License Options
Choose a License Option Based on Topology
How vFabric SQLFire Manages Licensing
Install and Configure vFabric SQLFire Licenses
Verify Your License and Check Your License Usage
Upgrading vFabric SQLFire
RHEL Only: Upgrade vFabric SQLFire from the VMWare YUM Repository
Upgrade Issues
Connect to vFabric SQLFire with JDBC Tools
Tutorials
Main Steps
Create a SQLFire Cluster
Connect to the Cluster Using SQLF
Create Replicated Tables and Execute Queries
Implement a Partitioning Strategy
Persist Tables to Disk
Add Servers to the Cluster and Stop Servers
Perform Additional Tasks
vFabric SQLFire Features and Benefits
Managing Your Data in vFabric SQLFire
Designing vFabric SQLFire Databases
Design Principles of Scalable, Partition-Aware Databases
Identify Entity Groups and Partitioning Keys
Use Entity Groups Instead of "Sharding"
Replicate Code Tables
Dealing with Many-to-Many Relationships
Example: Adapting a Database Schema for SQLFire
Using Server Groups to Manage Data
Server Groups Overview
Adding Members to Server Groups
Assigning Tables to Server Groups
Partitioning Tables
How Table Partitioning Works
Understanding Where Data Is Stored
Failure and Redundancy
Creating Partitioned Tables
Partitioning Examples
Colocating Related Rows from Multiple Tables
Making a Partitioned Table Highly Available
Limiting the Memory Consumption on a Member
Rebalancing Partitioned Data on SQLFire Members
Managing Replication Failures
Replicating Tables
How SQLFire Replicates Tables
Deciding When to Use Replicated Tables
Creating Replicated Tables
Estimating Memory Requirements
Estimating SQLFire Overhead
Viewing Memory Usage in SYS.MEMORYANALYTICS
Enabling SYS.MEMORYANALYTICS
Understanding Table and Index Values
Displaying the Total Memory Footprint
Using Disk Stores to Persist Data
Overview of Disk Stores
What SQLFire Writes to the Disk Store
Disk Store State
Disk Store Directories
Disk Store Persistence Attributes
Disk Store File Names and Extensions
Disk Store Operation Logs
Factors Contributing to High Disk Throughput
Guidelines for Designing Disk Stores
Creating a Disk Store or Using the Default
Persist Table Data to a Disk Store
Optimizing Availability and Performance
Starting System with Disk Stores
Start a System with Disk Stores
Disk Store Management
Validate a Disk Store
Compacting Disk Store Log Files
Backing Up and Restoring Online Disk Stores
Backing Up and Restoring Offline Disk Stores
Handling Missing Disk Stores
Exporting and Importing Data with vFabric SQLFire
Using SQLF Commands to Export and Import Data
Export, Alter, and Import a Database Schema Using SQLF
Using Apache DdlUtils to Import Data
Overview of DdlUtils
Export, Alter, and Import a Database Schema Using DdlUtils
Example build.xml File
Using Table Functions to Import Data as a SQLFire Tables
Overview of SQLFire Table Functions
Preferred getXXX() methods for SQLFire Table Functions
Example Table Function
Developing Applications with SQLFire
Starting SQLFire Servers with the FabricServer Interface
Starting a Network Server
Developing Java Clients and Peers
Connect to a SQLFire Server with the Thin Client JDBC Driver
Start a SQLFire Peer with the Peer Client JDBC Driver
Using SQLFire as an Embedded JDBC Datasource
Storing and Loading JAR Files in SQLFire
Class Loading Overview
Create JAR Files for Your Application
Manage JAR Files in SQLFire
Code Your Applications
Alternate Methods for Managing JAR Files
Developing ADO.NET Client Applications
About the ADO.NET Driver
ADO.NET Driver Classes
Installing and Using the ADO.NET driver
Connecting to SQLFire with the ADO.NET Driver
Managing Connections
Executing SQL Commands
Working with Result Sets
Storing a Table
Storing Multiple Tables
Specifying Command Parameters with SQLFParameter
Updating Row Data
Adding Rows to a Table
Managing SQLFire Transactions
Performing Batch Updates
Generic Coding with the SQLFire ADO.NET Driver
Using SQLFire.NET Designer
Installing SQLFire.NET Designer
Connecting to a SQLFire Distributed System
Editing Tables
Understanding the Data Consistency Model
Data Consistency Concepts
No Ordering Guarantee for DML in Separate Threads
Updates on Any Row Are Atomic and Isolated
Atomicity for Bulk Updates
Using Distributed Transactions in Your Applications
Overview of SQLFire Distributed Transactions
Supported Transaction Isolation Levels
Transactions and DDL Statements
Handling Member Failures
Sequence of Events for a Distributed Transaction
SQLFire Transaction Design
Best Practices for Using Transactions
Transaction Functionality and Limitations
Using Data-Aware Stored Procedures
Configuring a Procedure
Configuring a Custom Result Processor
Invoking a Procedure
High Availability for SQLFire Procedures
Default Result Processor
Example JDBC Client
Using the Procedure Provider API
Procedure Parameters
Populating OUT and INOUT Parameters
Populating Result Sets
Using the <local> and <global> Escape Syntax with Nested Queries
Using the Custom Result Processor API
Implementing the ProcedureResultProcessor Interface
Example Result Processor: MergeSort
Procedure Implementation
Merge Sort Result Processor
Programming User-Defined Types
Caching Data with vFabric SQLFire
SQLFire Cache Strategies
Using a RowLoader to Load Existing Data
How SQLFire Invokes a RowLoader
Implementing the RowLoader Interface
Using the JDBCRowLoader Example
Evicting Table Data from SQLFire
How LRU Eviction Works
Limitations of Eviction
Eviction in Partitioned Tables
Create a Table with Eviction Settings
Handling DML Events Synchronously
Writer and Listener Cache Plug-ins
Example Writer Implementation
Example Listener Implementation
Handling DML Events Asynchronously
How the AsyncEventListener Works
Implementation Requirements
Implementing an AsyncEventListener
Using DBSynchronizer to Apply DML to an RDBMS
How DBSynchronizer Works
Restrictions and Limitations
Configuring DBSynchronizer
Suppressing Event Callbacks for a vFabric SQLFire Connection
Deploying vFabric SQLFire
SQLFire Deployment Models
Embedded Peer-to-Peer Deployment
Client-Server Deployment
Multi-site Deployment
How Multi-site Systems Work
Supported and Unsupported Topologies
How Multi-site Event Distribution Works
Supported and Unsupported Topologies
Steps to Plan and Configure a Deployment
Configuring Discovery Mechanisms
Using Locators
Start and Stop Locators
Start SQLFire Peers and Servers Using Locators
Connect to a Distributed System Using Locators
Configure Multicast Discovery
Starting and Configuring SQLFire Servers
Start and Stop SQLFire Servers Using sqlf
Specify the Server Working Directory
Specify Client Connection Information
Define Server Groups
Execute SQL When You Start a Server
Using Additional Boot Properties
Configuring SQLFire Properties
Configuring Multi-site (WAN) Deployments
About Gateways
About High Availability for WAN Deployments
Limitations of Multi-Site Replication
Prerequisites for WAN Replication
Steps to Configure a Multi-site Deployment
Configure Locators for WAN Member Discovery
Create and Start Gateway Sender
Create Tables with Gateway Senders
Create a Gateway Receiver
Start and Stop Gateway Senders
Add and Remove Gateway Senders and Receivers
Configuring Authentication and Authorization
Configuring User Authentication
User Authentication and Member Ownership
Enable User Authentication
Creating Users for BUILTIN Authentication
Create System Users
Encrypt the Password of a System User
Change a System User Password
Create Distributed System Users
Configuring LDAP Directory Service
Configure SQLFire to Use Your LDAP Directory Service
Guest Access to Search for DNs
LDAP Restrictions and Performance Guidelines
JNDI-Specific Properties for External Directory Services
JMX and Authentication
User Names in Authentication and Authorization
User Names and Authorization Identifiers
Conversion of User Name to Authorization Identifier
SQLFire Member JVM Owner
Configuring User Authorization
Set the SQL Standard Authorization Mode
Set the Default Connection Access Mode
Set the Authorizations for Individual Users
Read-only and Full Access Permissions
User Authorization Exceptions
Set User Permissions for Database Objects in SQL Standard Authorization
Configuring Network Encryption and Authentication with SSL/TLS
Generate Key Pairs and Certificates
Start the Server with SSL/TLS
Run a Client with SSL/TLS
Managing and Monitoring vFabric SQLFire
Configuring and Using SQLFire Log Files
Log Message Format
Severity Levels
Using java.util.logging.Logger for Application Log Messages
Using Trace Flags for Advanced Debugging
Querying SQLFire System Tables and Indexes
Getting Information About SQLFire Members
Getting Information About User Tables
Evaluating Query Execution Plans and Query Statistics
Capture the Query Execution Plan for Individual Statements
Capture Query Execution Plans for All Statements
View Query Plans and Statistics
SQLFire Query Execution Plan Codes
Overriding Optimizer Choices
Evaluating System and Application Performance
Collecting System Statistics
Collecting Application Statistics
Using VSD to Analyze Statistics
Transaction Performance
Table Performance
SQL Statement Performance
Application Performance
Memory Usage
CPU Usage
Using Java Management Extensions (JMX)
Overview of the vFabric SQLFire JMX Agent
Example Configuration
Starting the JMX Agent
Agent Properties File and Log Files
Basic JMX Agent Properties
Distributed System Properties for JMX Agent
E-mail Notification Properties for the JMX Agent
Stopping the JMX Agent
Configuring JMX Connectors and Adapters
RMIConnectorServer Properties
MX4J/Http Adaptor Properties
SSL Communication Properties
vFabric SQLFire MBeans
Best Practices for Tuning Performance
Tune Application Logic
Reduce Distribution Overhead
Reduce Overhead of Eviction to Disk
Minimize Update Latency for Replicated Tables
Tune FabricServers
Tuning Disk I/O
Running SQLFire in Virtualized Environments
Detecting and Handling Network Segmentation ("Split Brain")
vFabric SQLFire Reference
Configuration Properties
JDBC API
Mapping java.sql.Types to SQL Types
java.sql.BatchUpdateException Class
java.sql.Connection Interface
java.sql.DatabaseMetaData Interface
java.sql.Driver Interface
java.sql.DriverManager.getConnection Method
java.sql.PreparedStatement Interface
java.sql.ResultSet Interface
java.sql.SavePoint Class
java.sql.SQLException Class
java.sql.Statement Class
javax.sql.XADataSource
sqlf Launcher Commands
sqlf backup
sqlf compact-all-disk-stores
sqlf compact-disk-store
sqlf encrypt-password
sqlf install-jar
sqlf list-missing-disk-stores
sqlf locator
sqlf Logging Support
sqlf merge-logs
sqlf remove-jar
sqlf replace-jar
sqlf revoke-missing-disk-store
sqlf server
sqlf shut-down-all
sqlf stats
sqlf validate-disk-store
sqlf version
sqlf write-data-dtd-to-file
sqlf write-data-to-db
sqlf write-data-to-xml
sqlf write-schema-to-db
sqlf write-schema-to-sql
sqlf write-schema-to-xml
sqlf Interactive Commands
absolute
after last
async
autocommit
before first
close
commit
connect
connect client
connect peer
describe
disconnect
driver
elapsedtime
execute
exit
first
get scroll insensitive cursor
GetCurrentRowNumber
help
last
LocalizedDisplay
MaximumDisplayWidth
next
prepare
previous
protocol
relative
remove
rollback
run
set connection
show
wait for
SQLFire API
CredentialInitializer
UserAuthenticator
Procedure Implementation Interfaces
ProcedureExecutionContext
OutgoingResultSet
Procedure Result Processor Interfaces
ProcedureResultProcessor
ProcedureProcessorContext
IncomingResultSet
SQL Language Reference
Keywords and Identifiers
Standard SQL Identifiers
SQL Statements
ALTER TABLE
CALL (PROCEDURE)
CREATE Statements
CREATE ASYNCEVENTLISTENER
CREATE DISKSTORE
CREATE FUNCTION
CREATE GATEWAYRECEIVER
CREATE GATEWAYSENDER
CREATE GLOBAL HASH INDEX
CREATE INDEX
CREATE PROCEDURE
CREATE SCHEMA
CREATE SYNONYM
CREATE TABLE
CREATE TRIGGER
CREATE TYPE
CREATE VIEW
DECLARE GLOBAL TEMPORARY TABLE
DELETE
EXPLAIN
DROP statements
DROP ASYNCEVENTLISTENER
DROP GATEWAYRECEIVER
DROP GATEWAYSENDER
DROP FUNCTION
DROP INDEX
DROP PROCEDURE
DROP SCHEMA
DROP TABLE
DROP TRIGGER
DROP TYPE
DROP VIEW
GRANT
INSERT
Query
REVOKE
SELECT
SET ISOLATION
SET SCHEMA
UPDATE
SQL Clauses
FOR UPDATE Clause
FROM Clause
GROUP BY Clause
HAVING Clause
OFFSET and FETCH FIRST Clauses
ORDER BY Clause
WHERE Clause
SQL Expressions
SelectExpression
TableExpression
VALUES Expression
Expression Precedence
Boolean Expressions
Dynamic Parameters
Where Dynamic Parameters Are Allowed
JOIN Operations
INNER JOIN Operation
LEFT OUTER JOIN Operation
RIGHT OUTER JOIN Operation
Built-in Functions
Standard Built-in Functions
Aggregates (set functions)
ABS or ABSVAL function
ACOS function
ASIN function
ATAN function
ATAN2 function
AVG function
BIGINT function
CASE expressions
CAST function
CEIL or CEILING function
CHAR function
COALESCE function
Concatenation operator
COS function
COSH function
COT function
COUNT function
COUNT(*) function
CURRENT DATE function
CURRENT_DATE function
CURRENT ISOLATION function
CURRENT_ROLE function
CURRENT SCHEMA function
CURRENT TIME function
CURRENT_TIME function
CURRENT TIMESTAMP function
CURRENT_TIMESTAMP function
CURRENT_USER function
DATE function
DAY function
DEGREES function
DOUBLE function
EXP function
FLOOR function
HOUR function
INTEGER function
LCASE or LOWER function
LENGTH function
LN or LOG function
LOG10 function
LOCATE function
LTRIM function
MAX function
MIN function
MINUTE function
MOD function
MONTH function
NULLIF expressions
PI function
RADIANS function
RANDOM function
RAND function
RTRIM function
SECOND function
SESSION_USER function
SIGN function
SIN function
SINH function
SMALLINT function
SQRT function
SUBSTR function
SUM function
TAN function
TANH function
TIME function
TIMESTAMP function
TRIM function
UCASE or UPPER function
USER function
VARCHAR function
XMLEXISTS operator
XMLPARSE operator
XMLQUERY operator
XMLSERIALIZE operator
YEAR function
SQLFire Built-in Functions
DSID Function
GROUPS Function
GROUPSINTERSECT Function
GROUPSINTERSECTION Function
GROUPSUNION Function
Built-in System Procedures
Standard Built-in Procedures
SYSCS_UTIL.EMPTY_STATEMENT_CACHE
SYSCS_UTIL.EXPORT_QUERY
SYSCS_UTIL.EXPORT_TABLE
SYSCS_UTIL.IMPORT_TABLE
SYSCS_UTIL.SET_EXPLAIN_CONNECTION
SYSCS_UTIL.SET_STATISTICS_TIMING
SYSCS_UTIL.SET_USER_ACCESS
JAR Installation Procedures
SQLJ.INSTALL_JAR
SQLJ.REMOVE_JAR
SQLJ.REPLACE_JAR
Callback Configuration Procedures
SYS.ADD_LISTENER
SYS.ATTACH_LOADER
SYS.ATTACH_WRITER
SYS.REBALANCE_ALL_BUCKETS
SYS.REMOVE_LISTENER
SYS.REMOVE_LOADER
SYS.REMOVE_WRITER
SYS.START_ASYNC_EVENT_LISTENER
SYS.STOP_ASYNC_EVENT_LISTENER
Heap Eviction Configuration Procedures
SYS.SET_EVICTION_HEAP_PERCENTAGE
SYS.SET_EVICTION_HEAP_PERCENTAGE_SG
WAN Configuration Procedures
SYS.START_GATEWAYSENDER
SYS.STOP_GATEWAYSENDER
Data Types
SQL Standards Conformance
System Tables
ASYNCEVENTLISTENERS table
GATEWAYRECEIVERS table
GATEWAYSENDERS table
MEMBERS system table
MEMORYANALYTICS system table
STATEMENTPLANS system table
SYSALIASES system table
SYSCHECKS system table
SYSCOLPERMS system table
SYSCOLUMNS system table
SYSCONGLOMERATES system table
SYSCONSTRAINTS system table
SYSDEPENDS system table
SYSDISKSTORES system table
SYSFILES system table
SYSFOREIGNKEYS system table
SYSKEYS system table
SYSROLES system table
SYSROUTINEPERMS system table
SYSSCHEMAS system table
SYSSTATEMENTS system table
SYSSTATISTICS system table
SYSTABLEPERMS system table
SYSTABLES system table
SYSTRIGGERS system table
SYSVIEWS system table
Exception Messages and SQL States
ADO.NET Driver Reference
SQLFire Data Types in ADO.NET
VMware.Data.SQLFire.BatchUpdateException
VMWare.Data.SQLFire.SQLFClientConnection
VMware.Data.SQLFire.SQLFCommand
VMware.Data.SQLFire.SQLFCommandBuilder
VMware.Data.SQLFire.SQLFType
VMware.Data.SQLFire.SQLFDataAdapter
VMware.Data.SQLFire.SQLFDataReader
VMware.Data.SQLFire.SQLFException
VMware.Data.SQLFire.SQLFParameter
VMware.Data.SQLFire.SQLFParameterCollection
VMware.Data.SQLFire.SQLFTransaction
vFabric SQLFire Limitations
SQL Language Limitations
Query Capabilities and Limitations
ADO.NET Driver Limitations
Troubleshooting Common Problems
vFabric SQLFire Glossary
vFabric Hyperic 4.6
vFabric Hyperic Overview
About vFabric Hyperic Overview
Intended Audience
Use of "Hyperic," "vFabric Hyperic," and "Hyperic HQ"
Introduction to Hyperic Monitoring
Main Components
Hyperic Agent
Hyperic Server and Hyperic Database
Hyperic User Interface (Hyperic Portal)
Hyperic Monitoring and Management Features
Key Hyperic Facts for the New User
Resources, Resource Types and Inventory Types
Resources and Resource Categories in Hyperic
Inventory Type
Resource Type
Platform Server Service Hierarchy
Graphical View of a Resource Hierarchy
Platform Hierarchy In Hyperic User Interface
About Platforms, Servers, and Services
Platforms
Operating System Platforms
Virtual and Network Platforms
Servers
Services and Platform Services
About Groups in Hyperic
Resource Groups in Hyperic
Compatible Groups
Mixed Groups
Autogroups
View a List of Autogroups on a Resource
View Monitor Tab for an Autogroup
View Monitor Tab for a Member of an Autogroup
About Applications in Hyperic
Introduction to Applications in Hyperic
Inventory Tab for an Application
Monitor Tab for an Application
User Accounts and Roles in Hyperic
Authentication
User Accounts in Hyperic
Built-in Accounts
User Account Creation and Authentication
Hyperic HQ User Accounts
vFabric Hyperic User Accounts
Roles in vFabric Hyperic
Permission Matrix: Grants Access to Types
About Permission Levels
Permission Tips
How HQ Validates Platform-Server-Service Permission Level Assignments
Groups: Grant Access to Specific Resources
Alert Calendar: Enable Shift-Based Notifications
Built-in Roles
SuperUser
Guest Role
Hyperic Roles and LDAP Groups
Resource Auto-Discovery Processes
Hyperic Auto-Discovery Processes
Default Scan
File Scan
Runtime Scan
About Auto-Inventory IDs and InstallPath
What the Agent Can and Cannot Discover
How Discovered Resources Get into Hyperic Inventory
What to Do After Adding New Resources to Inventory
Metrics and Metric Collection
Metric Categories
Availability
Throughput
Utilization
Performance
Metric Value Types
Baselines
Uses for Baselines in Hyperic
Baselines in the Hyperic User Interface
How a Baseline is Calculated
Default Metric Collection Settings
Log and Configuration Event Tracking
Hyperic Log Tracking Overview
Hyperic Resource Types that Support Log Tracking
Supported Log Message Types
Log Tracking Configuration Options
How to Set Up Log Tracking
Hyperic Configuration Tracking Overview
Event-Based Configuration Tracking
Polling-Based Configuration Tracking
How to Set Up Configuration Tracking
How to View Event Data
Resource Control in Hyperic
Control Action Overview
Alerts and Alert Definitions
Alerts
Functionality of a Resource Alert
Alert Definition Process
Alerts in the Hyperic User Interface
Fixing and Acknowledging Alerts
Enabling and Disabling Alert Definitions
Introduction to Escalation Schemes
Options for Controlling Alert and Notification Volume
Responding to Alert and Notification Storms
Advanced Alert Functionality in vFabric Hyperic
SNMP Functionality in Hyperic
Simple SNMP Agent Availability Checks
Monitor SNMP Devices and Hosts with Built-In Plugins
Build Vendor-Specific SNMP Plugins
Send SNMP Notifications for Alerts
Integrate Hyperic with OpenNMS
vFabric Hyperic Installation and Configuration
About vFabric Hyperic Installation and Configuration
Intended Audience
vFabric Hyperic QuickStart Installation
Key Facts for Hyperic Installers
Hyperic Security Features and Recommendations
SSL Best Practices for New Hyperic Installations
Agent-Initiated Communication
Protection of Sensitive Data
Use LDAP Authentication
About SSL in Hyperic
Hyperic SSL Support
Overview of Hyperic 4.6.x SSL Configuration and Defaults
Hyperic 4.6.x SSL Certificate Processing
SSL Between a 4.6.x Server and 4.5.x Agents
SSL and Hyperic Product Plugins
About Agent Configuration
Agent Startup Configuration Data
Optional Agent Configuration Properties
Supported Locations for agent.properties
How to Change Agent Setup Configuration Properties
About the Agent Launcher and Agent Startup
Agent Launcher
What Happens When an Agent Starts Up
Automatic Restart Behavior
About Agent - Server Communication
Agent-to-Server Communication
Server-to-Agent Communication
Unidirectional Agent-Server Communications
Unidirectional Communication via a Proxy
Agent Directory Structure
About Sizing Profiles in vFabric Hyperic
Deployment Size and Installation Sizing Profiles
Server Property Values for Sizing Profile
How to Select an Installation Sizing Profile
Install and Set Up Hyperic
Installation Requirements
Agent Server Compatibility Requirements
Hyperic Server Requirements
Hyperic Server JRE Requirements
Hyperic Server Resource Requirements
Hyperic Server Operating System Requirements
X Libraries on Unix-Based Platforms
Hyperic Server Supported Databases
Supported Browsers
Hyperic Database Requirements
Hyperic Agent Requirements
Agent System Resource Requirements
Agent Operating System Requirements
Agent JRE Requirements
Drivers for Monitoring Databases
Hyperic Installation and Startup Process
Step 1 – Obtain Hyperic Installer
Step 2 – Set Up Hyperic Database
Step 3 - Set Up Hyperic Server
Step 4 - Set Up the Hyperic Agent
Step 5 - Next Steps for New Installations
Hyperic Upgrade Processes
Hyperic 4.6 Upgrade Options
Upgrade Hyperic Server Only
Upgrade Server and Agent with Hyperic-Managed Keystores
Upgrade Server and Agent with User-Managed Keystores
Step-by-Step Procedures
Select and Download an Installer
Key Facts About Hyperic Installer Packaging
Installer Types
Hyperic Installer Features
Where to Get Hyperic Installation Packages
Configure JREs for Hyperic Components
About Hyperic JREs
Hyperic Agent JRE on Unix
Hyperic Agent JRE on Windows
Configure SSL Options
SSL Setup for New Hyperic Installations
SSL Setup for Upgrade Installations
Managed Products and SSL
Reconfigure Hyperic for Trusted SSL Certificates
Reconfigure Hyperic for Self-Signed Certificates
Set Up MySQL
Set Up Hyperic Database on MySQL
Step 1 - Create a MySQL Database Instance
Step 2 - Configure MySQL Startup Options and System Variables
Step 3 - Verify Database Setup
Solve Problems with MySQL Startup
Tune the Batch Aggregate Inserter for MySQL
Set Up Oracle
Set Up Hyperic Database on Oracle
Create Hyperic Database
Create Tablespaces
Create the Database User
Grant Permissions to the Database User
Set Up Hyperic Server
Enable Row Movement
Tuning Hyperic Database on Oracle for Medium to Large Environments
Create the TS_HQDB_16K Tablespace
Configure REDO Logs
Configure Initialization Parameters for Oracle
Configure Batch Aggregate Inserter
Move Database Tables
Rebuild Indexes for Moved Tables
Configure Tables for High Concurrency
Restart Hyperic Server
Periodic Oracle Database Maintenance
Set Up PostgreSQL
Set Up External Hyperic Database on PostgreSQL
Example Configuration
Install and Initialize PostgreSQL
Create PostgreSQL User
Configure PostgreSQL Server Options
PostgreSQL Tuning for Large Deployments (Optional)
Configure Client Authentication
Install PostgreSQL Client on the Hyperic Server Host
Install the Hyperic Server
Start Hyperic Server
Troubleshoot PostgreSQL Connection Problems
Useful PostgreSQL Commands
Run Hyperic Installer
Obtain Hyperic Installer
About the Setup Script
Run the Setup Script
Install an Agent-Only Package
Install from Agent Tarball
Install from Agent Zip Archive
Run Windows MSI Installer
About the Hyperic MSI Installer
Interactive MSI Installation
Interactive Complete Install
Interactive Custom Install
Silent MSI Installation
Command Line Syntax
MSI Silent Mode Properties
Example Silent Mode MSI Invocations
Silent MSI installation to Multiple Hosts Using Push Techniques
Using AT or SOON to start a process on a remote workstation
Using PsExec to Start a Process on a Remote System
Remote Installs with Microsoft Management Console
Solving Service Startup Problems After MSI Install
Install Hyperic Server RPM
About the Hyperic Server RPMs
Step 1 - Specify Server Configuration in Properties File
Step 2 - Install Hyperic Server
Step 3 - Configure Hyperic Server After RPM Installation
Configure Hyperic Server Interactively after Installation
Configure Hyperic Server in Properties File after Installation
Server Properties File for RPM Installation
Install Hyperic Agent RPM
About the Agent RPM
Install Agent RPM
Set Up Agent Interactively
About the Agent Configuration Dialog
Launch the Configuration Dialog
Agent Configuration Dialog
Set Up Agent in Properties File
Agent Properties Location
Procedure: Configure Agent-Server Communication Properties
Step 1 - Open or create agent.properties
Step 2 - Uncomment Agent-Server Communication Properties
Step 3 - Define Communication Properties in agent.properties File
Step 4 - Configure Unidirectional Communications (Optional)
Step 5 - Configure Agent Keystore (Optional)
Step 6 - Configure Additional Agent Behaviors (Optional)
Step 7 - Save Changes
Communication Properties Reference
Install Hyperic Agents in Volume
Establish Installation Environment
Set up an Install Server
Establish Environment on Target Platforms
Create Standard Agent Properties File
Perform Remote Agent Installations
Install and Start Agents One-by-One
Deploy and Start Multiple Agents at Once
Verify Successful Agent Startup
Upgrade Hyperic Agent
Agent Upgrade Methods
Push Agent Bundle from the vFabric Hyperic Server
Upgrade Agent Bundle Manually
Create a Custom Agent Upgrade Bundle
Upgrade Agent Using a Full Agent Package
Upgrade Hyperic Server
What Happens During Server Upgrade
Upgrade Hyperic Server on Unix-Based Platforms
Upgrade Hyperic Server on Windows Platforms
Scaling Hyperic Server in vFabric Hyperic 4.6.5
Solving Problems with Upgraded Servers with an Oracle Database
Uninstalling an Agent
Change vFabric Hyperic Server Sizing Profile
Configure Unidirectional Agent - Server Communication
Changing from Bidirectional to Unidirectional Communications
Changing from Unidirectional to Bidirectional Communications
Install or Configure vFabric Hyperic License
License Consumption in vFabric Hyperic
Install or Configure License
Configure and Run the Hyperic Server
Start and Stop Hyperic Server
Starting the Server on Unix-Based Platforms
Starting Hyperic Server After Installing from RPM
Starting the Server on Windows To Run as a Service
Configure Hyperic Server Java Options
Configure Metric Baselining and Alert Processing Behavior
Configure Global Alert Properties
Configure Alert Notification Throttling
Configure Alert Notification Email Properties
Configure Metric Baselining Properties
Scaling and Tuning Hyperic Performance
Sizing Considerations
Server Configuration Settings for Scaling
About Java Heap and Garbage Collection
About Hyperic Server Caches
Monitoring Hyperic Caches
Interpreting Cache Statistics
Configuring Caches
Configure Hyperic Version and Security Announcements
Integrate Hyperic Server with Other Systems
Configure Kerberos Properties
Configure LDAP Properties
LDAP Authentication in vFabric Hyperic
Configure LDAP Authentication and Role Assignment
Configuring Hyperic Server for SMTP Server
Enable vFabric Hyperic to Send SNMP Traps
Configure HQ Server to Send SNMP Traps
Configure vFabric Hyperic Server for SNMP v1
Configure vFabric Hyperic Server for SNMP v2c
Configure vFabric Hyperic Server for SNMP v3
Using SNMP Traps in Alert Definitions
Managing the HQ Database
Building a Metric Data Warehouse
Metric Replication Strategy Overview
Instructions for Establishing Secondary MySQL Database for Metrics
Set Up the Secondary Database
Test the New Views
Set up the Metric Data Replicator
Create log4j Properties File
Create Script to Run the Replication Process
Run the Replication Process
Verify the Replication Process Results
Query 1 - Show all the disk stats
Query 2 - Component Service Usage Information for Servers and Services
Hyperic Database Backup and Recovery
Backing up Built-In PostgreSQL Database
Backup and Recovery of MySQL and Oracle Databases
Hyperic Files to Backup
Configure Hyperic Server Data Compression and Purge Behavior
Hyperic Server Data Management Processes
Configure Hyperic Data Management Settings
Monitoring the Hyperic Database
Hyperic Database Table Schemas
Key Resource and Measurement Tables
EAM_RESOURCE Table - All Resource Types and Instances
Tables for Inventory Resources
Tables for Platform, Server, and Service Types
Tables for Measurement Information
Table Documentation
EAM_PLATFORM
EAM_PLATFORM_TYPE
EAM_SERVER
EAM_SERVICE
EAM_RESOURCE
EAM_MEASUREMENT
EAM_MEASUREMENT_TEMPL
MySQL Maintenance Examples
Clustering Hyperic Servers for Failover
Overview
Requirements for an Failover Deployment
Configuring a Server Cluster
Step 1 - Install the First Hyperic Server Instance
Step 2 - Install Additional Hyperic Server Nodes
Step 3 - Configure Cluster Name and Communications Properties
Default hq-server.conf File
Required Cluster Properties
Optional Cluster Properties
Step 4 - Configure the Load Balancer
Step 5 - Configure Agents to Communicate with Hyperic Server Cluster
Step 6 - Start the Nodes
Troubleshooting a Failover Configuration
Hyperic Server Properties
About Hyperic Server Configuration
Configuration Settings in hq-server.conf
Configuration Settings in the Database
Server Property Definitions
Clustering Properties in vFabric Hyperic
accept.unverified.certificates
server.database-driver
server.java.opts
server.quartzDelegate
server.database-url
server.connection-validation-sql
server.database-password
server.database-user
server.encryption-key
server.webapp.port
server.webapp.secure.port
server.plugin.custom.dir
server.keystore.password
server.keystore.path
server.pluginsync.enable
server.hibernate.dialect
server.jms.jmxport
server.jms.usejmx
server.database-blockingtimeout
server.database-minpoolsize
server.database
tomcat.minsparethreads
tomcat.maxthreads
server.jms.maxmemory
server.jms.highmemory
server.database-maxpoolsize
server.mail.host
vfabric.licenseServer.url
Configure and Run the Hyperic Agent
Start, Stop, and Other Agent Operations
Run the Agent Launcher from the Command Line
Running hq-agent.sh
Running hq-agent.bat
Run the Agent Launcher from the Hyperic User Interface
Restart an Agent from the Hyperic User Interface
Ping an Agent from the Hyperic User Interface
Upgrade an Agent from the Hyperic User Interface
Push a Resource Plugin to the Agent from the Hyperic User Interface
Run the Agent Without the Java Service Wrapper
Configure Auto-Discovery Scanning and Reporting
Configure Agent Logging
Agent Log Files
Configure Agent Log Name or Location
Configure Agent Logging Level
Redirect System Messages to the Agent Log
Configure Debug Log Level for an Agent Subsystem
Configure Plugin Loading
Tweak the Agent to Enable a Resource Plugin
Configure Agent Account Privileges under Solaris 10
Configure Agent HTTP Request Header
Configure Agent to Monitor JBoss
Configure Agent to Monitor WebSphere Application Server
Configure Hyperic Agent to Manage WebLogic Server
Specify WebLogic Server Installation Path
Configure Hyperic Agent for Two-Way SSL with WebLogic Server
Configure the Data to Log for Windows Events
Manage the Hyperic Agent
View Status of all Hyperic Agents
Agents Tab in HQ Health
Health Data for an Agent
View Hyperic Agent Metrics
Agent Monitoring Defaults
View Agent Indicators Charts
View Agent Metric Data
Hyperic Agent Metrics
Reduce Agent Memory Footprint
Limit Plugin Loading
Reduce Java Heap
agent.javaOpts
Delete Javadocs Folder
Agent Properties
agent.eventReportBatchSize
agent.javaOpts
agent.keystore.alias
agent.keystore.password
agent.keystore.path
agent.listenIp
agent.listenPort
agent.logDir
agent.logFile
agent.logLevel
agent.logLevel.SystemErr
agent.logLevel.SystemOut
agent.maxBatchSize
agent.proxyHost
agent.proxyPort
agent.storageProvider.info
agent.setup.acceptUnverifiedCertificate
agent.setup.camIP
agent.setup.camLogin
agent.setup.camPort
agent.setup.camPword
agent.setup.camSecure
agent.setup.camSSLPort
agent.setup.agentIP
agent.setup.agentPort
agent.setup.resetupToken
agent.setup.unidirectional
agent.startupTimeOut
autoinventory.defaultScan.interval.millis
autoinventory.runtimeScan.interval.millis
http.useragent
log4j Properties
jboss.installpath
platform.log_track.eventfmt
plugins.exclude
plugins.include
scheduleThread.cancelTimeout
scheduleThread.fetchLogTimeout
scheduleThread.poolsize
scheduleThread.queuesize
sigar.mirror.procnet
snmpTrapReceiver.listenAddress
weblogic.auth.method
weblogic.discovery.new
weblogic.installpath
weblogic.ssl2ways.cert
weblogic.ssl2ways.key
weblogic.ssl2ways.key.pass
websphere.installpath
websphere.useext
Troubleshoot Agent and Server Problems
Looking for Clues
HQ Health
hqstats and agentstats
Agent Metrics
Log Files
Thread Dumps
Generate a Hyperic Server Thread Dump from User Interface
Generate a Hyperic Server Thread Dump from Command Line
Generate Agent Thread Dump from User Interface
Check Port Availability
Hyperic Server Problems
Large Event Table
License Issues
Backlogged Hyperic Server
Agent Startup or Connection Problems
Agent Failed to Connect to Server at First Startup
Server Does Not Have Agent Token
Agent Start Script Timeout
Java Service Wrapper Timeout
Invalid or Unknown Availability
Out-of-Sync Agent and Server Clocks
Overloaded Backend
Overloaded Agent
Slow User Interface
Warning Messages in the Agent Log
Connection Timeout Messages
vFabric Hyperic Administration
About vFabric Hyperic Administration
Intended Audience
Discover and Import Resources to Inventory
Using the Auto-Discovery Portlet
Contents of the Auto-Discovery Portlet
Import or Skip Resources in Auto-Discovery Portlet
Configure the Number of Auto-Discoveries Displayed
Using the Auto-Discovery Results Page
Contents of the Auto-Discovery Results Page
Import or Skip Resources in Auto-Discovery Results Page
Options for Running and Controlling Resource Discovery
Scan a Platform On-Demand
Configure Default and Runtime Scanning Frequency
Configure Frequency of Default Scan
autoinventory.defaultScan.interval.millis
Disable Default Scan
Configure Frequency of Runtime Scan
autoinventory.runtimeScan.interval.millis
Exclude a Plugin Resource Hierarchy
Disable Platform Service Discovery
sigar.mirror.procnet
netservices.netstat
Disable Service Discovery for a Server Instance
Manage Resource Auto-Discovery
Configure Auto-Discovery Frequency
Configure Frequency of Default Scan
autoinventory.defaultScan.interval.millis
Disable Default Scan
Configure Frequency of Runtime Scan
autoinventory.runtimeScan.interval.millis
Scan a Platform On-Demand
Prevent Resource Discovery
Configure an Agent to Not Load a Plugin
Remove Plugin from All Agents
Disable Platform Service Discovery
sigar.mirror.procnet
netservices.netstat
Disable Service Discovery for a Server Instance
Solving Auto-Discovery Problems
Removed Resources Not Rediscovered
Discovered Resources Not Imported
Auto-Discovering WebLogic Server on Linux and Solaris
Auto-Discovering Server Types on Solaris
Set Up Alert Notifications and Escalations
Tailor Alert Notification Templates
Groovy Server Pages Define Notification Content and Format
Email Notifications
Email Notification Subject Line
Email Notification Body
Variables Available for Notification Templates
Configure Roles for Role-Based Alert Notifications
Roles for Alert Notifications
Follow the Sun Alerting with Role-Based Alert Calendars
Creating Roles
Enable SNMP Trap Notifications
Configure HQ Server to Send SNMP Traps
Configure vFabric Hyperic Server for SNMP v1
Configure vFabric Hyperic Server for SNMP v2c
Configure vFabric Hyperic Server for SNMP v3
Using SNMP Traps in Alert Definitions
Enable Syslog Notifications for Escalations
About Syslog Notifications in Alert Escalations
Enable Syslog Notifications
Enable the Syslog Receiver
Enable Syslog Appender
Restart Hyperic Server
Configure and Manage Escalations
Create an Escalation
Step 1 - Create New Escalation Scheme
Step 2 - Create Escalation Actions
Create an Email or SMS Action
Create a Sys Log Action
Create an SNMP Notification Action
Create a Suppress Alerts Action
View an Escalation
Edit an Escalation
Delete an Escalation
Set Up Alert Action Script
Define a Script Action for an Alert
Environment Variables for Fired Alert Data
Example Script
Assign the Script Action to an Alert
Configure a Custom Control Action
Step 1 - Install Executable
Step 2 - Configure Control Action as a Platform Service
Configure Monitoring and Alerting for a Resource
Configure Metric Baselines
Configure Global Baselining Properties
Recalculate Baselines for a Resource
Reset Baselines for a Charted Metric
Set Up Log Tracking for a Resource
Log Tracking Overview
Configure Log Tracking
Hyperic Resource Types that Support Log Tracking
Supported Log Message Types
Log Tracking Configuration Options
Log Tracking for Resources with Log4j Logs
Log Tracking for Network Services
Log Tracking for Windows Platforms
Content of Logged Windows Events
Tailoring the Content and Format of Logged Windows Events
platform.log_track.eventfmt Property
View Log Events
Defining Alert Conditions Based on Log Events
Log Tracking Support Classes
Set Up Configuration Tracking for a Resource
Hyperic Configuration Tracking Functionality
Set Up 4.6.5 Configuration Tracking for a Server
Set Up Polling-Based Configuration Tracking
View Configuration Events for a Resource
Configure Alerts Based on Configuration Events
Define an Alert for a Resource
Step 1 - Select Target Resource
Step 2 - Define Alert Properties
Step 3 - Define Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Step 4 - Define Alert Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
Define a Recovery Alert for a Resource Alert
Understanding Recovery Alerts
Define Primary Alert Definition to Disable Itself
Create a Recovery Alert Definition for a Resource Alert
Define Host Dependencies for Hierarchical Alerting
Define Network Host Relationships
Step 1 - Select a Top Level Platform to Update
Option A - Browse a Filtered List of Top Level Platforms
Option B - Navigate from a Dependent Platform
Step 2 - Manage a Top Level Platform's Dependents
Schedule Resource Downtime
Schedule Downtime
Configure Monitoring and Alerting for a Resource Type
Tailor Metric Collection for a Resource Type
Navigate to the Monitoring Defaults Page for a Resource Type
Enable Collection of a Metric
Disable Collection of a Metric
Change a Metric Collection Interval
Set Indicator Metrics
APIs for Metric Collection Settings
Define an Alert for a Resource Type
Define a Resource Type Alert
Step 1 - Select Target Resource Type
Step 2 - Define Alert Properties
Step 3 - Define Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Step 4 - Define Alert Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
Define a Recovery Alert for a Resource Type Alert
Understanding Recovery Alerts
Define Primary Alert Definition to Disable Itself
Create a Recovery Alert Definition for a Resource Type Alert
About Global Monitoring and Alerting Settings
Configure Global Alert Properties
Configure Alert Notification Throttling
Configure Alert Notification Email Properties
Configure Metric Baselining Properties
Configure Hyperic Version and Security Announcements
Manage Alert and Notification Volume
Manage Alerting for Optimal Visibility into Problems
Prevent Multiple Alerts for the Same Problem
Disable all Alert Notifications
Hierarchical Alerting Prevents a Cascade of Alerts in Resource Hierarchies
Configure Network Host Dependencies for Hierarchical Alerting
Set a Notification Throttle
Enable or Disable all Alert Definitions
Manage Alert Definitions
View and Edit Alert Definitions
List Alert Definitions for a Resource
List Alert Definitions for a Resource Type
List Alert Definitions for a Resource Group
View All Alert Definitions for all Resources
View and Edit an Alert Definition
Enable and Disable Alert Definitions
Enable or Disable a Resource Alert Definition
Enable or Disable Multiple Alert Definitions for a Resource
Enable or Disable a Resource Type Alert Definition
Enable or Disable an Group Alert Definition
Enable or Disable all Alert Definitions for Multiple Resources
Enable or Disable all Alert Definitions
Enable Alert Definition Change Logging
Create and Manage Resource Groups and Applications
Configure and Manage Resource Groups
Create a Group
Add Resources to a Group
Assign Roles to a Group
Edit a Group's Inventory Properties
Remove Resources from a Group
Remove Roles from a Group
Define an Alert for a Resource Group
Understanding Resource Group Alerts
Define a Resource Group Alert
Step 1 - Select Target Compatible Group
Step 2 - Define Alert Properties
Step 3 - Define Alert Condition
Step 4 - Assign Escalation Action
Schedule Downtime for a Resource Group
Schedule Downtime
Create and Manage Applications
Instrument Java Components (Optional)
Create an Application
Add Services to an Application
Add Application to a Group
Monitoring an Application with Indicator Charts
Configuring Hyperic as an SNMP Trap Receiver
Receiving SNMP Traps from Network Devices or Systems
Step 1 - Select and Enable an Agent to Receive Traps
Step 2 - Configure Trap Generator
Step 3 - Create a Proxy Platform for Trap Data
Solving Problems
Manage Hyperic Users and Roles
Create and Manage User Accounts
Create a New User Account
Define User Account Attributes
Assign Roles to a New User Account
List User Accounts
View a User Account
Modify User Account Settings
Change Password
Edit Account Settings
Update Roles Assigned to a User
Create and Manage Roles in vFabric Hyperic
Create a Role
Assign Users to a Role
Assign Groups to a Role
Define Alert Calendar for Follow-the-Sun Role-Based Notifications
Customize Role-Specific Dashboard
Use Roles for Follow the Sun Alerting
List Roles
View a Role
Properties Section
Permissions Section
Assigned Users
Assigned Groups
Alert Calendar
Edit a Role
Role-Based Dashboards in vFabric Hyperic
Role-Based Dashboards
Role-Based Dashboards are Automatically Available
Permissions for Modifying Role-Based Dashboards
Tailor a Role-Based Dashboard
Manage Inventory with HQApi
View and Manage Resource Data
View Inventory Properties for a Resource
View Inventory Properties for a Platform
Navigate to the Inventory Page for a Platform
Inventory Page Header
Resource Properties
Map Control for a Platform
Tools Menu for a Platform
General Properties for a Platform
Type and Network Properties for a Platform
Servers on a Platform
Services on a Platform
Groups Containing a Platform
Configuration Properties for a Platform
View Inventory Properties for a Server
Inventory Page for a Server
Inventory Page Header for a Server
Resource Properties
Map Control for a Server
Tools Menu for a Server
General Properties for a Server
Type and Host Properties
Services on a Server
Groups Containing a Server
Configuration Properties for a Server
View Inventory Properties for a Service
Inventory Page for a Service
Inventory Page Header for a Service
Resource Properties
Map Control for a Service
Tools Menu for a Service
General Properties for a Service
Groups Containing a Service
Configuration Properties for a Service
View Inventory Properties for a Group
Navigate to the Inventory Page for a Group
Inventory Page Header for a Group
Resource Properties for a Group
Map Control for a Compatible Group
Tools Menu for a Group
General Properties for a Group
Resources
Roles a Group is Assigned To
View Inventory Properties for an Application
Inventory Page for an Application
Inventory Page Header for an Application
Resource Properties
Tools Menu for an Application
General Properties for an Application
Application Properties
Service Counts for an Application
Services in an Application
Groups Containing an Application
Group Manager
Create a Platform, Server, or Service Manually
Create a Platform
When to Create a Platform Manually
Add a Platform to Inventory from the Hyperic User Interface
Configure Platform for Monitoring
Clone a Platform
Cloning a Platform
How to Clone a Platform
What Cloning is Good For
What Cloning Does
What Cloning Doesn't Do
Create a Platform Service
When to Manually Create a Platform Service
Create a Platform Service
Configuration Instructions for Platform Services
Create a Server
When to Create a Server Manually
Create a Server
Inventory Page for a New Server
Configure Server for Monitoring
Create a Service
When to Create a Service Manually
Add a Service to Inventory from the Hyperic User Interface
Remove Resources from Hyperic Inventory
Delete a Resource Manually
Delete Resources with HQApi
Plugin Deployment and Management
Key Hyperic Plugin Management Features
Version Requirements for Plugin Synchronization
Plugin Administration Tasks
Resource Plugin Deployment Directories
About Plugin Manager
About Custom Plugin Deployment with Plugin Manager
About Plugin Removal with Plugin Manager
About Plugin Sync at Startup
About Plugin Sync at Agent Startup
About Plugin Sync at Server Startup
Disable Server-Agent Plugin Synchronization
vFabric Hyperic Resource Configuration and Metrics
About vFabric Hyperic Resource Configuration and Metrics
Intended Audience
GemFire
GemFire Plugin Overview
Supported Versions
GemFire Resources and the Hyperic Inventory Model
Configuration Overview
Resource Types and Management Functions
Management Functions for GemFire Distributed System
Management Functions for JMX Agent
Management Functions for Cache Server 6.5
Management Functions for Cache Server 6.5 Region
Management Functions for Gateway Hub 6.5
Management Functions for Gateway Hub 6.5 Gateway
Management Functions for Gateway Hub 6.5 Region
Management Functions for Application Peer 6.5
Management Functions for Application Peer 6.5 Region
Configuration Instructions
Step 1: Enable GemFire Member Discovery and Monitoring
Step 2: Configure Hyperic Agent for the DS
Step 3: Configure a Platform for the DS
Step 4: Set Event Tracking Options
Step 5: Tailor Plugin Monitoring Defaults
Step 6: Configure Alert Definitions
Metric Documentation
GemFire Distributed System Metrics
Member Metrics
Region Metrics
Gateway Hub 6.5 Gateway Metrics
GemFire Events
Hyperic GemFire View
GemFire View for a DS
GemFire View for a Cache Server or Application Peer
GemFire View for a Gateway Hub
Java Applications
Auto-Discovery of Custom MBeans
Prerequisites and Supported Environments
Java Version
Supported Containers
Enable Discovery of a Stand-Alone Instrumented Java Application
MBeanServer
Create a MBeanServer in Tomcat
Create an MBeanServer for Stand-Alone Apps or Other Container
Enable ModelMBean Export in JBoss Containers
Step 1 - Set Up Resources to Export ModelMBeans
Step 2 - Verify Model MBean Export to MBeanServer
Step 3 - Verify Service Application Auto-Discovery
Solving Problems with Service Auto-Discovery
Step 4 - Configure App Services as an Application in HQ
Model MBean Naming and Descriptor Data
Key Facts About ModelMBeans and Service Discovery
ModelMBean ObjectName Format
ModelMBeanInfo Descriptors
ModelMBeanAttributeInfo Descriptors
ModelMBeanOperationInfo Descriptors
JBoss
Monitoring JBoss
JBoss Configuration Tracking
JBoss Metrics
JBoss 7 server
JBoss 7 server
JBoss 7 Datasource service
JBoss 7 Connector service
JBoss 7 deployment service
JBoss 7 Connector service
JBoss Managed 7 server
JBoss Managed 7 server
JBoss Managed 7 Connector service
JBoss Managed 7 Datasource service
JBoss Managed 7 deployment service
JBoss Host Controller 7 server
JBoss Host Controller 7 server
JBoss 6.0 server
JBoss 6.0 server
JBoss 6.0 EJB 3 service
JBoss 6.0 Hibernate Session Factory service
JBoss 6.0 JCA Connection Pool service
JBoss 6.0 JCA Data Source service
JBoss 6.0 JGroups Channel service
JBoss 6.0 JMS HornetQ QUEUE service
JBoss 6.0 JMS HornetQ Topic service
JBoss 6.0 JMS QUEUE Destination service
JBoss 6.0 JMS Topic service
JBoss 6.0 Message Driven EJB service
JBoss 6.0 Stateful Session EJB service
JBoss 6.0 Stateless Session EJB service
JBoss 6.0 WebApp service
JBoss 5.1 server
JBoss 5.1 server
JBoss 5.1 EJB 3 service
JBoss 5.1 Hibernate Session Factory service
JBoss 5.1 JCA Connection Pool service
JBoss 5.1 JCA Data Source service
JBoss 5.1 JGroups Channel service
JBoss 5.1 JMS QUEUE Destination service
JBoss 5.1 JMS Topic service
JBoss 5.1 Message Driven EJB service
JBoss 5.1 Stateful Session EJB service
JBoss 5.1 Stateless Session EJB service
JBoss 5.1 WebApp service
JBoss 5.0 server
JBoss 5.0 server
JBoss 5.0 EJB 3 service
JBoss 5.0 Hibernate Session Factory service
JBoss 5.0 JCA Connection Pool service
JBoss 5.0 JCA Data Source service
JBoss 5.0 JGroups Channel service
JBoss 5.0 JMS QUEUE Destination service
JBoss 5.0 JMS Topic service
JBoss 5.0 Message Driven EJB service
JBoss 5.0 Stateful Session EJB service
JBoss 5.0 Stateless Session EJB service
JBoss 5.0 WebApp service
JBoss 4.3 server
JBoss 4.3 server
JBoss 4.3 EJB3 service
JBoss 4.3 Entity EJB service
JBoss 4.3 Hibernate Session Factory service
JBoss 4.3 JCA Connection Pool service
JBoss 4.3 JCA Data Source service
JBoss 4.3 JGroups Channel service
JBoss 4.3 JMS Destination service
JBoss 4.3 JMS Queue Destination service
JBoss 4.3 JMS Topic service
JBoss 4.3 Message Driven EJB service
JBoss 4.3 Stateful Session EJB service
JBoss 4.3 Stateless Session EJB service
JBoss 4.2 server
JBoss 4.2 server
JBoss 4.2 EJB3 service
JBoss 4.2 Entity EJB service
JBoss 4.2 Hibernate Session Factory service
JBoss 4.2 JCA Connection Pool service
JBoss 4.2 JCA Data Source service
JBoss 4.2 JGroups Channel service
JBoss 4.2 JMS Destination service
JBoss 4.2 JMS Topic service
JBoss 4.2 Message Driven EJB service
JBoss 4.2 Stateful Session EJB service
JBoss 4.2 Stateless Session EJB service
JBoss 4.0 server
JBoss 4.0 server
JBoss 4.0 EJB3 service
JBoss 4.0 Entity EJB service
JBoss 4.0 Hibernate Session Factory service
JBoss 4.0 JCA Connection Pool service
JBoss 4.0 JCA Data Source service
JBoss 4.0 JMS Destination service
JBoss 4.0 JMS Topic service
JBoss 4.0 Message Driven EJB service
JBoss 4.0 Stateful Session EJB service
JBoss 4.0 Stateless Session EJB service
JBoss 3.2 server
JBoss 3.2 server
JBoss 3.2 Entity EJB service
JBoss 3.2 JCA Connection Pool service
JBoss 3.2 JMS Destination service
JBoss 3.2 JMS Topic service
JBoss 3.2 Message Driven EJB service
JBoss 3.2 Stateful Session EJB service
JBoss 3.2 Stateless Session EJB service
Local Platform Services
When to Manually Create a Platform Service
Create a Platform Service
Configuration Instructions for Platform Services
FileServer Directory Service
File Server Directory
Create FileServer Directory Service in Hyperic.
File Server Directory Service Configuration Options
FileServer Directory Service Metrics
Event Tracking
FileServer Directory Tree Service
File Server Directory Tree
Create FileServer Directory Tree Service in Hyperic
File Server Directory Tree Service Configuration Options
FileServer Directory Service Metrics
Event Tracking
FileServer File Service
FileServer File
Create FileServer File Service in Hyperic
File Server File Service Configuration Options
FileServer File Service Metrics
Event Tracking
FileServer Mount Service
FileServer Mount
Create FileServer Mount Service in Hyperic
FileServer Mount Service Configuration Options
FileServer Mount Service Metrics
Event Tracking
Multiprocess Service
Multiprocess
Specifying Process Queries
Create Multiprocess Service in Hyperic
Process Service Configuration Options
Process Service Metrics
Process Service
Process
Specifying Process Queries
Create Process Service in Hyperic
Process Service Configuration Options
Process Service Metrics
Control
Event Tracking
Script Service
Script Service Overview
Create Script Service in Hyperic
Script Service Configuration Options
Script Service Metrics
Event Tracking
CPU Service
CPU Service
CPU Service Metrics
Event Tracking
NetworkServer Interface Service
NetworkServer Interface
NetworkServer Interface Service Metrics
Windows Service Service
Monitoring a Windows Service
Resource Plugin, Functions, and Classes
Configure the Windows Service in Hyperic
Windows Service Configuration Properties Page
Windows Service Metrics
Windows Service Monitoring Defaults Page
Event Tracking
Nagios
Nagios Resources and the Hyperic Inventory Model
Management Functions
Auto-Discovery
Metric Collection
Log Tracking
Configure Nagios Monitoring
Prerequisites
Install Hyperic Agent
Create and Configure Nagios Server Resource for Monitoring
Configure Hyperic Alerts on Nagios Checks
View Nagios Resources and Metrics in Hyperic
View Nagios Service Detail
View a Nagios Check
NetApp Filer
NetApp Filer Plugin Overview
NetApp Filer Resources and the HQ Inventory Model
Configuration Instructions
Prerequisites
Step 1 - Configure the Filer in HQ
NetApp Filer Configuration Properties Page
NetApp Filer Configuration Options
Step 2 - Configure Tracking of Trap Events (Optional)
Step 3 - Configure Alert Definitions (Optional)
Understand NetApp Plugin Management Functions and Metrics
Auto-Discovery
NetApp Filer Platform Properties
NetApp Filer File System Properties
NetApp Filer Interface Properties
Metric Collection
NetApp Filer Metrics
NetApp Filer File System Metrics
NetApp Filer Interface Service Metrics
NetApp Filer NFS Server v2 Metrics
NetApp Filer NFS Server v3 Metrics
NetApp Filer CIFS Server Metrics
Solving Problems
NetApp Filer platform metrics
NetApp Filer CIFS Server service metrics
NetApp Filer File System service metrics
NetApp Filer Interface service metrics
NetApp Filer NFS server v2 service metrics
NetApp Filer NFS server v3 service metrics
Network Device
Monitoring a Network Device
Network Device Resources and the Hyperic Inventory Model
Configuration Instructions
Step 1 - Configure the Network Device in Hyperic
Configuration Properties Page
Network Device Configuration Options
Step 2 - Configure Tracking of Trap Events (Optional)
Step 3 - Configure Alert Definitions (Optional)
Step 4 - Define Dependency Relationships (Optional)
Management Functions
Auto-Discovery
Metric Collection
Network Device Metrics
Network Interface Metrics
Solving Problems
Network Platform Services
Hyperic Network Service Monitoring Capabilities
Configuration Requirements and Options for Monitoring Network Services
Metrics for Network Services
Classes for Monitoring a Network Service
Services Hyperic Can Monitor Over the Network
DHCP Platform Service
Monitor a Remote DHCP Service
Resource Plugin, Functions, and Classes
Configure the DHCP Service in HQ
Configuration Properties Page
DHCP Configuration Options
DHCP Metrics
DHCP Monitoring Defaults Page
Event Tracking
DNS Platform Service
Monitor a Remote DNS Service
Resource Plugin, Functions, and Classes
Configure a DNS Service in Hyperic
Configuration Properties Page
DNS Configuration Options
DNS Metrics
DNS Monitoring Defaults Page
Event Tracking
FTP Platform Service
Monitor a Remote FTP Service
Resource Plugin, Functions, and Classes
Configure the FTP Service in HQ
Configuration Properties Page
FTP Configuration Options
FTP Metrics
FTP Monitoring Defaults Page
Event Tracking
HTTP Platform Service
Monitoring a Remote HTTP Service
Resource Plugin, Functions, and Classes
Configure the HTTP Service in Hyperic
HTTP Configuration Properties Page
HTTP Configuration Options
HTTP Metrics
Http Monitoring Defaults Page
Event Tracking
IMAP Platform Service
Monitor a Remote IMAP Server
Resource Plugin, Functions, and Classes
Configure the IMAP Service in HQ
Configuration Properties Page
IMAP Configuration Options
IMAP Metrics
IMAP Monitoring Defaults Page
Event Tracking
InetAddress Ping Platform Service
Monitoring an Internet Address
Resource Plugin, Functions, and Classes
Configure the InetAddress Ping Service in Hyperic
Configuration Properties Page
InetAddress Ping Configuration Options
InetAddress Ping Metrics
InetAddress Ping Monitoring Defaults Page
Event Tracking
LDAP Platform Service
Monitor a Remote LDAP Service
Resource Plugin, Functions, and Classes
Configure the LDAP Service in HQ
Configuration Properties Page
LDAP Configuration Options
LDAP Metrics
LDAP Monitoring Defaults Page
Event Tracking
NTP Platform Service
Monitor a Remote NTP Server
Resource Plugin, Functions, and Classes
Configure the NTP Service in HQ
Configuration Properties Page
NTP Configuration Options
Metrics
NTP Monitoring Defaults Page
Event Tracking
POP3 Platform Service
Monitor a Remote POP3 Service
Resource Plugin, Functions, and Classes
Configure the POP3 Service in HQ
Configuration Properties Page
POP3 Configuration Options
Metrics
POP3 Monitoring Defaults Page
Event Tracking
RPC Platform Service
Monitor a Remote RPC Service
Resource Plugin, Functions, and Classes
Configure the RPC Service in HQ
Configuration Properties Page
RPC Configuration Options
RPC Metrics
RPC Monitoring Defaults Page
RPC Event Tracking
SMTP Platform Service
Monitoring a Remote SMTP Service
Resource Plugin, Functions, and Classes
Configure the SMTP Service in Hyperic
Configuration Properties Page
SMTP Configuration Options
SMTP Metrics
SMTP Monitoring Defaults Page
Event Tracking
SNMP Platform Service
Monitor a Remote SNMP Agent
Resource Plugin, Functions, and Classes
Configure the SNMP Service in Hyperic
Configuration Properties Page
SNMP Configuration Options
SNMP Metrics
SNMP Monitoring Defaults Page
SSH Platform Service
Resource Plugin, Functions, and Classes
Configure the SSH Service in Hyperic
Configuration Properties Page
SSH Configuration Options
SSH Metrics
SSH Monitoring Defaults
Event Tracking
TCP Socket Platform Service
Monitoring a Remote TCP Server
Resource Plugin, Functions, and Classes
Configure the TCP Socket Service in HQ
TCP Socket Configuration Properties Page
TCP Socket Configuration Options
TCP Socket Metrics
TCP Socket Monitoring Defaults Page
Event Tracking
PostgreSQL
Configure PostgreSQL Monitoring
PostgreSQL Configuration Tracking
PostgreSQL Metrics
PostgreSQL 8.4 server
PostgreSQL 8.4 server
PostgreSQL 7.4 Table service
PostgreSQL 8.3 Index service
PostgreSQL 9.0 server
PostgreSQL 9.0 server
PostgreSQL 8.0 server
PostgreSQL 8.0 server
JBoss 3.2 Hibernate Session Factory service
PostgreSQL 7.4 Index service
PostgreSQL 9.0 Index service
PostgreSQL 8.1 Table service
PostgreSQL 7.4 server
PostgreSQL 7.4 server
PostgreSQL 8.4 Table service
PostgreSQL 8.2 Index service
PostgreSQL 9.0 Table service
PostgreSQL 8.2 server
PostgreSQL 8.2 server
PostgreSQL 8.3 server
PostgreSQL 8.3 server
PostgreSQL 8.4 Index service
PostgreSQL 8.0 Index service
PostgreSQL 8.1 server
PostgreSQL 8.1 server
PostgreSQL 8.2 Table service
PostgreSQL 8.1 Index service
PostgreSQL 8.3 Table service
PostgreSQL 8.0 Table service
RabbitMQ
RabbitMQ Plugin Overview
Supported Versions and Requirements
RabbitMQ Resources and the Hyperic Inventory Model
SSL Requirements
Configuration Instructions
Step 1: Remove Previous RabbitMQ Inventory Resources and Agent Installation
Step 2: Install Hyperic Agent
Step 3: Import RabbitMQ Server(s) to Inventory
Step 4: Set Event Tracking Options
Step 5: Tailor Plugin Monitoring Defaults
Step 6: Configure Alert Definitions
Resource Types and Management Functions
Auto-Discovery
RabbitMQ Server Properties
RabbitMQ Exchange Service Properties
RabbitMQ Queue Service Properties
RabbitMQ VirtualHost Service Properties
RabbitMQ Connection Service Properties
RabbitMQ Channel Service Properties
Metric Collection
RabbitMQ Metrics
RabbitMQ Exchange Metrics
RabbitMQ Queue Metrics
RabbitMQ VirtualHost Metrics
RabbitMQ Connection Metrics
RabbitMQ Channel Metrics
RabbitMQ server
RabbitMQ VirtualHost service
RabbitMQ Queue service
RabbitMQ Exchange service
RabbitMQ Channel service
RabbitMQ Connection service
Spring Application server
Spring Insight
Spring Insight Plugin Overview
About Spring Insight
Functionality of Hyperic Spring Insight Plugin
Supported Versions and Requirements
Spring Insight Resources and the Hyperic Inventory Model
Installation Environment
Configuration Instructions
Step 1: Install Hyperic Agents
Step 2: Import Insight Dashboard to Hyperic Inventory
Step 3: Tailor Plugin Monitoring Defaults (Optional)
Step 3: Tailor Alert Definitions (Optional)
Resource Types and Management Functions
Auto-Discovery
Spring Insight
Spring Insight Application
Metric Collection
Spring Insight Dashboard Metrics
Spring Insight Application Metrics
Application Server Metrics
Database Metrics
Platform Metrics
Pre-Configured Alert Definitions
Application Health Alert
Application Error Alert
Spring Insight Applications View
Sun JVM
Step 1 - Configure JVM for JMX Monitoring
Step 2 - Add JVM to HQ Inventory
Step 3 - Configure JVM for Monitoring
tc Server
Configure a tc Server Instance
tc Runtime Configuration
Navigating tc Runtime Configuration Pages
Saving or Undoing Changes
User Permissions Required to Use the tc Runtime Features
Configuring General tc Runtime Options
Configuring Startup Options
Configuring the Context Container
Configuring JSP Options
Configuring Static Content Defaults
Using the Advanced Server Configuration Options
Reloading Settings From Server
Reverting to a Previously Saved Configuration
Uploading a Configuration File
Configuring and Creating JDBC Data Sources
Configuring and Creating tc Runtime Services
Configuring and Creating Connectors
Configuring and Creating Virtual Hosts
Configuring tc Runtime Logging
Manage tc Server Applications
tc Runtime Application Management
Navigating to a tc Runtime Instance Or Group
Creating tc Runtime Groups
Listing Applications
Deploying Applications
Undeploying Applications
Starting Applications
Stopping Applications
Reloading Applications
Server Configuration Reference
tc Runtime Configuration Reference
General Configuration
Server Properties
JMX Listener
Server Start Configuration
General
Sun Specific JVM Options
Advanced
Context Container
Static Resource Cache
Web Application Logger
Server Defaults - JSP
Server Defaults - Static Content
JDBC Configuration Reference
tc Runtime JDBC Reference
General Properties
Connection Properties
Tomcat/DBCP Connection Pool Properties
Service Configuration Reference
tc Runtime Services Reference
General Service Properties
Connector Properties
General
Security/SSL
APR SSL Settings
Engine Properties
Thread Diagnostics
Host Properties
HTTP Access Logging
Metrics
tc Runtime 6.0
SpringSource tc Runtime 6.0 Web Module Stats service
SpringSource tc Runtime 6.0 Tomcat JDBC Connection Pool Global service
SpringSource tc Runtime 6.0 Tomcat JDBC Connection Pool Context service
SpringSource tc Runtime 6.0 Thread Pools service
SpringSource tc Runtime 6.0 Thread Diagnostics Host service
SpringSource tc Runtime 6.0 Thread Diagnostics Engine service
SpringSource tc Runtime 6.0 Thread Diagnostics Context service
SpringSource tc Runtime 6.0 Servlet Monitor service
SpringSource tc Runtime 6.0 server
SpringSource tc Runtime 6.0 JSP Monitor service
SpringSource tc Runtime 6.0 Java Process Metrics service
SpringSource tc Runtime 6.0 HTTP service
SpringSource tc Runtime 6.0 Global Request Processor service
SpringSource tc Runtime 6.0 Garbage Collector service
SpringSource tc Runtime 6.0 Executor service
SpringSource tc Runtime 6.0 Data Source Global service
SpringSource tc Runtime 6.0 Data Source Context service
SpringSource tc Runtime 6.0 Cache service
tc Runtime 7.0
SpringSource tc Runtime 7.0 Web Module Stats service
SpringSource tc Runtime 7.0 Tomcat JDBC Connection Pool Global service
SpringSource tc Runtime 7.0 Tomcat JDBC Connection Pool Context service
SpringSource tc Runtime 7.0 Thread Pools service
SpringSource tc Runtime 7.0 Thread Diagnostics Host service
SpringSource tc Runtime 7.0 Thread Diagnostics Engine service
SpringSource tc Runtime 7.0 Thread Diagnostics Context service
SpringSource tc Runtime 7.0 Servlet Monitor service
SpringSource tc Runtime 7.0 server
SpringSource tc Runtime 7.0 JSP Monitor service
SpringSource tc Runtime 7.0 Java Process Metrics service
SpringSource tc Runtime 7.0 HTTP service
SpringSource tc Runtime 7.0 Global Request Processor service
SpringSource tc Runtime 7.0 Garbage Collector service
SpringSource tc Runtime 7.0 Executor service
SpringSource tc Runtime 7.0 Data Source Global service
SpringSource tc Runtime 7.0 Data Source Context service
SpringSource tc Runtime 7.0 Cache service
vSphere
vSphere Plugin Overview
Supported Versions and Requirements
vSphere Resources and the Hyperic Inventory Model
Configuration Overview
Resource Types and Management Functions
Management Functions for VMware vCenter
Management Functions for VMware vSphere Hosts
Management Functions for VMware vSphere VMs
vSphere Components in the Hyperic User Interface
vSphere Components in the Resource Hub
View a VMware vCenter Instance in the Resource Hub
View a VMware vSphere Host in the Resource Hub
View a VMware vSphere VM in the Resource Hub
vSphere Components in vFabric Hyperic
Configuration Instructions
Step 1 - Setup Agent Keystore
Step 2 - Install Hyperic Agent
Step 3 - Configure Agent Properties
Step 4 - Tune Agent and vSphere Plugin for Large Virtual Environment (Optional)
Step 5 - Configure vCenter Server Access Credentials
Step 6 - Set Event Tracking Options
Step 7 - Configure vCenter Statistics Level
Step 8 - Tailor Plugin Monitoring Defaults
Step 9 - Install Hyperic Agents in VMs
Step 10 - Configure Alert Definitions
Metric Documentation
VMware vSphere Host Metrics
VMware vSphere Host DS Metrics
VMware vSphere VM Metrics
VMware vSphere VM DS Metrics
Events
AccountCreatedEvent
AccountRemovedEvent
AccountUpdatedEvent
AdminPasswordNotChangedEvent
AlarmActionTriggeredEvent
AlarmCreatedEvent
AlarmEmailCompletedEvent
AlarmEmailFailedEvent
AlarmReconfiguredEvent
AlarmRemovedEvent
AlarmScriptCompleteEvent
AlarmScriptFailedEvent
AlarmSnmpCompletedEvent
AlarmSnmpFailedEvent
AlarmStatusChangedevent
AllVirtualMachinesLicensedevent
AlreadyAuthenticatedSessionEvent
BadUsernameSessionEvent
CanceledHostOperationEvent
ClusterComplianceCheckedEvent
ClusterCreatedEvent
ClusterDestroyedEvent
ClusterOvercommittedEvent
ClusterReconfiguredEvent
ClusterStatusChangedEvent
com.vmware.license.AddLicenseEvent
com.vmware.license.AssignLicenseEvent
com.vmware.license.LicenseAssignFailedEvent
com.vmware.license.LicenseExpiryEvent
com.vmware.license.RemoveLicenseEvent
com.vmware.license.UnassignLicenseEvent
com.vmware.vc.cim.CIMGroupHealthStateChanged
CustomFieldDefAddedEvent
CustomFieldDefEvent
CustomFieldDefRemovedEvent
CustomFieldDefRenamedEvent
CustomFieldValueChangedEvent
CustomizationFailed
CustomizationLinuxIdentityFailedEvent
CustomizationNetworkSetupFailedEvent
CustomizationStartedEvent
CustomizationSucceeded
CustomizationSysprepFailedEvent
DasAdmissionControlDisabledEvent
DasAdmissionControlEnabledEvent
DasAgentFoundEvent
DasAgentUnavailableEvent
DasClusterIsolatedEvent
DasDisabledEvent
DasEnabledEvent
DasHostFailedEvent
DasHostIsolatedEvent
DatacenterCreatedEvent
DatacenterRenamedEvent
DatastoreCapacityIncreasedEvent
DatastoreDestroyedEvent
DatastoreDiscoveredEvent
DatastoreDuplicatedEvent
DatastoreFileCopiedEvent
DatastoreFileDeletedEvent
DatastoreFileMovedEvent
DatastorePrincipalConfigured
DatastoreRemovedOnHostEvent
DatastoreRenamedEvent
DatastoreRenamedOnHostEvent
DrsDisabledEvent
DrsEnabledEvent
DrsEnteredStandbyModeEvent
DrsEnteringStandbyModeEvent
DrsExitedStandbyModeEvent
DrsExitingStandbyModeEvent
DrsExitStandbyModeFailedEvent
DrsInvocationFailedEvent
DrsRecoveredFromFailureEvent
DrsResourceConfigureFailedEvent
DrsResourceConfigureSyncedEvent
DrsVmMigratedEvent
DrsVmPoweredOnEvent
DuplicateIpDetectedEvent
DVPortgroupCreatedEvent
DVPortgroupDestroyedEvent
DVPortgroupReconfiguredEvent
DVPortgroupRenamedEvent
DvsCreatedEvent
DvsDestroyedEvent
DvsEvent
DvsHostBackInSyncEvent
DvsHostJoinedEvent
DvsHostLeftEvent
DvsHostWentOutOfSyncEvent
DvsMergedEvent
DvsPortBlockedEvent
DvsPortConnectedEvent
DvsPortCreatedEvent
DvsPortDeletedEvent
DvsPortDisconnectedEvent
DvsPortJoinPortgroupEvent
DvsPortLeavePortgroupEvent
DvsPortLinkDownEvent
DvsPortLinkUpEvent
DvsPortReconfiguredEvent
DvsPortUnblockedEvent
DvsReconfiguredEvent
DvsRenamedEvent
DvsUpgradeAvailableEvent
DvsUpgradedEvent
DvsUpgradeInProgressEvent
DvsUpgradeRejectedEvent
EnteredMaintenanceModeEvent
EnteredStandbyModeEvent
EnteringMaintenanceModeEvent
EnteringStandbyModeEvent
ErrorUpgradeEvent
ExitedStandbyModeEvent
ExitingStandbyModeEvent
ExitMaintenanceModeEvent
ExitStandbyModeFailedEvent
FailoverLevelRestored
GeneralEvent
GeneralHostErrorEvent
GeneralHostInfoEvent
GeneralHostWarningEvent
GeneralUserEvent
GeneralVmErrorEvent
GeneralVmInfoEvent
GeneralVmWarningEvent
GhostDvsProxySwitchDetectedEvent
GhostDvsProxySwitchRemovedEvent
GlobalMessageChangedEvent
HealthStatusChangedEvent
HostAddedEvent
HostAddFailedEvent
HostAdminDisableEvent
HostAdminEnableEvent
HostCnxFailedAccountFailedEvent
HostCnxFailedAlreadyManagedEvent
HostCnxFailedBadCcagentEvent
HostCnxFailedBadUsernameEvent
HostCnxFailedBadVersionEvent
HostCnxFailedCcagentUpgradeEvent
HostCnxFailedEvent
HostCnxFailedNetworkErrorEvent
HostCnxFailedNoAccessEvent
HostCnxFailedNoConnectionEvent
HostCnxFailedNoLicenseEvent
HostCnxFailedNotFoundEvent
HostCnxFailedTimeoutEvent
HostComplianceCheckedEvent
HostCompliantEvent
HostConfigAppliedEvent
HostConnectedEvent
HostConnectionLostEvent
HostDasDisabledEvent
HostDasDisablingEvent
HostDasEnabledEvent
HostDasEnablingEvent
HostDasErrorEvent
HostDasOkEvent
HostDisconnectedEvent
HostEnableAdminFailedEvent
HostExtraNetworksEvent
HostGetShortNameFailedEvent
HostInventoryFullEvent
HostInventoryUnreadableEventEventindicating that the virtual machine inventory file on the host is damaged or unreadable.
HostIpChangedEvent
HostIpInconsistentEvent
HostIpToShortNameFailedEvent
HostIsolationIpPingFailedEvent
HostLicenseExpiredEvent
HostMissingNetworksEvent
HostMonitoringStateChangedEvent
HostNoAvailableNetworksEvent
HostNoHAEnabledPortGroupsEvent
HostNonCompliantEvent
HostNoRedundantManagementNetworkEvent
HostNotInClusterEvent
HostOvercommittedEvent
HostPrimaryAgentNotShortNameEvent
HostProfileAppliedEvent
HostReconnectionFailedEvent
HostRemovedEvent
HostShortNameInconsistentEvent
HostShortNameToIpFailedEvent
HostShutdownEvent
HostStatusChangedEvent
HostSyncFailedEvent
HostUpgradeFailedEvent
HostUserWorldSwapNotEnabledEvent
HostVnicConnectedToCustomizedDVPortEvent
HostWwnChangedEvent
HostWwnConflictEvent
IncorrectHostInformationEvent
InfoUpgradeEvent
InsufficientFailoverResourcesEvent
InvalidEditionEvent
LicenseExpiredEvent
LicenseNonComplianceEvent
LicenseRestrictedEvent
LicenseServerAvailableEvent
LicenseServerUnavailableEvent
LocalDatastoreCreatedEvent
LockerMisconfiguredEvent
LockerReconfiguredEvent
MigrationErrorEvent
MigrationHostErrorEvent
MigrationHostWarningEvent
MigrationResourceErrorEvent
MigrationResourceWarningEvent
MigrationWarningEvent
NASDatastoreCreatedEvent
NoAccessUserEvent
NoDatastoresConfiguredEvent
NoLicenseEvent
NoMaintenanceModeDrsRecommendationForVM
NotEnoughResourcesToStartVmEvent
OutOfSyncDvsHost
PermissionAddedEvent
PermissionRemovedEvent
PermissionUpdatedEvent
ProfileAssociatedEvent
ProfileChangedEvent
ProfileCreatedEvent
ProfileDissociatedEvent
ProfileEvent
ProfileReferenceHostChangedEvent
ProfileRemovedEvent
ResourcePoolCreatedEvent
ResourcePoolDestroyedEvent
ResourcePoolMovedEvent
ResourcePoolReconfiguredEvent
ResourceViolatedEvent
RoleAddedEvent
RoleRemovedEvent
RoleUpdatedEvent
ScheduledTaskCompletedEvent
ScheduledTaskCreatedEvent
ScheduledTaskEmailCompletedEvent
ScheduledTaskEmailFailedEvent
ScheduledTaskEvent
ScheduledTaskFailedEvent
ScheduledTaskReconfiguredEvent
ScheduledTaskRemovedEvent
ScheduledTaskStartedEvent
ServerLicenseExpiredEvent
ServerStartedSessionEvent
SessionTerminatedEvent
TaskEvent
TaskTimeoutEvent
TemplateBeingUpgradedEvent
TemplateUpgradedEvent
TemplateUpgradeFailedEvent
TimedOutHostOperationEvent
UnlicensedVirtualMachinesEvent
UnlicensedVirtualMachinesFoundEvent
UpdatedAgentBeingRestartedEvent
UpgradeEvent
UserAssignedToGroup
UserLoginSessionEvent
UserLogoutSessionEvent
UserPasswordChanged
UserUnassignedFromGroup
UserUpgradeEvent
VcAgentUninstalledEvent
VcAgentUninstallFailedEvent
VcAgentUpgradedEvent
VcAgentUpgradeFailedEvent
VimAccountPasswordChangedEvent
VmAcquiredMksTicketEvent
VmAutoRenameEvent
VmBeingClonedEvent
VmBeingCreatedEvent
VmBeingDeployedEvent
VmBeingHotMigratedEvent
VmBeingMigratedEvent
VmBeingRelocatedEvent
VmClonedEvent
VmCloneFailedEvent
VmConfigMissingEvent
VmConnectedEvent
VmCreatedEvent
VmDasBeingResetEvent
VmDasBeingResetWithScreenshotEvent
VmDasResetFailedEvent
VmDasUpdateErrorEvent
VmDasUpdateOkEvent
VmDateRolledBackEvent
VmDeployedEvent
VmDeployFailedEvent
VmDisconnectedEvent
VmDiscoveredEvent
VmDiskFailedEvent
VmEmigratingEvent
VmEndRecordingEvent
VmEndReplayingEvent
VmEvent
VmFailedMigrateEvent
VmFailedRelayoutEvent
VmFailedRelayoutOnVmfs2DatastoreEvent
VmFailedStartingSecondaryEvent
VmFailedToPowerOffEvent
VmFailedToPowerOnEvent
VmFailedToRebootGuestEvent
VmFailedToResetEvent
VmFailedToShutdownGuestEvent
VmFailedToStandbyGuestEvent
VmFailedToSuspendEvent
VmFailedUpdatingSecondaryConfig
VmFailoverFailed
VmFaultToleranceStateChangedEvent
VmFaultToleranceTurnedOffEvent
VmFaultToleranceVmTerminatedEvent
VMFSDatastoreCreatedEvent
VMFSDatastoreExpandedEvent
VMFSDatastoreExtendedEvent
VmGuestRebootEvent
VmGuestShutdownEvent
VmGuestStandbyEvent
VmHealthMonitoringStateChangedEvent
VmInstanceUuidAssignedEvent
VmInstanceUuidChangedEvent
VmInstanceUuidConflictEvent
VmMacAssignedEvent
VmMacChangedEvent
VmMacConflictEvent
VmMaxFTRestartCountReached
VmMaxRestartCountReached
VmMessageErrorEvent
VmMessageEvent
VmMessageWarningEvent
VmMigratedEvent
VmNoCompatibleHostForSecondaryEvent
VmNoNetworkAccessEvent
VmOrphanedEvent
VMotionLicenseExpiredEvent
VmPoweredOffEvent
VmPoweredOnEvent
VmPoweringOnWithCustomizedDVPortEvent
VmPowerOffOnIsolationEvent
VmPrimaryFailoverEvent
VmReconfiguredEvent
VmRegisteredEvent
VmRelayoutSuccessfulEvent
VmRelayoutUpToDateEvent
VmRelocatedEvent
VmRelocateFailedEvent
VmRemoteConsoleConnectedEvent
VmRemoteConsoleDisconnectedEvent
VmRemovedEvent
VmRenamedEvent
VmResettingEvent
VmResourcePoolMovedEvent
VmResourceReallocatedEvent
VmRestartedOnAlternateHostEvent
VmResumingEvent
VmSecondaryAddedEvent
VmSecondaryDisabledBySystemEvent
VmSecondaryDisabledEvent
VmSecondaryEnabledEvent
VmSecondaryStartedEvent
VmShutdownOnIsolationEvent
VmStartingEvent
VmStartingSecondaryEvent
VmStartRecordingEvent
VmStartReplayingEvent
VmStaticMacConflictEvent
VmStoppingEvent
VmSuspendedEvent
VmSuspendingEvent
VmTimedoutStartingSecondaryEvent
VmUnsupportedStartingEvent
VmUpgradeCompleteEvent
VmUpgradeFailedEvent
VmUpgradingEvent
VmUuidAssignedEvent
VmUuidChangedEvent
VmUuidConflictEvent
VmWwnAssignedEvent
VmWwnChangedEvent
VmWwnConflictEvent
vprob.net.connectivity.lost
vprob.net.e1000.tso6.notsupported
vprob.net.migrate.bindtovmk
vprob.net.proxyswitch.port.unavailable
vprob.net.redundancy.degraded
vprob.net.redundancy.lost
vprob.storage.connectivity.lost
vprob.storage.redundancy.degraded
vprob.storage.redundancy.lost
vprob.vmfs.heartbeat.recovered
vprob.vmfs.heartbeat.timedout
vprob.vmfs.heartbeat.unrecoverable
vprob.vmfs.journal.createfailed
vprob.vmfs.lock.corruptondisk
AccountCreatedEvent
AccountRemovedEvent
AccountUpdatedEvent
AdminPasswordNotChangedEvent
AlarmActionTriggeredEvent
AlarmCreatedEvent
AlarmEmailCompletedEvent
AlarmEmailFailedEvent
AlarmReconfiguredEvent
AlarmRemovedEvent
AlarmScriptCompleteEvent
AlarmScriptFailedEvent
AlarmSnmpCompletedEvent
AlarmSnmpFailedEvent
AlarmStatusChangedevent
AllVirtualMachinesLicensedevent
AlreadyAuthenticatedSessionEvent
BadUsernameSessionEvent
CanceledHostOperationEvent
ClusterComplianceCheckedEvent
ClusterCreatedEvent
ClusterDestroyedEvent
ClusterOvercommittedEvent
ClusterReconfiguredEvent
ClusterStatusChangedEvent
com.vmware.license.AddLicenseEvent
com.vmware.license.AssignLicenseEvent
com.vmware.license.LicenseAssignFailedEvent
com.vmware.license.LicenseExpiryEvent
com.vmware.license.RemoveLicenseEvent
com.vmware.license.UnassignLicenseEvent
com.vmware.vc.cim.CIMGroupHealthStateChanged
CustomFieldDefAddedEvent
CustomFieldDefEvent
CustomFieldDefRemovedEvent
CustomFieldDefRenamedEvent
CustomFieldValueChangedEvent
CustomizationFailed
CustomizationLinuxIdentityFailedEvent
CustomizationNetworkSetupFailedEvent
CustomizationStartedEvent
CustomizationSucceeded
CustomizationSysprepFailedEvent
DasAdmissionControlDisabledEvent
DasAdmissionControlEnabledEvent
DasAgentFoundEvent
DasAgentUnavailableEvent
DasClusterIsolatedEvent
DasDisabledEvent
DasEnabledEvent
DasHostFailedEvent
DasHostIsolatedEvent
DatacenterCreatedEvent
DatacenterRenamedEvent
DatastoreCapacityIncreasedEvent
DatastoreDestroyedEvent
DatastoreDiscoveredEvent
DatastoreDuplicatedEvent
DatastoreFileCopiedEvent
DatastoreFileDeletedEvent
DatastoreFileMovedEvent
DatastorePrincipalConfigured
DatastoreRemovedOnHostEvent
DatastoreRenamedEvent
DatastoreRenamedOnHostEvent
DrsDisabledEvent
DrsEnabledEvent
DrsEnteredStandbyModeEvent
DrsEnteringStandbyModeEvent
DrsExitedStandbyModeEvent
DrsExitingStandbyModeEvent
DrsExitStandbyModeFailedEvent
DrsInvocationFailedEvent
DrsRecoveredFromFailureEvent
DrsResourceConfigureFailedEvent
DrsResourceConfigureSyncedEvent
DrsVmMigratedEvent
DrsVmPoweredOnEvent
DuplicateIpDetectedEvent
DVPortgroupCreatedEvent
DVPortgroupDestroyedEvent
DVPortgroupReconfiguredEvent
DVPortgroupRenamedEvent
DvsCreatedEvent
DvsDestroyedEvent
DvsEvent
DvsHostBackInSyncEvent
DvsHostJoinedEvent
DvsHostLeftEvent
DvsHostWentOutOfSyncEvent
DvsMergedEvent
DvsPortBlockedEvent
DvsPortConnectedEvent
DvsPortCreatedEvent
DvsPortDeletedEvent
DvsPortDisconnectedEvent
DvsPortJoinPortgroupEvent
DvsPortLeavePortgroupEvent
DvsPortLinkDownEvent
DvsPortLinkUpEvent
DvsPortReconfiguredEvent
DvsPortUnblockedEvent
DvsReconfiguredEvent
DvsRenamedEvent
DvsUpgradeAvailableEvent
DvsUpgradedEvent
DvsUpgradeInProgressEvent
DvsUpgradeRejectedEvent
EnteredMaintenanceModeEvent
EnteredStandbyModeEvent
EnteringMaintenanceModeEvent
EnteringStandbyModeEvent
ErrorUpgradeEvent
ExitedStandbyModeEvent
ExitingStandbyModeEvent
ExitMaintenanceModeEvent
ExitStandbyModeFailedEvent
FailoverLevelRestored
GeneralEvent
GeneralHostErrorEvent
GeneralHostInfoEvent
GeneralHostWarningEvent
GeneralUserEvent
GeneralVmErrorEvent
GeneralVmInfoEvent
GeneralVmWarningEvent
GhostDvsProxySwitchDetectedEvent
GhostDvsProxySwitchRemovedEvent
GlobalMessageChangedEvent
HealthStatusChangedEvent
HostAddedEvent
HostAddFailedEvent
HostAdminDisableEvent
HostAdminEnableEvent
HostCnxFailedAccountFailedEvent
HostCnxFailedAlreadyManagedEvent
HostCnxFailedBadCcagentEvent
HostCnxFailedBadUsernameEvent
HostCnxFailedBadVersionEvent
HostCnxFailedCcagentUpgradeEvent
HostCnxFailedEvent
HostCnxFailedNetworkErrorEvent
HostCnxFailedNoAccessEvent
HostCnxFailedNoConnectionEvent
HostCnxFailedNoLicenseEvent
HostCnxFailedNotFoundEvent
HostCnxFailedTimeoutEvent
HostComplianceCheckedEvent
HostCompliantEvent
HostConfigAppliedEvent
HostConnectedEvent
HostConnectionLostEvent
HostDasDisabledEvent
HostDasDisablingEvent
HostDasEnabledEvent
HostDasEnablingEvent
HostDasErrorEvent
HostDasOkEvent
HostDisconnectedEvent
HostEnableAdminFailedEvent
HostExtraNetworksEvent
HostGetShortNameFailedEvent
HostInventoryFullEvent
HostInventoryUnreadableEventEventindicating that the virtual machine inventory file on the host is damaged or unreadable.
HostIpChangedEvent
HostIpInconsistentEvent
HostIpToShortNameFailedEvent
HostIsolationIpPingFailedEvent
HostLicenseExpiredEvent
HostMissingNetworksEvent
HostMonitoringStateChangedEvent
HostNoAvailableNetworksEvent
HostNoHAEnabledPortGroupsEvent
HostNonCompliantEvent
HostNoRedundantManagementNetworkEvent
HostNotInClusterEvent
HostOvercommittedEvent
HostPrimaryAgentNotShortNameEvent
HostProfileAppliedEvent
HostReconnectionFailedEvent
HostRemovedEvent
HostShortNameInconsistentEvent
HostShortNameToIpFailedEvent
HostShutdownEvent
HostStatusChangedEvent
HostSyncFailedEvent
HostUpgradeFailedEvent
HostUserWorldSwapNotEnabledEvent
HostVnicConnectedToCustomizedDVPortEvent
HostWwnChangedEvent
HostWwnConflictEvent
IncorrectHostInformationEvent
InfoUpgradeEvent
InsufficientFailoverResourcesEvent
InvalidEditionEvent
LicenseExpiredEvent
LicenseNonComplianceEvent
LicenseRestrictedEvent
LicenseServerAvailableEvent
LicenseServerUnavailableEvent
LocalDatastoreCreatedEvent
LockerMisconfiguredEvent
LockerReconfiguredEvent
MigrationErrorEvent
MigrationHostErrorEvent
MigrationHostWarningEvent
MigrationResourceErrorEvent
MigrationResourceWarningEvent
MigrationWarningEvent
NASDatastoreCreatedEvent
NoAccessUserEvent
NoDatastoresConfiguredEvent
NoLicenseEvent
NoMaintenanceModeDrsRecommendationForVM
NotEnoughResourcesToStartVmEvent
OutOfSyncDvsHost
PermissionAddedEvent
PermissionRemovedEvent
PermissionUpdatedEvent
ProfileAssociatedEvent
ProfileChangedEvent
ProfileCreatedEvent
ProfileDissociatedEvent
ProfileEvent
ProfileReferenceHostChangedEvent
ProfileRemovedEvent
ResourcePoolCreatedEvent
ResourcePoolDestroyedEvent
ResourcePoolMovedEvent
ResourcePoolReconfiguredEvent
ResourceViolatedEvent
RoleAddedEvent
RoleRemovedEvent
RoleUpdatedEvent
ScheduledTaskCompletedEvent
ScheduledTaskCreatedEvent
ScheduledTaskEmailCompletedEvent
ScheduledTaskEmailFailedEvent
ScheduledTaskEvent
ScheduledTaskFailedEvent
ScheduledTaskReconfiguredEvent
ScheduledTaskRemovedEvent
ScheduledTaskStartedEvent
ServerLicenseExpiredEvent
ServerStartedSessionEvent
SessionTerminatedEvent
TaskEvent
TaskTimeoutEvent
TemplateBeingUpgradedEvent
TemplateUpgradedEvent
TemplateUpgradeFailedEvent
TimedOutHostOperationEvent
UnlicensedVirtualMachinesEvent
UnlicensedVirtualMachinesFoundEvent
UpdatedAgentBeingRestartedEvent
UpgradeEvent
UserAssignedToGroup
UserLoginSessionEvent
UserLogoutSessionEvent
UserPasswordChanged
UserUnassignedFromGroup
UserUpgradeEvent
VcAgentUninstalledEvent
VcAgentUninstallFailedEvent
VcAgentUpgradedEvent
VcAgentUpgradeFailedEvent
VimAccountPasswordChangedEvent
VmBeingClonedEvent
VmBeingCreatedEvent
VmBeingDeployedEvent
VmBeingHotMigratedEvent
VmBeingMigratedEvent
VmBeingRelocatedEvent
VmClonedEvent
VmCloneFailedEvent
VmConfigMissingEvent
VmConnectedEvent
VmCreatedEvent
VmDasBeingResetEvent
VmDasBeingResetWithScreenshotEvent
VmDasResetFailedEvent
VmDasUpdateErrorEvent
VmDasUpdateOkEvent
VmDateRolledBackEvent
VmDeployedEvent
VmDeployFailedEvent
VmDisconnectedEvent
VmDiscoveredEvent
VmEndRecordingEvent
VmEndReplayingEvent
VmEvent
VmFailedMigrateEvent
VmFailedRelayoutEvent
VmFailedRelayoutOnVmfs2DatastoreEvent
VmFailedStartingSecondaryEvent
VmFailedToPowerOffEvent
VmFailedToPowerOnEvent
VmFailedToRebootGuestEvent
VmFailedToResetEvent
VmGuestShutdownEvent
VmGuestStandbyEvent
VmHealthMonitoringStateChangedEvent
VmInstanceUuidAssignedEvent
VmInstanceUuidChangedEvent
VmInstanceUuidConflictEvent
VmMacAssignedEvent
VmMacChangedEvent
VmMacConflictEvent
VmMaxFTRestartCountReached
VmMaxRestartCountReached
VmMessageErrorEvent
VmMessageEvent
VmMessageWarningEvent
VmMigratedEvent
VmNoCompatibleHostForSecondaryEvent
VmOrphanedEvent
VMotionLicenseExpiredEvent
VmPoweredOffEvent
VmPoweredOnEvent
VmPoweringOnWithCustomizedDVPortEvent
VmPowerOffOnIsolationEvent
VmPrimaryFailoverEvent
VmReconfiguredEvent
VmRegisteredEvent
VmRelayoutSuccessfulEvent
VmRelayoutUpToDateEvent
VmRelocatedEvent
VmRelocateFailedEvent
VmRemoteConsoleConnectedEvent
VmRemoteConsoleDisconnectedEvent
VmRemovedEvent
VmRenamedEvent
VmResettingEvent
VmResourcePoolMovedEvent
VmResourceReallocatedEvent
VmRestartedOnAlternateHostEvent
VmResumingEvent
VmSecondaryAddedEvent
VmSecondaryDisabledBySystemEvent
VmSecondaryDisabledEvent
VmSecondaryEnabledEvent
VmSecondaryStartedEvent
VmShutdownOnIsolationEvent
VmStartingEvent
VmStartingSecondaryEvent
VmStartRecordingEvent
VmStartReplayingEvent
VmStaticMacConflictEvent
VmStoppingEvent
VmSuspendedEvent
VmSuspendingEvent
VmTimedoutStartingSecondaryEvent
VmUnsupportedStartingEvent
VmUpgradeCompleteEvent
VmUpgradeFailedEvent
VmUpgradingEvent
VmUuidAssignedEvent
VmUuidChangedEvent
VmUuidConflictEvent
VmWwnAssignedEvent
VmWwnChangedEvent
VmWwnConflictEvent
vprob.net.connectivity.lost
vprob.net.e1000.tso6.notsupported
vprob.net.migrate.bindtovmk
vprob.net.proxyswitch.port.unavailable
vprob.net.redundancy.degraded
vprob.net.redundancy.lost
vprob.storage.connectivity.lost
vprob.storage.redundancy.degraded
vprob.storage.redundancy.lost
vprob.vmfs.heartbeat.recovered
vprob.vmfs.heartbeat.timedout
vprob.vmfs.heartbeat.unrecoverable
vprob.vmfs.journal.createfailed
vprob.vmfs.lock.corruptondisk
vprob.vmfs.nfs.server.disconnect
vprob.vmfs.nfs.server.restored
vprob.vmfs.resource.corruptondisk
vprob.vmfs.volume.locked
WarningUpgradeEvent
vprob.vmfs.nfs.server.restored
vprob.vmfs.resource.corruptondisk
vprob.vmfs.volume.locked
WarningUpgradeEvent
WebLogic Server
Introduction
Configuration Overview
Configure WebLogic Server Monitoring
Specify Agent JRE
Run Agent with Required Permissions
Configure WLS Location
Configure SSL
One-Way SSL
Two-Way SSL
Restart Agent
Verify Auto-Discovery of Administration Server
Configure Monitoring
Required Administration Server Configuration
Configure Log Event Tracking and Service Monitoring
Verify Managed Server Auto-Discovery
Complete Monitoring Configuration
Troubleshoot WebLogic Server Auto-Discovery Problems
Solve Administration Server Auto-Discovery Problems
Test Auto-Discovery
Check Network Access
Verify Permissions
If Plugin Lacks Necessary Permissions
If Plugin Has Necessary Permissions
Add Administration Server Manually
Solve Managed Server Auto-Discovery Problems
How the Plugin Discovers Managed ServersÂ
Check if the Agent Can Access config.xml
Resolve Managed Server IP Address/FQDN Mismatch
Configuration Files Tracked by Default
Metrics
Weblogic 6.1 Application service
Weblogic 6.1 Entity EJB service
Weblogic 6.1 Execute Queue service
Weblogic 6.1 JDBC Connection Pool service
Weblogic 6.1 JMS Destination service
Weblogic 6.1 JMS Server service
Weblogic 6.1 JTA Resource service
Weblogic 6.1 Message Driven EJB service
Weblogic 6.1 server
Weblogic 6.1 Stateful EJB service
Weblogic 6.1 Stateless EJB service
Weblogic 6.1 Webapp service
Weblogic 7.0 Application service
Weblogic 7.0 Entity EJB service
Weblogic 7.0 Execute Queue service
Weblogic 7.0 JDBC Connection Pool service
Weblogic 7.0 JMS Destination service
Weblogic 7.0 JMS Server service
Weblogic 7.0 JTA Resource service
Weblogic 7.0 Message Driven EJB service
Weblogic 7.0 server
Weblogic 7.0 Stateful EJB service
Weblogic 7.0 Stateless EJB service
Weblogic 7.0 Webapp service
Weblogic 8.1 Application service
Weblogic 8.1 Entity EJB service
Weblogic 8.1 Execute Queue service
Weblogic 8.1 JDBC Connection Pool service
Weblogic 8.1 JMS Destination service
Weblogic 8.1 JMS Server service
Weblogic 8.1 JTA Resource service
Weblogic 8.1 Message Driven EJB service
Weblogic 8.1 server
Weblogic 8.1 Stateful EJB service
Weblogic 8.1 Stateless EJB service
Weblogic 8.1 Webapp service
Weblogic 9.1 Application service
Weblogic 9.1 Entity EJB service
Weblogic 9.1 Execute Queue service
Weblogic 9.1 JDBC Connection Pool service
Weblogic 9.1 JMS Destination service
Weblogic 9.1 JMS Server service
Weblogic 9.1 JTA Resource service
Weblogic 9.1 Message Driven EJB service
Weblogic 9.1 server
Weblogic 9.1 Stateful EJB service
Weblogic 9.1 Stateless EJB service
Weblogic 9.1 Webapp service
Weblogic 9.2 Application service
Weblogic 9.2 Entity EJB service
Weblogic 9.2 Execute Queue service
Weblogic 9.2 JDBC Connection Pool service
Weblogic 9.2 JMS Destination service
Weblogic 9.2 JMS Server service
Weblogic 9.2 JTA Resource service
Weblogic 9.2 Message Driven EJB service
Weblogic 9.2 server
Weblogic 9.2 Stateful EJB service
Weblogic 9.2 Stateless EJB service
Weblogic 9.2 Webapp service
Weblogic 10.0 Application service
Weblogic 10.0 Entity EJB service
Weblogic 10.0 Execute Queue service
Weblogic 10.0 JDBC Connection Pool service
Weblogic 10.0 JMS Destination service
Weblogic 10.0 JMS Server service
Weblogic 10.0 JTA Resource service
Weblogic 10.0 Message Driven EJB service
Weblogic 10.0 server
Weblogic 10.0 Stateful EJB service
Weblogic 10.0 Stateless EJB service
Weblogic 10.0 Webapp service
Weblogic 10.1 Application service
Weblogic 10.1 Entity EJB service
Weblogic 10.1 Execute Queue service
Weblogic 10.1 JDBC Connection Pool service
Weblogic 10.1 JMS Destination service
Weblogic 10.1 JMS Server service
Weblogic 10.1 JTA Resource service
Weblogic 10.1 Message Driven EJB service
Weblogic 10.1 server
Weblogic 10.1 Stateful EJB service
Weblogic 10.1 Stateless EJB service
Weblogic 10.1 Webapp service
Weblogic 10.2 Application service
Weblogic 10.2 Entity EJB service
Weblogic 10.2 Execute Queue service
Weblogic 10.2 JDBC Connection Pool service
Weblogic 10.2 JMS Destination service
Weblogic 10.2 JMS Server service
Weblogic 10.2 JTA Resource service
Weblogic 10.2 Message Driven EJB service
Weblogic 10.2 server
Weblogic 10.2 Stateful EJB service
Weblogic 10.2 Stateless EJB service
Weblogic 10.2 Webapp service
Weblogic 10.3 Application service
Weblogic 10.3 Entity EJB service
Weblogic 10.3 Stateless EJB service
Weblogic 10.3 Execute Queue service
Weblogic 10.3 JDBC Connection Pool service
Weblogic 10.3 JMS Destination service
Weblogic 10.3 JMS Server service
Weblogic 10.3 JTA Resource service
Weblogic 10.3 Message Driven EJB service
Weblogic 10.3 server
Weblogic 10.3 Stateful EJB service
Weblogic 10.3 Webapp service
Weblogic Admin 6.1 Application service
Weblogic Admin 6.1 Entity EJB service
Weblogic Admin 6.1 Execute Queue service
Weblogic Admin 6.1 JDBC Connection Pool service
Weblogic Admin 6.1 JMS Destination service
Weblogic Admin 6.1 JMS Server service
Weblogic Admin 6.1 JTA Resource service
Weblogic Admin 6.1 Message Driven EJB service
Weblogic Admin 6.1 server
Weblogic Admin 6.1 Stateful EJB service
Weblogic Admin 6.1 Stateless EJB service
Weblogic Admin 6.1 Webapp service
Weblogic Admin 7.0 Application service
Weblogic Admin 7.0 Entity EJB service
Weblogic Admin 7.0 Execute Queue service
Weblogic Admin 7.0 JDBC Connection Pool service
Weblogic Admin 7.0 JMS Destination service
Weblogic Admin 7.0 JMS Server service
Weblogic Admin 7.0 JTA Resource service
Weblogic Admin 7.0 Message Driven EJB service
Weblogic Admin 7.0 server
Weblogic Admin 7.0 Stateful EJB service
Weblogic Admin 7.0 Stateless EJB service
Weblogic Admin 7.0 Webapp service
Weblogic Admin 8.1 Application service
Weblogic Admin 8.1 Entity EJB service
Weblogic Admin 8.1 Execute Queue service
Weblogic Admin 8.1 JDBC Connection Pool service
Weblogic Admin 8.1 JMS Destination service
Weblogic Admin 8.1 JMS Server service
Weblogic Admin 8.1 JTA Resource service
Weblogic Admin 8.1 Message Driven EJB service
Weblogic Admin 8.1 server
Weblogic Admin 8.1 Stateful EJB service
Weblogic Admin 8.1 Stateless EJB service
Weblogic Admin 8.1 Webapp service
Weblogic Admin 9.1 Application service
Weblogic Admin 9.1 Entity EJB service
Weblogic Admin 9.1 Execute Queue service
Weblogic Admin 9.1 JDBC Connection Pool service
Weblogic Admin 9.1 JMS Destination service
Weblogic Admin 9.1 JMS Server service
Weblogic Admin 9.1 JTA Resource service
Weblogic Admin 9.1 Message Driven EJB service
Weblogic Admin 9.1 server
Weblogic Admin 9.1 Stateful EJB service
Weblogic Admin 9.1 Stateless EJB service
Weblogic Admin 9.1 Webapp service
Weblogic Admin 9.2 Application service
Weblogic Admin 9.2 Entity EJB service
Weblogic Admin 9.2 Execute Queue service
Weblogic Admin 9.2 JDBC Connection Pool service
Weblogic Admin 9.2 JMS Destination service
Weblogic Admin 9.2 JMS Server service
Weblogic Admin 9.2 JTA Resource service
Weblogic Admin 9.2 Message Driven EJB service
Weblogic Admin 9.2 server
Weblogic Admin 9.2 Stateful EJB service
Weblogic Admin 9.2 Stateless EJB service
Weblogic Admin 9.2 Webapp service
Weblogic Admin 10.0 Application service
Weblogic Admin 10.0 Entity EJB service
Weblogic Admin 10.0 Execute Queue service
Weblogic Admin 10.0 JDBC Connection Pool service
Weblogic Admin 10.0 JMS Destination service
Weblogic Admin 10.0 JMS Server service
Weblogic Admin 10.0 JTA Resource service
Weblogic Admin 10.0 Message Driven EJB service
Weblogic Admin 10.0 server
Weblogic Admin 10.0 Stateful EJB service
Weblogic Admin 10.0 Stateless EJB service
Weblogic Admin 10.0 Webapp service
Weblogic Admin 10.1 Application service
Weblogic Admin 10.1 Entity EJB service
Weblogic Admin 10.1 Execute Queue service
Weblogic Admin 10.1 JDBC Connection Pool service
Weblogic Admin 10.1 JMS Destination service
Weblogic Admin 10.1 JMS Server service
Weblogic Admin 10.1 JTA Resource service
Weblogic Admin 10.1 Message Driven EJB service
Weblogic Admin 10.1 server
Weblogic Admin 10.1 Stateful EJB service
Weblogic Admin 10.1 Stateless EJB service
Weblogic Admin 10.1 Webapp service
Weblogic Admin 10.2 Application service
Weblogic Admin 10.2 Entity EJB service
Weblogic Admin 10.2 Execute Queue service
Weblogic Admin 10.2 JDBC Connection Pool service
Weblogic Admin 10.2 JMS Destination service
Weblogic Admin 10.2 JMS Server service
Weblogic Admin 10.2 JTA Resource service
Weblogic Admin 10.2 Message Driven EJB service
Weblogic Admin 10.2 server
Weblogic Admin 10.2 Stateful EJB service
Weblogic Admin 10.2 Stateless EJB service
Weblogic Admin 10.2 Webapp service
Weblogic Admin 10.3 Application service
Weblogic Admin 10.3 Entity EJB service
Weblogic Admin 10.3 Execute Queue service
Weblogic Admin 10.3 JDBC Connection Pool service
Weblogic Admin 10.3 JMS Destination service
Weblogic Admin 10.3 JMS Server service
Weblogic Admin 10.3 JTA Resource service
Weblogic Admin 10.3 Message Driven EJB service
Weblogic Admin 10.3 server
Weblogic Admin 10.3 Stateful EJB service
Weblogic Admin 10.3 Stateless EJB service
Weblogic Admin 10.3 Webapp service
Weblogic NodeManager 6.1 server
Weblogic NodeManager 7.0 server
Weblogic NodeManager 8.1 server
Weblogic NodeManager 9.1 server
Weblogic NodeManager 9.2 server
Weblogic NodeManager 10.0 server
Weblogic NodeManager 10.1 server
Weblogic NodeManager 10.2 server
Weblogic NodeManager 10.3 server
WebSphere MQ
Configuration Requirements
Metrics
WebSphere MQ QManager 6 server
WebSphere MQ QManager 6 Process service
WebSphere MQ QManager 6 Local Queue service
WebSphere MQ QManager 6 Remote Queue service
WebSphere MQ QManager 6 Receiver Channel service
WebSphere MQ QManager 6 Sender Channel service
WebSphere MQ QManager 6 System Queue service
WebSphere MQ QManager 6 Channel service
WebSphere MQ QManager 6 Cluster service
WebSphere MQ QManager 6 Alias Queue service
WebSphere MQ QManager 7 server
WebSphere MQ QManager 7 Sender Channel service
WebSphere MQ QManager 7 Cluster service
WebSphere MQ QManager 7 Process service
WebSphere MQ QManager 7 Receiver Channel service
WebSphere MQ QManager 7 Local Queue service
WebSphere MQ QManager 7 Remote Queue service
WebSphere MQ QManager 7 System Queue service
WebSphere MQ QManager 7 Topic service
WebSphere MQ QManager 7 Channel service
WebSphere MQ QManager 7 Alias Queue service
vFabric Hyperic Monitoring and Management
About vFabric Hyperic Monitoring and Management
Intended Audience
Use and Tailor the Hyperic Dashboard
Introduction to the Hyperic Dashboard
Hyperic Dashboard
Portlet Quick Facts and Links
Tailor Dashboard
Using Multiple Dashboards in vFabric Hyperic
Auto-Discovery Portlet
Contents of the Auto-Discovery Portlet
Import or Skip Resources in Auto-Discovery Portlet
Configure the Number of Auto-Discoveries Displayed
Availability Summary Portlet
About the Availability Summary Portlet
Configure the Availability Summary Portlet
Control Actions Portlet
About the Control Actions Portlet
Configure the Control Actions Portlet
Favorite Resources Portlet
About the Favorite Resources Portlet
Select a Favorite Resource On the Fly
Configure Favorite Resources on the Dashboard
Group Alert Summary Portlet
About the Group Alerts Portlet
Configure the Group Alerts Portlet
Metric Viewer Portlet
About the Metric Viewer Portlet
Configure the Metric Viewer Portlet
Problem Resources Portlet
About the Problem Resources Portlet
Configure the Problem Resources Portlet
Recent Alerts Portlet
About the Recent Alerts Portlet
Configure the Recent Alerts Portlet
Saved Charts Portlet
About the Saved Charts Portlet
Add Chart to Saved Charts Portlet
Remove Chart from Saved Charts Portlet
Summary Counts Portlet
About the Summary Counts Portlet
Configure the Summary Counts Portlet
Monitor Resources in the Resource Tab
Browsing to Resources
List Resources by Inventory Type
List Resources by Resource Type
Filter Platforms, Servers, and Services by Group
Filter Resources by Name, Owner, and Availability
Indicators Minitab
Overview of Indicators Minitab
Availability Bar and Timeslices
Metric Charts in the Indicators Minitab
Event Icons and Popups
Resources Minitab
Metric Data Minitab
Metric Data Minitab
Metric Data Minitab for a Single Resource
Metric Data Minitab for an Autogroup or Compatible Group
Compare Metrics for Resources in a Compatible Group
View Metric Details and Metadata
Set Page Refresh Frequency
Tailor Metric Collection Settings for the Resource
Disable Collection of a Metric
Enable Collection of a Metric
Set Collection Interval for a Metric
Configure Metric Baselines
Resources Minitab
Resources Minitab
Resources Minitab
Resource Lists in the Resources Minitab
Availability Icons in the Resources Minitab
Availability Details in the Resources Minitab
Metric Summaries in the Resources Minitab
View Metric Data for Related Resources in the Resources Minitab
Use Controls and Popup Options in the Resources Minitab
Filter Metrics by Category and Value Type
Metric Display Range
Default Metric Display Range
Select a Number of Minutes, Hours, or Days
Advanced Settings for Metric Display Range
Charting Metric Data
Charting Metric Data
Chart Types - What They Are and How to View Them
How a Chart is Constructed
Read a Full Page Chart
Contents of a Full Page Chart
Observed Measurements
Peak, Average, and Low Values
Baseline and Acceptable High and Low Values
Participating Resources
Metric Baseline and Expected Range
Filter Chart Data
Change Metric Display Range
Save Chart to Dashboard
Save the Chart in CSV Foromat
Tools Menu
Map Control
Overview of the Map Control
Resource Map for a Platform
Resource Map for a Server
Resource Map for a Service
Resource Map for a Compatible Group
Metric Extrapolation View for Groups
Extrapolating Metrics for a Group
Understanding Extrapolation Charts
Global Management Views
Alert Center
View Alerts In the Alert Center
Filter Alert List
Fix or Acknowledge an Alert in the Alert Center
View Alert Definitions In the Alert Center
Filter Alert Definition List
Event Center
Event Center
Filter the Event List
Contents of the Event Center Page
Currently Down
Currently Down Resources
Contents of the Currently Down Page
Filter Resources of the Currently Down Page
Operations Center
Filter by Problem Type and Resource
Set Table Controls
Contents of Operations Center Page
Current Filter Totals
Resource Details for All Hosts
Nagios Availability
View Nagios Resources and Metrics in Hyperic
View Nagios Service Detail
View a Nagios Check
Report Center
Report Center Overview
Navigate to the Report Center
Built-In Reports
Custom Reports
Specifying Report Description and Report Parameters
Actionable Reports
Views for Specific Resource Types
GemFire View
GemFire View for a DS
GemFire View for a Cache Server or Application Peer
GemFire View for a Gateway Hub
HQ vSphere View
About the HQ vSphere Page
Display the HQ vSphere Page
HQ vSphere and Resource Permissions
HQ vSphere Inventory Tab
HQ vSphere Summary Tab
Summary Tab for vCenter
Summary Tab for vSphere Hosts
Summary Tab for vSphere VM
Summary Tab for a Managed Resource in the VM
HQ vSphere Performance Tab
View Metrics
Correlate Metrics
HQ vSphere Control Tab
Metrics
VMware vSphere Host Metrics
VMware vSphere VM Metrics
tc Server Application Management View
tc Runtime Application Management
Navigating to a tc Runtime Instance Or Group
Creating tc Runtime Groups
Listing Applications
Deploying Applications
Undeploying Applications
Starting Applications
Stopping Applications
Reloading Applications
Agent Control View
Restart an Agent or a Group of Agents
Ping an Agent or a Group of Agents
Upgrade an Agent or Group of Agents to a Newer Version
Push a Plugin to an Agent or Group of Agents
Spring Insight View
Spring Insight Applications
Understanding Application Metrics
Application Health
Application Vitals
Unfixed Alert Count
Error Rate
Response Time Levels
Contents of the Spring Insight Applications Page
Dashboards Tab
Health Tab for all Applications
Performance Tab for a Dashboard
Application Server Performance
Platform Performance
Performance Tab for an Application
Data Service Performance
Jump to Insight Operations
Run Live System and Metric Queries
JMX MBean Query for JVMs
Using JMX MBean Query
Entering Query Options
Enabling Automatic Refresh
Defining Saved Mbean Searches
Schema for JMX Search Criteria
Run Live Exec Queries
Live Exec Commands
Run Live Exec on a Platform or Group of Platforms
Use Resource Control Actions
Run Resource Control Actions
Overview of Running Control Actions
Run a Built-in Control Action
Select and Run a Custom Control Action
Select from a List of All Custom Control Actions
Select from a List Custom Control Actions for a Platform
Run Custom Control Action
Schedule a Control Action
View Control Action Status and History
View Recently Performed Control Actions
About the Control Actions Portlet
Configure the Control Actions Portlet
View Control History for a Resource
View Alerts and Update Alert Status
List Recent Alerts
List Alerts for a Resource
View Alerts Across All Resources
Monitor Unfixed Alerts
View Alert Detail
Acknowledge or Fix an Alert
vFabric Hyperic Web Services API
About vFabric Hyperic Web Services API
Intended Audience
Introduction to HQApi
Overview of HQApi
Version Compatibility
What HQApi is Good For
User Permissions and HQApi
How to Access HQApi
How to Install HQApi
API Package Contents
HQApi Command-Line Tools
Command-Line Tools Overview
Invoking Command-Line Tools
Common Subcommands
list
sync
delete
Required Command Qualifiers and How to Supply Them
Define a Connection Properties File
Encrypt Hyperic Password
Supply Properties File Path on Command Line
Tips and Reminders for CLI Tools
Sync with Caution
How to Find a Resource ID
HQApi agent command
agent Functionality
agent Command Options
agent list
Structure of an AgentsResponse Element
Content of an Agent Element
agent list Command Qualifiers
agent list Example
agent ping
agent ping Command Qualifiers
agent ping examples
agent transferPlugin
agent transferPlugin Command Qualifiers
agent transferPlugin Examples
agent bundle-list
Structure of an AgentBundleFilesResponse Element
Content of an AgentBundleFile Element
agent bundle-list Command Qualifiers
agent bundle-list Example
agent bundle-status
agent bundle-status Command Qualifiers
agent bundle-status example
bundle-push
agent bundle-push Command Qualifiers
agent bundle-push example
HQApi alertdefinition command
alertdefinition Functionality
Understanding Alert Definition Options
alertdefinition Command Options
alertdefinition list
alertdefinition list Command Qualifiers
Structure of an AlertDefinitionsResponse
Attributes in an AlertDefinitionsResponse
AlertCondition Attributes for Different Condition Types
AlertActionConfig Attributes for Different Action Types
alertdefinition sync
alertdefinition sync Command Qualifiers
alertdefinition delete
alertdefinition create
alertdefinition create Command Qualifiers
alertdefinition Command Examples
alertdefinition list
alertdefinition list --typeAlerts
AlertCondition Examples
alertdefinition sync
alertdefinition delete
alertdefinition create - based on existing alert definition
alertdefinition create - new alert definition
HQApi alert command
Functionality
alert Command Options
alert list
Structure of an AlertsResponse Element
Attributes in an AlertsResponse
List Examples
List Last n Alerts
List Last n Alerts in Escalation
List Last n Unfixed Alerts
List Alerts that Fired During an Interval
List Unfixed Alerts with Severity Level
alert ack
alert fix
alert delete
HQApi application command
Functionality
application Command Options
application list
Structure of an ApplicationResponse
Attributes in an ApplicationResponse
Example - application list
application sync
Example - Create Applications with application sync
Example - Update Applications with application sync
application delete
HQApi autodiscovery command
Functionality
autodiscovery Command Options
autodiscovery list
autodiscovery list Command Qualifiers
Structure of a QueueResponse
Attributes in a QueueResponse
autodiscovery approve
autodiscovery approve Command Qualifiers
Examples
autodiscovery list
autodiscovery approve
autodiscovery approve with Regex Qualifier
HQApi control command
Functionality
control Command Options
control actions
control history
control execute
control Command Examples
control actions --resourceId
control history --resourceId
control execute --action --resourceId
control execute --action --resourceId – option
HQApi dependency command
dependency Functionality
dependency Command Options
dependency list
dependency list Command Qualifiers
Structure of ResourcesResponse
Atributes of ResourcesResponse
Structure of ResourceEdgesResponse element
dependency list Examples
dependency list
dependency list --prototype
Dependency List --name
dependency list --prototype --name
dependency list --children --id
dependency list --children --prototype
dependency list --children --name
dependency list --children --prototype --name
Dependency List --children --id --relation=containment
dependency sync
dependency sync Command Qualifiers
dependency delete
dependency delete Command Qualifiers
dependency select
dependency select Command Qualifiers
HQApi escalation command
Functionality
escalation Command Options
escalation list
escalation list Command Qualifiers
Structure of an EscalationsResponse
Attributes in an EscalationsResponse
escalation sync
Examples
escalation list
escalation sync
HQApi event command
Functionality
event Command Options
event list
Structure of an EventsResponse
Attributes in an EventResponse Element
event Command Examples
event list --resourceId
event list
Example Event Element for Different Event Types
Event Element for an Alert Event
Event Element for an Control Action Event
Event Element for an Log Event
Event Element for an Configuration Event
HQApi groovyshell command
groovshell Functionality
groovyshell Command Qualifiers
HQApi group command
Functionality
group Command Options
group list
group list Command Qualifiers
Structure of a GroupsResponse
Attributes in a GroupsResponse
group sync
group sync Command Qualifiers
group delete
group delete Command Qualifiers
Examples
group list
group delete
group sync via XML
group sync - Create or Update a Compatible Group from Command Line
group sync - Create or Update a Mixed Group from Command Line
HQApi maintenance command
Functionality
maintenance Command Options
maintenance schedule
maintenance unschedule
maintenance get
Examples
maintenance schedule
maintenance get
maintenance unschedule
Sample Script for Scheduling Recurring Maintenance
Using group_maintenance_api.pl
Set Environment Variables
Schedule Maintenance for a Group
Check Maintenance Schedule
Cancel a Maintenance Schedule
Set Up a Recurring Maintenance Schedule
Use Time Only for Start and End Arguments
Tip - Wrap the Script Invocation
HQApi metric command
Functionality
metric Command Options
metric list
Metric list Command Qualifiers
Structure of a MetricsResponse
Attributes in a MetricsResponse
metric sync
metric reschedule
Examples
metric list
metric sync
metric reschedule
HQApi metricData command
Functionality
Command Options
list
list Command Output
list Command Qualifiers
Examples
List Measurements for a Metric
List Measurements for a Resource
List Measurements for a Compatible Group
HQApi metricTemplate command
Functionality
metricTemplate Command Options
metricTemplate list
metricTemplate list Command Qualifiers
Structure of a metricTemplatesResponse
Attributes in a MetricTemplatesResponse
metricTemplate sync
Examples
metricTemplate list
metricTemplate sync
HQApi resource command
Functionality
resource Command Options
resource list
resource list Command Qualifiers
Structure of a ResourcesResponse
Attributes in an ResourcesResponse
resource sync
resource delete
resource createPlatform
resource createPlatform Command Qualifiers
resource createServer
resource createServer Command Qualifiers
resource createService
resource createService Command Qualifiers
resource move
resource move Command Qualifiers
Examples
List Resources of the Same Type
List Resources of the Same Type Verbosely
Write Resource Data to a File
Update Resource Properties
Delete a Resource
Create a New Platform
Create a New Server
Create a New Service
HQApi resourceprototype command
Functionality
resourceprototype Command Options
resourceprototype list
Attributes in an ResourcePrototype Element
resourceprototype Command Examples
resourceprototype list --existing
HQApi role command
Functionality
Command Options
list
list Command Output
list Command Qualifiers
sync
Samples
role list
role sync
Understanding Role Permissions
Operations List
HQApi serverConfig command
Functionality
serverConfig Command Options
serverConfig get
Structure of a ServerConfigResponse Element
Attributes in an ServerConfigResponse
Example - serverConfig get
Example - Write Results of serverConfig get to a file
serverConfig set
serverConfig getParameter
serverConfig setParameter
Server Configuration Reference
Hyperic Email Configuration Properties
Data Manager Configuration Properties
Global Alert Properties
Notification Throttling Configuration Properties
Automatic Baseline Configuration Properties
LDAP Configuration Properties
Kerberos Configuration Properties
SNMP Properties
Configure HQ Server for SNMP v1
Configure HQ Server for SNMP v2c
Configure HQ Server for SNMP v3
Server Configuration Reference
Hyperic Email Configuration Properties
Data Manager Configuration Properties
Global Alert Properties
Notification Throttling Configuration Properties
Automatic Baseline Configuration Properties
LDAP Configuration Properties
Kerberos Configuration Properties
SNMP Properties
Configure HQ Server for SNMP v1
Configure HQ Server for SNMP v2c
Configure HQ Server for SNMP v3
HQApi user command
Functionality
Command Options
list
list command output
list Command Qualifiers
sync
Examples
user list
user sync
HQApi Java API
vFabric Hyperic User Interface
About vFabric Hyperic User Interface
Intended Audience
ui-Dashboard
Hyperic Dashboard
Portlet Quick Facts and Links
Tailor Dashboard
Using Multiple Dashboards in vFabric Hyperic
ui-Login
Hyperic Dashboard
HQ Dashboard Settings: Add Resources
Tasks Available on This Screen
ui-Dashboard.Alerts
About the Recent Alerts Portlet
Configure the Recent Alerts Portlet
ui-Dashboard.Availability
About the Availability Summary Portlet
Configure the Availability Summary Portlet
ui-Dashboard.AutoDiscovery
Contents of the Auto-Discovery Portlet
Import or Skip Resources in Auto-Discovery Portlet
Configure the Number of Auto-Discoveries Displayed
ui-Dashboard.Charts
About the Saved Charts Portlet
Add Chart to Saved Charts Portlet
Remove Chart from Saved Charts Portlet
ui-Dashboard.Control
About the Control Actions Portlet
Configure the Control Actions Portlet
ui-Dashboard.FavoriteResources
About the Favorite Resources Portlet
Select a Favorite Resource On the Fly
Configure Favorite Resources on the Dashboard
Group Alerts Summary Portlet
About the Group Alerts Portlet
Configure the Group Alerts Portlet
ui-Dashboard.Metric
About the Metric Viewer Portlet
Configure the Metric Viewer Portlet
ui-Dashboard.ProblemResources
About the Problem Resources Portlet
Configure the Problem Resources Portlet
ui-Dashboard.RecentlyAdded
About the Recently Added Portlet
Configure the Recently Added Portlet
ui-Dashboard.Summary
About the Summary Counts Portlet
Configure the Summary Counts Portlet
ui-Resources
Resources Browse
About the Browse Page
Filter the Resource List
Navigation and View Options
Switch Between Chart and List View
Navigate to a Resource
About Breadcrumb Links
Create a Platform
Create an Application
Create a New Group
Select and Add Platforms, Servers, or Services to a New or Existing Group
Create a New Group of Groups
Delete a Resource
Enable or Disable Alert Definitions
ui-Monitor
ui-Monitor.CurrentHealth
Overview of Indicators Minitab
Availability Bar and Timeslices
Metric Charts in the Indicators Minitab
Event Icons and Popups
Resources Minitab
ui-Monitor.CurrentHealth.Chart
Metric Chart
For Single Resources
Sections on This Screen
Metric Chart
Participating Resource
Metric Baseline and Expected Range
Reading a Chart
Time Slices
Display of Dynamic Data vs. Static Data
Display of Cumulative Data
ui-Monitor.CurrentHealth.Metrics
Metric Data Minitab
Metric Data Minitab for a Single Resource
Metric Data Minitab for an Autogroup or Compatible Group
Compare Metrics for Resources in a Compatible Group
View Metric Details and Metadata
Set Page Refresh Frequency
Tailor Metric Collection Settings for the Resource
Disable Collection of a Metric
Enable Collection of a Metric
Set Collection Interval for a Metric
Configure Metric Baselines
Resources Minitab
ui-Monitor.Group.Compare
Compare Metrics for Resources in a Compatible Group
Select Metrics to Compare
Contents of the Compare Groups Page
ui-Monitor.Group.Extrapolate
Extrapolating Metrics for a Group
Understanding Extrapolation Charts
ui-Monitor.Server.MbeanBrowser
Using JMX MBean Query
Entering Query Options
Enabling Automatic Refresh
Defining Saved Mbean Searches
Schema for JMX Search Criteria
Edit Display Range
ui-Alert
ui-Alert.Script
Define a Script Action for an Alert
Environment Variables for Fired Alert Data
Example Script
Assign the Script Action to an Alert
ui-Alert.Edit
Edit Alert Properties
Edit Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Create or Edit Alert Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
ui-Alert.ControlAction
Configure a Control Action as an Alert Action
ui-Alert.ListTypeDefinition
List Alert Definitions for a Resource Type
Create a Resource Type Alert Definition
Enable or Disable a Resource Type Alert Definition
Edit a Resource Type Alert Definition
Delete Resource Type Alert Definition
ui-Alert.Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
ui-Alert.Condition
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Edit Alert Add Notification
Notify Roles *
Notify HQ Users
Notify Other Recipients
ui-Alert.Detail
Alert Detail Page
View Alert Detail
Mark Alert Fixed
Acknowledge Alert
Go to the Alert Definition Page
Go to the Resource's Indicators Page
ui-Alert.List
Alert List for a Resource
View Alerts and Status for a Different day
Mark One or More Alert Fixed
Acknowledge Alert with Escalation
View and Update Alert Definitions for the Resource
ui-Alert.New
Navigate to the New Alert Definition Page
Define Alert Properties
Define Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Save the Alert Definition
Define Alert Actions
ui-Alert.ListDefinition
Display a List of Alert Definitions
Create an Alert Definition for a Resource
Enable or Disable a Resource Alert Definition
Edit a Resource Alert Definition
Delete a Resource Alert Definition
ui-Alert.Properties
ui-Control
Managing Control Actions
Run a Control Action on Demand
Schedule a Control Action
Edit a Scheduled Control Action
Delete a Scheduled Control Action
Sections on This Screen
Current Status
Quick Control
Control Action Schedule
Editing a Scheduled Control Action
ui-Control.History
Scheduling Control Actions
ui-Views
Views Tab for a Resource
ui-SpringInsight
Spring Insight Applications
Understanding Application Metrics
Application Health
Application Vitals
Unfixed Alert Count
Error Rate
Response Time Levels
Contents of the Spring Insight Applications Page
Dashboards Tab
Health Tab for all Applications
Performance Tab for a Dashboard
Application Server Performance
Platform Performance
Performance Tab for an Application
Data Service Performance
Jump to Insight Operations
ui-tcserver.ServerConfiguration
tc Runtime Configuration
Navigating tc Runtime Configuration Pages
Saving or Undoing Changes
User Permissions Required to Use the tc Runtime Features
Configuring General tc Runtime Options
Configuring Startup Options
Configuring the Context Container
Configuring JSP Options
Configuring Static Content Defaults
Using the Advanced Server Configuration Options
Reloading Settings From Server
Reverting to a Previously Saved Configuration
Uploading a Configuration File
Configuring and Creating JDBC Data Sources
Configuring and Creating tc Runtime Services
Configuring and Creating Connectors
Configuring and Creating Virtual Hosts
Configuring tc Runtime Logging
ui-tcserver.ServerConfigurationRef
tc Runtime Configuration Reference
General Configuration
Server Properties
JMX Listener
Server Start Configuration
General
Sun Specific JVM Options
Advanced
Context Container
Static Resource Cache
Web Application Logger
Server Defaults - JSP
Server Defaults - Static Content
ui-tcserver.ApplicationManagement
tc Runtime Application Management
Navigating to a tc Runtime Instance Or Group
Creating tc Runtime Groups
Listing Applications
Deploying Applications
Undeploying Applications
Starting Applications
Stopping Applications
Reloading Applications
ui-tcserver.ServerServicesRef
tc Runtime Services Reference
General Service Properties
Connector Properties
General
Security/SSL
APR SSL Settings
Engine Properties
Thread Diagnostics
Host Properties
HTTP Access Logging
ui-tcserver.ServerJDBCRef
tc Runtime JDBC Reference
General Properties
Connection Properties
Tomcat/DBCP Connection Pool Properties
ui-vSphere
About the HQ vSphere Page
Display the HQ vSphere Page
HQ vSphere and Resource Permissions
HQ vSphere Inventory Tab
HQ vSphere Summary Tab
Summary Tab for vCenter
Summary Tab for vSphere Hosts
Summary Tab for vSphere VM
Summary Tab for a Managed Resource in the VM
HQ vSphere Performance Tab
View Metrics
Correlate Metrics
HQ vSphere Control Tab
Metrics
VMware vSphere Host Metrics
VMware vSphere VM Metrics
ui-LiveExec
Live Exec Commands
Run Live Exec on a Platform or Group of Platforms
ui-Views.AgentCommands
Restart an Agent or a Group of Agents
Ping an Agent or a Group of Agents
Upgrade an Agent or Group of Agents to a Newer Version
Push a Plugin to an Agent or Group of Agents
ui-Views.GemFire
GemFire View for a DS
GemFire View for a Cache Server or Application Peer
GemFire View for a Gateway Hub
ui-CurrentlyDown
Currently Down Resources
Contents of the Currently Down Page
Filter Resources of the Currently Down Page
View Nagios Resources and Metrics in Hyperic
View Nagios Service Detail
View a Nagios Check
ui-Inventory
ui-Inventory.Server
Inventory Page for a Server
Inventory Page Header for a Server
Resource Properties
Map Control for a Server
Tools Menu for a Server
General Properties for a Server
Type and Host Properties
Services on a Server
Groups Containing a Server
Configuration Properties for a Server
ui-Inventory.Server.New
When to Create a Server Manually
Create a Server
Inventory Page for a New Server
Configure Server for Monitoring
Edit a Server's Type and Host Properties
ui-Inventory.Service
Inventory Page for a Service
Inventory Page Header for a Service
Resource Properties
Map Control for a Service
Tools Menu for a Service
General Properties for a Service
Groups Containing a Service
Configuration Properties for a Service
Inventory Page - Service
ui-Inventory.Service.New
Learn About Platform Services
Configure a Platform Service
Platform Service Types
Inventory Tab - Server
ui-Inventory.Owner
ui-Inventory.GeneralProperties
ui-Inventory.Configuration
Navigate to the Configuration Properties Page
Configure Shared Properties
Configure Monitoring Properties - Log Tracking
Configure Monitoring Properties - Configuration Tracking
Configure Control Properties
Configure Alert Definitions Based on Events
ui-Inventory.Platform
Navigate to the Inventory Page for a Platform
Inventory Page Header
Resource Properties
Map Control for a Platform
Tools Menu for a Platform
General Properties for a Platform
Type and Network Properties for a Platform
Servers on a Platform
Services on a Platform
Groups Containing a Platform
Configuration Properties for a Platform
ui-Inventory.Platform.AutoDiscovery
ui-Inventory.Platform.New
When to Create a Platform Manually
Add a Platform to Inventory from the Hyperic User Interface
Edit a Platform's Type and Network Properties
ui-Inventory.Platform.Clone
Cloning a Platform
How to Clone a Platform
What Cloning is Good For
What Cloning Does
What Cloning Does Not Do
Inventory Tab - Platform
ui-Inventory.AutoDiscovery
ui-Inventory.AutoDiscovery.Results
Contents of the Auto-Discovery Results Page
Import or Skip Resources in Auto-Discovery Results Page
ui-Inventory.Application
Inventory Page for an Application
Inventory Page Header for an Application
Resource Properties
Tools Menu for an Application
General Properties for an Application
Application Properties
Service Counts for an Application
Services in an Application
Groups Containing an Application
Group Manager
Create an Application
Add Services to an Application
Edit Application Properties
ui-Inventory.Application.SvcDep
ui-Inventory.Group
Navigate to the Inventory Page for a Group
Inventory Page Header for a Group
Resource Properties for a Group
Map Control for a Compatible Group
Tools Menu for a Group
General Properties for a Group
Resources
Roles a Group is Assigned To
Create a Group
ui-Inventory.AssignRolesToGroups
Assign Roles to a Group
Adding the Current Resource to a Group
Tasks Available on This Screen
Assign Resource Groups
ui-Analyze
ui-Event.Center
Event Center
Filter the Event List
Contents of the Event Center Page
ui-Alert.Center
View Alerts In the Alert Center
Filter Alert List
Fix or Acknowledge an Alert in the Alert Center
View Alert Definitions In the Alert Center
Filter Alert Definition List
ui-Operations.Center
Filter by Problem Type and Resource
Set Table Controls
Contents of Operations Center Page
Current Filter Totals
Resource Details for All Hosts
ui-Report.Center
Navigate to the Report Center.
Run a Report
View a Report
ui-Admin
Administration Page
Authentication/Authorization
HQ Server Settings
Plugins
HQ License Information
ui-Admin.HQServer
HQ Email Configuration Properties
HQ Announcement Properties
Data Manager Properties
Global Alert Properties
Notification Throttling Configuration Properties
Automatic Baseline Configuration Properties
LDAP Configuration Properties
LDAP Authentication in vFabric Hyperic
Configure LDAP Authentication and Role Assignment
Kerberos Configuration Properties
SNMP Server Configuration Properties
Configure HQ Server for SNMP v1
Configure HQ Server for SNMP v2c
Configure HQ Server for SNMP v3
Groovy Console
ui-tcserverclient
HQ API
ui-Admin.Dependency
Define Network Host Relationships
Step 1 - Select a Top Level Platform to Update
Option A - Browse a Filtered List of Top Level Platforms
Option B - Navigate from a Dependent Platform
Step 2 - Manage a Top Level Platform's Dependents
ui-Admin.User
ui-Admin.User.AssignRole
ui-Admin.User.Edit
ui-Admin.User.List
ui-Admin.User.New
ui-Admin.User.Password
ui-Admin.Role
Properties Section
Permissions Section
Assigned Users
Assigned Groups
Alert Calendar
ui-Admin.Role.AssignUser
ui-Admin.Role.Groups
ui-Admin.Role.List
ui-Admin.Role.New
ui-Admin.Role.Permissions
About Permission Levels
Permission Tips
How HQ Validates Platform-Server-Service Permission Level Assignments
ui-HQHealth
HQ Health
Key Statistics
Diagnostics Tab
Cache Tab
Load Tab
Database Tab
Agents Tab
Maintenance Tab
Inventory Summary Tab
ui-Admin.Escalation
Create an Escalation
Step 1 - Create New Escalation Scheme
Step 2 - Create Escalation Actions
Create an Email or SMS Action
Create a Sys Log Action
Create an SNMP Notification Action
Create a Suppress Alerts Action
View an Escalation
Edit an Escalation
Delete an Escalation
Escalations
ui-Admin.Monitor
Monitoring Defaults Page
What's on the Monitoring Defaults Page
Navigate to Monitoring Configuration and Resource Lists
ui-Admin.Monitor.NewResourceTypeAlert
Define a Resource Type Alert
Step 1 - Select Target Resource Type
Step 2 - Define Alert Properties
Step 3 - Define Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Step 4 - Define Alert Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
ui-Admin.Monitor.MetricTemplate
Navigate to the Monitoring Defaults Page for a Resource Type
Enable Collection of a Metric
Disable Collection of a Metric
Change a Metric Collection Interval
Set Indicator Metrics
APIs for Metric Collection Settings
ui-Administration.Plugin.Manager
About Plugin Manager
View the Plugin Manager Page
Contents of the Plugin Manager Page
Determine Why an Agent is not Synchronizing
View Agent Sync Detail for a Plugin
Upload a Plugin
Remove Plugins
Troubleshooting
vFabric Hyperic Product Plug-in Development
About vFabric Hyperic Product Plug-in Development
Intended Audience
Introduction to Plugin Management Functions
Auto-Discovery Overview
Using Auto-Discovery Support Classes in Plugins
Auto-Discovery Class Hierarchy
Overview of Auto-Discovery Classes
Auto-Discovery Interfaces
How to Specify Auto-Discovery Implementation for a Resource Type
How to Supply Parameters for Auto-Discovery Implementation
Dynamic Service Type Detection
Introduction to Dynamic Service Type Detection
Implement discoverServiceTypes method
Using ServiceTypeInfo
Using ServiceType
Handle service settings
Custom properties
Properties
Plugins
Control actions
Measurements
Measurement Plugin
Measurement Plugins
Writing the XML Descriptor
Measurement Support Classes
Specify Measurement Plugin in Plugin Descriptor
Defining Measurements with the metric Tag
Using Templates to Collect Metric Data
Using Support Classes to Simplify Metric Collection
Using a Filter to Efficiently Apply a Template to Metrics
Getting Your Plugin to Auto-Discover Resources
Introduction to Plugin Development
Plugin Development Center
What Plugins Do
What Role the Server and Agent Play in Plugins
Technical Overview
Plugin Implementations
Using Support Classes to Simplify Your Plugin
Writing a Plugin
Testing Your Plugin
Deploying Your Plugin
Writing Plugins
JMX Plugin
Discovering Custom Properties
Implementing Log and Config Tracking
Example Custom MBean Plugins
tomcat-string-cache-plugin.xml
tomcat-webapp-cache-plugin.xml
SQL Query Plugin
SQL Query Plugin
Custom SQL Query Plugins
JDBC Drivers
Support Classes
Write a SQL Query Plugin
Step 1 - Create Plugin Descriptor File
Step 2 - Create Root plugin Element
Step 3 - Define service Element
Step 4 - Define config Element
Step 5 - Define metric Elements
Metric Template Format for SQL Query Plugins
Hard-Code the metric Elements
Parameterize metric Attributes
Step 6 - Review Complete Descriptor
Test Plugin
Deploy Plugin
Use the Deployed Plugin
Script Plugins
Facts About Script Plugins
What is a Script Plugin?
Script Plugin Contents and Packaging
Requirements for Script
How to Define the Proxy Resources in Plugin Descriptor
How to Define Management Functions
Auto-Discovery
Measurement
Control
Other Properties to Define
Script Plugin Examples
Control Script Example
iostat
iostat Tutorial
Command Line Test
Create an I/O Device service
I/O Device plugin sources
How often are my scripts executed?
samba
sendmail Plugin Descriptor
Write an SNMP Plugin
Writing an SNMP Plugin
Getting Started
Iteration 1 - A Very Basic Plug-in
Iteration 2 - Additional Platform Metrics
Iteration 3 - Pulling in Network Interfaces as Platform Services
Iteration 4 - Collecting Network Interface Service Metrics
Iteration 5 - Adding Auto-Discovery Components for the Platform
The Final Product
Additional SNMP Plugin Examples
Resources
JMX-Based Management with Hyperic
Introduction
JMX Resources an the Hyperic Inventory Model
Auto-Discovery of JMX Resources
Identify Target MBeans and Attributes
Configuration Properties Required for JMX Monitoring
Create a Custom JMX Plugin
Defining Service Types to Provide Management via Custom MBeans
Defining an ObjectName to Access Custom MBeans
Defining Configuration Properties to Be Displayed in the UI
Defining and Gathering Metrics
Specifying Availability Metric for MBeans
Implementing Control Actions
Define Server Auto-Inventory Element
Discovering Custom Properties
Implementing Log and Config Tracking
Example Custom MBean Plugins
Running and Testing Plugins from Command Line
Invoking Plugins from the Command Line
hq-pdk.jar Command Syntax
-m method specifies the method to run
-p PluginName specifies the plugin to run
-t ResourceType specifies the target resource type
-a MethodAction specifies a method argument
-DOption sets a property value
Generating and Using Resource Properties Files
Resource Properties Files
Names and Location of Properties Files
Content of Properties Files
Inherited Resource Properties
Properties for Controlling Agent Behavior and Plugin Execution
hq-pdk.jar Methods and Functionality
lifecyle - Initialize and Check Syntax
Example Results of lifecycle Method on a Plugin with No Errors
Example Results of lifecycle Method on a Plugin with Errors
discover - Auto-Discover Resources and Configuration
metric - Fetch Metrics
Syntax for metric Method Using Resource Properties File
Syntax for metric Method Specifying Configuration Data on Command Line
Example Invocations
Results returned by -metric method default action
Results returned by metric method translate action
track - Watch for Log or Configuration Events
Examples
control - Perform a Control Action on a Resource
Examples
livedata - Fetch Live System Information
Results of cpu Command
cpuperc Command Results
ifconfig Command Results
who Command Results
generate - Create Plugin Documentation
Syntax
Running Protocol Checks from Command Line
Deploy Plugin
Plugin Descriptors
Key Facts About HQ Plugin Descriptors
Descriptor Defines Resource Types, Management Functions, and Metrics
Managed Resource Type Hierarchy
Management Functions and Classes for each Resource Type
Inventory and Configuration Data for Each Resource Type
Metrics to Collect for Each Resource Type
Resource Hierarchy is the Skeleton of a Descriptor
A Functional View of Common Plugin Descriptor Elements
First Facts About Metric Templates
Inheritance and Reuse in Plugin Descriptors
Every Plugin Requires a Version Property
A Graphical View of Descriptor Elements and Functions
Plugin Descriptor Tips and Techniques
Understanding Metric Templates
Introduction to Metric Templates
Anatomy of a Metric Template
What a Metric Template Looks Like
Where the Data for a Metric Template Comes From
How a Metric's template Attribute is Specified
Learn More About Variables in Plugin Descriptors
Metric Template Rules for Each Collection Method
Variables in Plugin Descriptors
Variables Simplify Metric Template
Configuration Option Variables
Metric Attribute Variables
Resource Property Variables
Convenience Variables
Variables and Global Configs
configname.config Returns Option Name Value Pairs
configname.template Includes Domain for Metric Template
JMX Metric Templates
Components of the Template for a JMX Metric
template Attribute for a JMX Metric
Example Definition of JMX Metric Template
Using Global Configuration Schemas
Globally Available Resource Configurations
Include a Global Configuration Schema by Reference
Variables for Returning Formatted Config Schemas
Including a Descriptor in Another
Overriding the Value of a Resource property at Platform Level
Plugin Descriptor Element and Attribute Reference
actions
Element Overview
Parent Elements
Child Elements and Attributes
Examples
Specifying actions in the include attribute
Specifying actions in the include element
Limiting actions to a platform type
classpath
Element Overview
Parent Elements
Child Elements and Attributes
Examples
classpath specifies path to JDBC drivers
classpath specifies path to a JMX library
classpath specifies path to another plugin JAR file
classpath specifies path to multiple vendor jars
classpath specifies jars in HQ Server installation
config
Element Overview
Parent Elements
Child Elements and Attributes
Examples
config element defines a globally available configuration schema
config elements define and reference a globally available configuration schema
config element references a globally available configuration schema
config element includes two schemas by reference
filter
Element Overview
Parent Elements
Child Elements and Attributes
Examples
filter defines metric template components using configuration and metric alias
filter defines metric template using a values supplied by a property and a metric alias attribute
filter references globally available configuration schema
filter uses value of config option to provide domain portion of metric template
help
Element Overview
Parentage
Contents
Examples
help element defines a named block of HTML
help element defines help for a service type explicitly and by reference with append attribute
help element defines help for a service type by reference with append and include attributes
help element references a named block of HTML, by virtue of element location
help element references two named blocks of HTML using include and append attributes
include
Element Overview
Parentage
metric
Element Overview
Parentage
Contents
name
alias
category
units
indicator
collectionType
defaultOn
interval
group
rate
query
template
Examples
template for a metric obtained via a vendor API
template for metric obtained with network collector
template for metric obtained with SIGAR
template for metric obtained with JDBC
template for metric obtained with SQL Query
template for metric obtained with JMX
template for metric obtained with script
template for metric obtained with SNMP, constructed with globally available config
Metric Parameters
Plugin UOM
metrics
Element Structure
Parentage
Contents
Examples
unnamed metrics element within a service element
metrics element defined
metrics element is referenced using include attribute
metrics elements included using include element
metrics element includes several metric groups, plus a metric definition
metrics name matches resource's Name Attribute string
option
Element Overview
Parent Elements
Child Elements and Attributes
option Examples
option element defines selector list values
option element for an optional option
option element defines default value
platform
Element Overview
Parent Elements
platform Element Structure
Child Elements
platform Examples
Structure of a simple platform element
Simple platform element in full
plugin - Platform, Server and Service
Element Overview
Parent Elements
Element Structure
Child Attributes and Elements
Examples
plugin elements for a server type
config_track Plugin Element
plugin - root
Element Overview
Element Structure
Child Elements and Attributes
Examples
plugin name and package specified in plugin root
plugin class specified in root
plugin version specified in plugin root
properties
Element Overview
Parentage
Child Elements
Examples
properties element for a platform type
property
Element Overview
Parent Elements
Child Attributes
Examples
property defines connection string that a support class appends to metric templates
property defines OBJECT_NAME for use in plugin descriptor and class
property overrides the default value of an option
scan
Element Overview
Element Structure
Parent Elements
Child Attributes and Elements
Examples
Scan process table for Apache servers on Unix-like operating system
Scan Windows registry for Apache servers
Scan Unix filesystem for MySQL servers
script
Element Overview
Parent Elements
Child Attributes and Content
Example
server
Element Overview
Parent Elements
Child Attributes and Elements
Element Overview
Parent Elements
Child Attributes and Elements
Examples
server element example
server element contents are defined by reference using include attribute
Server type is limited to specific platforms types using platforms attribute
Server type is defined as virtual
service
Element Overview
Element Structure
Parent Elements
Child Attributes and Elements
Examples
service defines service that runs on a server
service defines platform service
Global Configuration Schemas Reference
basicauth config
credentials config
dhcp config
dns config
ftp config
http config
InetAddress Ping config
jmx config
ldap config
ntp config
pop3 config
protocol config
rpc config
smtp config
snmp config
sockaddr config
sql config
ssh config
ssl config
sslprotocol config
sslsockaddr config
tcp config
url config
Example Plugin Descriptor
Plugin Support Classes
Auto-Discovery Support Classes
AutoServerDetector
Overview
Interface Hierarchy
Interface References
Implementing Methods
Example Usage
Standalone Invocation
DaemonDetector
Overview
Class Hierarchy
Resource Properties
Example Usage
Draft MxServerDetector
FileServerDetector
Interface Hierarchy
Interface References
Implementing Methods
Example Usage
Standalone Invocation
MxServerDetector
Overview
Class Hierarchy
Resource Properties
Usage
RegistryServerDetector
Overview
Interface Hierarchy
Interface References
Implementing Methods
Example Usage
Standalone Invocation
ServerDetector
Overview
Class Hierarchy
Resource Properties
Using Extra Filters
Using INSTALLPATH
Using AUTOINVENTORY_NAME
Using INVENTORY_ID
Implementing Methods
setDescription
setCustomProperties
discoverServers
discoverServices
discoverServiceTypes
createServerResource
SNMPDetector
Overview
Class Hierarchy
Resource Properties
Usage
Control Support Classes
Control Plugins
Script Execution
Windows Service Manager
ControlPlugin.doAction Method
Mx Server Control Plugin
Script Control Plugin
Win32 Control Plugin
Event Tracking Support Classes
FileChangeTrackPlugin
FileChangeTrackPlugin Functionality
Class Hierarchy
Using FileChangeTrackPlugin
Sample Usage
ConfigFileTrackPlugin
ConfigFileTrackPlugin Functionality
Class Hierarchy
Using ConfigFileTrackPlugin
Sample Usage
Log4JLogTrackPlugin
Overview
Class Hierarchy
Configurable Options
Resource Properties
Return Type
Example Usage
LogFileTailPlugin
Log File Tracking Plugin
About Event Volume
Example
Win32 Event Log Track Plugin
Measurement Support Classes
MeasurementPlugin
Overview
Class Hierarchy
Configurable Options
Resource Properties
Implementing Methods
init
getManager
getMeasurementProperties
getMeasurements
getPlatformHelpProperties
getPluginXMLHelp
getHelp
getValue
getNewCollector
getCollectorProperties
translate
getConfigSchema
SNMP Measurement Plugin
Win32 Measurement Log Track Plugin
Product Plugin
ServerResource
Overview
Class Hierarchy
Implementing Methods
setInstallPath
getInstallPath
setPlatformFqdn
getPlatformFqdn
addService
addServiceType
setIdentifier
getIdentifier
setType
getType
setName
getName
setDescription
getDescription
setProductConfig
getProductConfig
setMeasurementConfig
getMeasurementConfig
setControlConfig
getControlConfig
setCustomProperties
getCustomProperties
ServiceResource
Overview
Class Hierarchy
Implementing Methods
setName
ConfigResponse
Overview
Class Hierarchy
Implementing Methods
setValue
Example Usage
Plugin Tutorials
JMX Plugin Tutorial
JMX Measurement Plugin
Develop Sample JMX Plugin
Step 1 - Understand how the Plugin Fits into Inventory Model
Step 2 - Configure the JMX-Enabled Application for Remote Connection
Step 3 - Determine Which Metrics to Collect in the Plugin
Step 4 - Review the Sample JMX Measurement Plugin Descriptor
Step 5 - What Plugin Will Show in the HQ UI
Step 6 - Understand and Modify Each Piece of the Sample Plugin XML Descriptor
Include Standard Process Metrics
Include JMX Libraries
Define Metrics
Specify Server Resource
Tell the Plugin About Services the Server Hosts
Enable the Plugin to Connect to the MBean Server
Identify the Processes You Want to Collect Metrics From
Gather Metrics
Auto-Discover the Server
Identify and Gather Metrics from the Server's Hosted Services
Provide Configuration Instructions
Step 7 - Test the Plugin.
Step 8 - Deploy the Plugin.
Plugins Tutorial
Plugins Tutorials
Tutorials by Plugin Type and Implementation
How Plugins and the HQ Inventory Model Work Together
Every Plugin Needs an XML Descriptor
XML Descriptor for Measurement Plugins
Auto-Discovery
Availability Metric
Troubleshooting
vFabric Hyperic HQU Plug-in Development
About vFabric Hyperic HQU Plug-in Development
Intended Audience
HQU Overview
What is HQU?
What is HQU Good For?
HQU Plugins and the HQ UI
Overview of HQU Plugin Development
HQU Anatomy and Components
HQU Design Pattern
Plugin Files
Plugin.groovy
plugin.properties
Controller_Name Controller.groovy
index.gsp
plugin_name _i18n.properties
Plugin Directories
Key HQU Framework Files
Plugins and the HQ Portal
HQU Deployment
Invoking an HQU Plugin as a Web Service
HQU Request Processing
Planning an HQU Plugin
Plugin Mission and Type
Access and Authorization
Required HQ Data and Functions
User Supplied Parameters
View Plugin Requirements
Integration Plugin Requirements
Automation Plugins
Developing an HQU Plugin
Step 1 - Create Plugin Scaffolding
Scaffolding Syntax and Arguments
Files and Directories Created by Scaffolding Task
Contents of the Generated Plugin Files
Step 2 - Build the Plugin
Step 3 - Deploy and Run the Plugin
Step 4 - Set Location Properties for a View Plugin
Excerpt from Plugin.groovy as Created
Understanding Attachment Properties and Options
Specify View Location in Plugin.groovy
Attach Plugin to a Masthead Menu
Attach Plugin to Administration Page
Attach Plugin to Resource>View page
Detaching and Removing HQU Plugins
Step 4 - Program the Plugin Behavior
Step 5 - Localize the Plugin
Contents of the I18n Properties as Created
Understanding How Plugin Views Obtain Localization Strings
Writing Plugin Controller Logic
Accessing HQ Data and Functions
HQU APIs
Backend APIs
Defining User Interaction
Defining Parameters
Creating Dojo Tables
Rendering
Obtaining Localized Strings
Rendering Ajax
Returning XML from Controllers
Returning JSON from Controllers
Miscellaneous Controller Topics
Groovy Console*
Re-using Markup with Groovy Templates
Using Variables in Controllers
Authorization
Snippets
Groovy Tips
Links to Groovy Topics
Groovy def
Property Accessor Methods
Accessibility Modifiers
Inferred Types
Plugin Scaffolding
Plugin.groovy
ControllerName Controller.groovy
index.gsp
plugin_name _i18n.properties
plugin.properties
HQ Groovy APIs
Coding Conventions
Obtaining a Helper Instance
BaseController Utility Methods
MetaClasses and Categories
ResourceHelper.groovy
AlertHelper.groovy
AuditHelper.groovy
BaseHelper.groovy
MetricHelper.groovy
AgentHelper.groovy
Sample Plugin
Currently Down View
SystemsdownController.groovy
vFabric Hyperic Overview
About vFabric Hyperic Overview
Intended Audience
Use of "Hyperic," "vFabric Hyperic," and "Hyperic HQ"
Introduction to Hyperic Monitoring
Main Components
Hyperic Agent
Hyperic Server and Hyperic Database
Hyperic User Interface (Hyperic Portal)
Hyperic Monitoring and Management Features
Key Hyperic Facts for the New User
Resources, Resource Types and Inventory Types
Resources and Resource Categories in Hyperic
Inventory Type
Resource Type
Platform Server Service Hierarchy
Graphical View of a Resource Hierarchy
Platform Hierarchy In Hyperic User Interface
About Platforms, Servers, and Services
Platforms
Operating System Platforms
Virtual and Network Platforms
Servers
Services and Platform Services
About Groups in Hyperic
Resource Groups in Hyperic
Compatible Groups
Mixed Groups
Autogroups
View a List of Autogroups on a Resource
View Monitor Tab for an Autogroup
View Monitor Tab for a Member of an Autogroup
About Applications in Hyperic
Introduction to Applications in Hyperic
Inventory Tab for an Application
Monitor Tab for an Application
User Accounts and Roles in Hyperic
Authentication
User Accounts in Hyperic
Built-in Accounts
User Account Creation and Authentication
Hyperic HQ User Accounts
vFabric Hyperic User Accounts
Roles in vFabric Hyperic
Permission Matrix: Grants Access to Types
About Permission Levels
Permission Tips
How HQ Validates Platform-Server-Service Permission Level Assignments
Groups: Grant Access to Specific Resources
Alert Calendar: Enable Shift-Based Notifications
Built-in Roles
SuperUser
Guest Role
Hyperic Roles and LDAP Groups
Resource Auto-Discovery Processes
Hyperic Auto-Discovery Processes
Default Scan
File Scan
Runtime Scan
About Auto-Inventory IDs and InstallPath
What the Agent Can and Cannot Discover
How Discovered Resources Get into Hyperic Inventory
What to Do After Adding New Resources to Inventory
Metrics and Metric Collection
Metric Categories
Availability
Throughput
Utilization
Performance
Metric Value Types
Baselines
Uses for Baselines in Hyperic
Baselines in the Hyperic User Interface
How a Baseline is Calculated
Default Metric Collection Settings
Log and Configuration Event Tracking
Hyperic Log Tracking Overview
Hyperic Resource Types that Support Log Tracking
Supported Log Message Types
Log Tracking Configuration Options
How to Set Up Log Tracking
Hyperic Configuration Tracking Overview
Event-Based Configuration Tracking
Polling-Based Configuration Tracking
How to Set Up Configuration Tracking
How to View Event Data
Resource Control in Hyperic
Control Action Overview
Alerts and Alert Definitions
Alerts
Functionality of a Resource Alert
Alert Definition Process
Alerts in the Hyperic User Interface
Fixing and Acknowledging Alerts
Enabling and Disabling Alert Definitions
Introduction to Escalation Schemes
Options for Controlling Alert and Notification Volume
Responding to Alert and Notification Storms
Advanced Alert Functionality in vFabric Hyperic
SNMP Functionality in Hyperic
Simple SNMP Agent Availability Checks
Monitor SNMP Devices and Hosts with Built-In Plugins
Build Vendor-Specific SNMP Plugins
Send SNMP Notifications for Alerts
Integrate Hyperic with OpenNMS
vFabric Hyperic Installation and Configuration
About vFabric Hyperic Installation and Configuration
Intended Audience
vFabric Hyperic QuickStart Installation
Key Facts for Hyperic Installers
Hyperic Security Features and Recommendations
SSL Best Practices for New Hyperic Installations
Agent-Initiated Communication
Protection of Sensitive Data
Use LDAP Authentication
About SSL in Hyperic
Hyperic SSL Support
Overview of Hyperic 4.6.x SSL Configuration and Defaults
Hyperic 4.6.x SSL Certificate Processing
SSL Between a 4.6.x Server and 4.5.x Agents
SSL and Hyperic Product Plugins
About Agent Configuration
Agent Startup Configuration Data
Optional Agent Configuration Properties
Supported Locations for agent.properties
How to Change Agent Setup Configuration Properties
About the Agent Launcher and Agent Startup
Agent Launcher
What Happens When an Agent Starts Up
Automatic Restart Behavior
About Agent - Server Communication
Agent-to-Server Communication
Server-to-Agent Communication
Unidirectional Agent-Server Communications
Unidirectional Communication via a Proxy
Agent Directory Structure
About Sizing Profiles in vFabric Hyperic
Deployment Size and Installation Sizing Profiles
Server Property Values for Sizing Profile
How to Select an Installation Sizing Profile
Install and Set Up Hyperic
Installation Requirements
Agent Server Compatibility Requirements
Hyperic Server Requirements
Hyperic Server JRE Requirements
Hyperic Server Resource Requirements
Hyperic Server Operating System Requirements
X Libraries on Unix-Based Platforms
Hyperic Server Supported Databases
Supported Browsers
Hyperic Database Requirements
Hyperic Agent Requirements
Agent System Resource Requirements
Agent Operating System Requirements
Agent JRE Requirements
Drivers for Monitoring Databases
Hyperic Installation and Startup Process
Step 1 – Obtain Hyperic Installer
Step 2 – Set Up Hyperic Database
Step 3 - Set Up Hyperic Server
Step 4 - Set Up the Hyperic Agent
Step 5 - Next Steps for New Installations
Hyperic Upgrade Processes
Hyperic 4.6 Upgrade Options
Upgrade Hyperic Server Only
Upgrade Server and Agent with Hyperic-Managed Keystores
Upgrade Server and Agent with User-Managed Keystores
Step-by-Step Procedures
Select and Download an Installer
Key Facts About Hyperic Installer Packaging
Installer Types
Hyperic Installer Features
Where to Get Hyperic Installation Packages
Configure JREs for Hyperic Components
About Hyperic JREs
Hyperic Agent JRE on Unix
Hyperic Agent JRE on Windows
Configure SSL Options
SSL Setup for New Hyperic Installations
SSL Setup for Upgrade Installations
Managed Products and SSL
Reconfigure Hyperic for Trusted SSL Certificates
Reconfigure Hyperic for Self-Signed Certificates
Set Up MySQL
Set Up Hyperic Database on MySQL
Step 1 - Create a MySQL Database Instance
Step 2 - Configure MySQL Startup Options and System Variables
Step 3 - Verify Database Setup
Solve Problems with MySQL Startup
Tune the Batch Aggregate Inserter for MySQL
Set Up Oracle
Set Up Hyperic Database on Oracle
Create Hyperic Database
Create Tablespaces
Create the Database User
Grant Permissions to the Database User
Set Up Hyperic Server
Enable Row Movement
Tuning Hyperic Database on Oracle for Medium to Large Environments
Create the TS_HQDB_16K Tablespace
Configure REDO Logs
Configure Initialization Parameters for Oracle
Configure Batch Aggregate Inserter
Move Database Tables
Rebuild Indexes for Moved Tables
Configure Tables for High Concurrency
Restart Hyperic Server
Periodic Oracle Database Maintenance
Set Up PostgreSQL
Set Up External Hyperic Database on PostgreSQL
Example Configuration
Install and Initialize PostgreSQL
Create PostgreSQL User
Configure PostgreSQL Server Options
PostgreSQL Tuning for Large Deployments (Optional)
Configure Client Authentication
Install PostgreSQL Client on the Hyperic Server Host
Install the Hyperic Server
Start Hyperic Server
Troubleshoot PostgreSQL Connection Problems
Useful PostgreSQL Commands
Run Hyperic Installer
Obtain Hyperic Installer
About the Setup Script
Run the Setup Script
Install an Agent-Only Package
Install from Agent Tarball
Install from Agent Zip Archive
Run Windows MSI Installer
About the Hyperic MSI Installer
Interactive MSI Installation
Interactive Complete Install
Interactive Custom Install
Silent MSI Installation
Command Line Syntax
MSI Silent Mode Properties
Example Silent Mode MSI Invocations
Silent MSI installation to Multiple Hosts Using Push Techniques
Using AT or SOON to start a process on a remote workstation
Using PsExec to Start a Process on a Remote System
Remote Installs with Microsoft Management Console
Solving Service Startup Problems After MSI Install
Install Hyperic Server RPM
About the Hyperic Server RPMs
Step 1 - Specify Server Configuration in Properties File
Step 2 - Install Hyperic Server
Step 3 - Configure Hyperic Server After RPM Installation
Configure Hyperic Server Interactively after Installation
Configure Hyperic Server in Properties File after Installation
Server Properties File for RPM Installation
Install Hyperic Agent RPM
About the Agent RPM
Install Agent RPM
Set Up Agent Interactively
About the Agent Configuration Dialog
Launch the Configuration Dialog
Agent Configuration Dialog
Set Up Agent in Properties File
Agent Properties Location
Procedure: Configure Agent-Server Communication Properties
Step 1 - Open or create agent.properties
Step 2 - Uncomment Agent-Server Communication Properties
Step 3 - Define Communication Properties in agent.properties File
Step 4 - Configure Unidirectional Communications (Optional)
Step 5 - Configure Agent Keystore (Optional)
Step 6 - Configure Additional Agent Behaviors (Optional)
Step 7 - Save Changes
Communication Properties Reference
Install Hyperic Agents in Volume
Establish Installation Environment
Set up an Install Server
Establish Environment on Target Platforms
Create Standard Agent Properties File
Perform Remote Agent Installations
Install and Start Agents One-by-One
Deploy and Start Multiple Agents at Once
Verify Successful Agent Startup
Upgrade Hyperic Agent
Agent Upgrade Methods
Push Agent Bundle from the vFabric Hyperic Server
Upgrade Agent Bundle Manually
Create a Custom Agent Upgrade Bundle
Upgrade Agent Using a Full Agent Package
Upgrade Hyperic Server
What Happens During Server Upgrade
Upgrade Hyperic Server on Unix-Based Platforms
Upgrade Hyperic Server on Windows Platforms
Scaling Hyperic Server in vFabric Hyperic 4.6.5
Solving Problems with Upgraded Servers with an Oracle Database
Uninstalling an Agent
Change vFabric Hyperic Server Sizing Profile
Configure Unidirectional Agent - Server Communication
Changing from Bidirectional to Unidirectional Communications
Changing from Unidirectional to Bidirectional Communications
Install or Configure vFabric Hyperic License
License Consumption in vFabric Hyperic
Install or Configure License
Configure and Run the Hyperic Server
Start and Stop Hyperic Server
Starting the Server on Unix-Based Platforms
Starting Hyperic Server After Installing from RPM
Starting the Server on Windows To Run as a Service
Configure Hyperic Server Java Options
Configure Metric Baselining and Alert Processing Behavior
Configure Global Alert Properties
Configure Alert Notification Throttling
Configure Alert Notification Email Properties
Configure Metric Baselining Properties
Scaling and Tuning Hyperic Performance
Sizing Considerations
Server Configuration Settings for Scaling
About Java Heap and Garbage Collection
About Hyperic Server Caches
Monitoring Hyperic Caches
Interpreting Cache Statistics
Configuring Caches
Configure Hyperic Version and Security Announcements
Integrate Hyperic Server with Other Systems
Configure Kerberos Properties
Configure LDAP Properties
LDAP Authentication in vFabric Hyperic
Configure LDAP Authentication and Role Assignment
Configuring Hyperic Server for SMTP Server
Enable vFabric Hyperic to Send SNMP Traps
Configure HQ Server to Send SNMP Traps
Configure vFabric Hyperic Server for SNMP v1
Configure vFabric Hyperic Server for SNMP v2c
Configure vFabric Hyperic Server for SNMP v3
Using SNMP Traps in Alert Definitions
Managing the HQ Database
Building a Metric Data Warehouse
Metric Replication Strategy Overview
Instructions for Establishing Secondary MySQL Database for Metrics
Set Up the Secondary Database
Test the New Views
Set up the Metric Data Replicator
Create log4j Properties File
Create Script to Run the Replication Process
Run the Replication Process
Verify the Replication Process Results
Query 1 - Show all the disk stats
Query 2 - Component Service Usage Information for Servers and Services
Hyperic Database Backup and Recovery
Backing up Built-In PostgreSQL Database
Backup and Recovery of MySQL and Oracle Databases
Hyperic Files to Backup
Configure Hyperic Server Data Compression and Purge Behavior
Hyperic Server Data Management Processes
Configure Hyperic Data Management Settings
Monitoring the Hyperic Database
Hyperic Database Table Schemas
Key Resource and Measurement Tables
EAM_RESOURCE Table - All Resource Types and Instances
Tables for Inventory Resources
Tables for Platform, Server, and Service Types
Tables for Measurement Information
Table Documentation
EAM_PLATFORM
EAM_PLATFORM_TYPE
EAM_SERVER
EAM_SERVICE
EAM_RESOURCE
EAM_MEASUREMENT
EAM_MEASUREMENT_TEMPL
MySQL Maintenance Examples
Clustering Hyperic Servers for Failover
Overview
Requirements for an Failover Deployment
Configuring a Server Cluster
Step 1 - Install the First Hyperic Server Instance
Step 2 - Install Additional Hyperic Server Nodes
Step 3 - Configure Cluster Name and Communications Properties
Default hq-server.conf File
Required Cluster Properties
Optional Cluster Properties
Step 4 - Configure the Load Balancer
Step 5 - Configure Agents to Communicate with Hyperic Server Cluster
Step 6 - Start the Nodes
Troubleshooting a Failover Configuration
Hyperic Server Properties
About Hyperic Server Configuration
Configuration Settings in hq-server.conf
Configuration Settings in the Database
Server Property Definitions
Clustering Properties in vFabric Hyperic
accept.unverified.certificates
server.database-driver
server.java.opts
server.quartzDelegate
server.database-url
server.connection-validation-sql
server.database-password
server.database-user
server.encryption-key
server.webapp.port
server.webapp.secure.port
server.plugin.custom.dir
server.keystore.password
server.keystore.path
server.pluginsync.enable
server.hibernate.dialect
server.jms.jmxport
server.jms.usejmx
server.database-blockingtimeout
server.database-minpoolsize
server.database
tomcat.minsparethreads
tomcat.maxthreads
server.jms.maxmemory
server.jms.highmemory
server.database-maxpoolsize
server.mail.host
vfabric.licenseServer.url
Configure and Run the Hyperic Agent
Start, Stop, and Other Agent Operations
Run the Agent Launcher from the Command Line
Running hq-agent.sh
Running hq-agent.bat
Run the Agent Launcher from the Hyperic User Interface
Restart an Agent from the Hyperic User Interface
Ping an Agent from the Hyperic User Interface
Upgrade an Agent from the Hyperic User Interface
Push a Resource Plugin to the Agent from the Hyperic User Interface
Run the Agent Without the Java Service Wrapper
Configure Auto-Discovery Scanning and Reporting
Configure Agent Logging
Agent Log Files
Configure Agent Log Name or Location
Configure Agent Logging Level
Redirect System Messages to the Agent Log
Configure Debug Log Level for an Agent Subsystem
Configure Plugin Loading
Tweak the Agent to Enable a Resource Plugin
Configure Agent Account Privileges under Solaris 10
Configure Agent HTTP Request Header
Configure Agent to Monitor JBoss
Configure Agent to Monitor WebSphere Application Server
Configure Hyperic Agent to Manage WebLogic Server
Specify WebLogic Server Installation Path
Configure Hyperic Agent for Two-Way SSL with WebLogic Server
Configure the Data to Log for Windows Events
Manage the Hyperic Agent
View Status of all Hyperic Agents
Agents Tab in HQ Health
Health Data for an Agent
View Hyperic Agent Metrics
Agent Monitoring Defaults
View Agent Indicators Charts
View Agent Metric Data
Hyperic Agent Metrics
Reduce Agent Memory Footprint
Limit Plugin Loading
Reduce Java Heap
agent.javaOpts
Delete Javadocs Folder
Agent Properties
agent.eventReportBatchSize
agent.javaOpts
agent.keystore.alias
agent.keystore.password
agent.keystore.path
agent.listenIp
agent.listenPort
agent.logDir
agent.logFile
agent.logLevel
agent.logLevel.SystemErr
agent.logLevel.SystemOut
agent.maxBatchSize
agent.proxyHost
agent.proxyPort
agent.storageProvider.info
agent.setup.acceptUnverifiedCertificate
agent.setup.camIP
agent.setup.camLogin
agent.setup.camPort
agent.setup.camPword
agent.setup.camSecure
agent.setup.camSSLPort
agent.setup.agentIP
agent.setup.agentPort
agent.setup.resetupToken
agent.setup.unidirectional
agent.startupTimeOut
autoinventory.defaultScan.interval.millis
autoinventory.runtimeScan.interval.millis
http.useragent
log4j Properties
jboss.installpath
platform.log_track.eventfmt
plugins.exclude
plugins.include
scheduleThread.cancelTimeout
scheduleThread.fetchLogTimeout
scheduleThread.poolsize
scheduleThread.queuesize
sigar.mirror.procnet
snmpTrapReceiver.listenAddress
weblogic.auth.method
weblogic.discovery.new
weblogic.installpath
weblogic.ssl2ways.cert
weblogic.ssl2ways.key
weblogic.ssl2ways.key.pass
websphere.installpath
websphere.useext
Troubleshoot Agent and Server Problems
Looking for Clues
HQ Health
hqstats and agentstats
Agent Metrics
Log Files
Thread Dumps
Generate a Hyperic Server Thread Dump from User Interface
Generate a Hyperic Server Thread Dump from Command Line
Generate Agent Thread Dump from User Interface
Check Port Availability
Hyperic Server Problems
Large Event Table
License Issues
Backlogged Hyperic Server
Agent Startup or Connection Problems
Agent Failed to Connect to Server at First Startup
Server Does Not Have Agent Token
Agent Start Script Timeout
Java Service Wrapper Timeout
Invalid or Unknown Availability
Out-of-Sync Agent and Server Clocks
Overloaded Backend
Overloaded Agent
Slow User Interface
Warning Messages in the Agent Log
Connection Timeout Messages
vFabric Hyperic Administration
About vFabric Hyperic Administration
Intended Audience
Discover and Import Resources to Inventory
Using the Auto-Discovery Portlet
Contents of the Auto-Discovery Portlet
Import or Skip Resources in Auto-Discovery Portlet
Configure the Number of Auto-Discoveries Displayed
Using the Auto-Discovery Results Page
Contents of the Auto-Discovery Results Page
Import or Skip Resources in Auto-Discovery Results Page
Options for Running and Controlling Resource Discovery
Scan a Platform On-Demand
Configure Default and Runtime Scanning Frequency
Configure Frequency of Default Scan
autoinventory.defaultScan.interval.millis
Disable Default Scan
Configure Frequency of Runtime Scan
autoinventory.runtimeScan.interval.millis
Exclude a Plugin Resource Hierarchy
Disable Platform Service Discovery
sigar.mirror.procnet
netservices.netstat
Disable Service Discovery for a Server Instance
Manage Resource Auto-Discovery
Configure Auto-Discovery Frequency
Configure Frequency of Default Scan
autoinventory.defaultScan.interval.millis
Disable Default Scan
Configure Frequency of Runtime Scan
autoinventory.runtimeScan.interval.millis
Scan a Platform On-Demand
Prevent Resource Discovery
Configure an Agent to Not Load a Plugin
Remove Plugin from All Agents
Disable Platform Service Discovery
sigar.mirror.procnet
netservices.netstat
Disable Service Discovery for a Server Instance
Solving Auto-Discovery Problems
Removed Resources Not Rediscovered
Discovered Resources Not Imported
Auto-Discovering WebLogic Server on Linux and Solaris
Auto-Discovering Server Types on Solaris
Set Up Alert Notifications and Escalations
Tailor Alert Notification Templates
Groovy Server Pages Define Notification Content and Format
Email Notifications
Email Notification Subject Line
Email Notification Body
Variables Available for Notification Templates
Configure Roles for Role-Based Alert Notifications
Roles for Alert Notifications
Follow the Sun Alerting with Role-Based Alert Calendars
Creating Roles
Enable SNMP Trap Notifications
Configure HQ Server to Send SNMP Traps
Configure vFabric Hyperic Server for SNMP v1
Configure vFabric Hyperic Server for SNMP v2c
Configure vFabric Hyperic Server for SNMP v3
Using SNMP Traps in Alert Definitions
Enable Syslog Notifications for Escalations
About Syslog Notifications in Alert Escalations
Enable Syslog Notifications
Enable the Syslog Receiver
Enable Syslog Appender
Restart Hyperic Server
Configure and Manage Escalations
Create an Escalation
Step 1 - Create New Escalation Scheme
Step 2 - Create Escalation Actions
Create an Email or SMS Action
Create a Sys Log Action
Create an SNMP Notification Action
Create a Suppress Alerts Action
View an Escalation
Edit an Escalation
Delete an Escalation
Set Up Alert Action Script
Define a Script Action for an Alert
Environment Variables for Fired Alert Data
Example Script
Assign the Script Action to an Alert
Configure a Custom Control Action
Step 1 - Install Executable
Step 2 - Configure Control Action as a Platform Service
Configure Monitoring and Alerting for a Resource
Configure Metric Baselines
Configure Global Baselining Properties
Recalculate Baselines for a Resource
Reset Baselines for a Charted Metric
Set Up Log Tracking for a Resource
Log Tracking Overview
Configure Log Tracking
Hyperic Resource Types that Support Log Tracking
Supported Log Message Types
Log Tracking Configuration Options
Log Tracking for Resources with Log4j Logs
Log Tracking for Network Services
Log Tracking for Windows Platforms
Content of Logged Windows Events
Tailoring the Content and Format of Logged Windows Events
platform.log_track.eventfmt Property
View Log Events
Defining Alert Conditions Based on Log Events
Log Tracking Support Classes
Set Up Configuration Tracking for a Resource
Hyperic Configuration Tracking Functionality
Set Up 4.6.5 Configuration Tracking for a Server
Set Up Polling-Based Configuration Tracking
View Configuration Events for a Resource
Configure Alerts Based on Configuration Events
Define an Alert for a Resource
Step 1 - Select Target Resource
Step 2 - Define Alert Properties
Step 3 - Define Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Step 4 - Define Alert Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
Define a Recovery Alert for a Resource Alert
Understanding Recovery Alerts
Define Primary Alert Definition to Disable Itself
Create a Recovery Alert Definition for a Resource Alert
Define Host Dependencies for Hierarchical Alerting
Define Network Host Relationships
Step 1 - Select a Top Level Platform to Update
Option A - Browse a Filtered List of Top Level Platforms
Option B - Navigate from a Dependent Platform
Step 2 - Manage a Top Level Platform's Dependents
Schedule Resource Downtime
Schedule Downtime
Configure Monitoring and Alerting for a Resource Type
Tailor Metric Collection for a Resource Type
Navigate to the Monitoring Defaults Page for a Resource Type
Enable Collection of a Metric
Disable Collection of a Metric
Change a Metric Collection Interval
Set Indicator Metrics
APIs for Metric Collection Settings
Define an Alert for a Resource Type
Define a Resource Type Alert
Step 1 - Select Target Resource Type
Step 2 - Define Alert Properties
Step 3 - Define Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Step 4 - Define Alert Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
Define a Recovery Alert for a Resource Type Alert
Understanding Recovery Alerts
Define Primary Alert Definition to Disable Itself
Create a Recovery Alert Definition for a Resource Type Alert
About Global Monitoring and Alerting Settings
Configure Global Alert Properties
Configure Alert Notification Throttling
Configure Alert Notification Email Properties
Configure Metric Baselining Properties
Configure Hyperic Version and Security Announcements
Manage Alert and Notification Volume
Manage Alerting for Optimal Visibility into Problems
Prevent Multiple Alerts for the Same Problem
Disable all Alert Notifications
Hierarchical Alerting Prevents a Cascade of Alerts in Resource Hierarchies
Configure Network Host Dependencies for Hierarchical Alerting
Set a Notification Throttle
Enable or Disable all Alert Definitions
Manage Alert Definitions
View and Edit Alert Definitions
List Alert Definitions for a Resource
List Alert Definitions for a Resource Type
List Alert Definitions for a Resource Group
View All Alert Definitions for all Resources
View and Edit an Alert Definition
Enable and Disable Alert Definitions
Enable or Disable a Resource Alert Definition
Enable or Disable Multiple Alert Definitions for a Resource
Enable or Disable a Resource Type Alert Definition
Enable or Disable an Group Alert Definition
Enable or Disable all Alert Definitions for Multiple Resources
Enable or Disable all Alert Definitions
Enable Alert Definition Change Logging
Create and Manage Resource Groups and Applications
Configure and Manage Resource Groups
Create a Group
Add Resources to a Group
Assign Roles to a Group
Edit a Group's Inventory Properties
Remove Resources from a Group
Remove Roles from a Group
Define an Alert for a Resource Group
Understanding Resource Group Alerts
Define a Resource Group Alert
Step 1 - Select Target Compatible Group
Step 2 - Define Alert Properties
Step 3 - Define Alert Condition
Step 4 - Assign Escalation Action
Schedule Downtime for a Resource Group
Schedule Downtime
Create and Manage Applications
Instrument Java Components (Optional)
Create an Application
Add Services to an Application
Add Application to a Group
Monitoring an Application with Indicator Charts
Configuring Hyperic as an SNMP Trap Receiver
Receiving SNMP Traps from Network Devices or Systems
Step 1 - Select and Enable an Agent to Receive Traps
Step 2 - Configure Trap Generator
Step 3 - Create a Proxy Platform for Trap Data
Solving Problems
Manage Hyperic Users and Roles
Create and Manage User Accounts
Create a New User Account
Define User Account Attributes
Assign Roles to a New User Account
List User Accounts
View a User Account
Modify User Account Settings
Change Password
Edit Account Settings
Update Roles Assigned to a User
Create and Manage Roles in vFabric Hyperic
Create a Role
Assign Users to a Role
Assign Groups to a Role
Define Alert Calendar for Follow-the-Sun Role-Based Notifications
Customize Role-Specific Dashboard
Use Roles for Follow the Sun Alerting
List Roles
View a Role
Properties Section
Permissions Section
Assigned Users
Assigned Groups
Alert Calendar
Edit a Role
Role-Based Dashboards in vFabric Hyperic
Role-Based Dashboards
Role-Based Dashboards are Automatically Available
Permissions for Modifying Role-Based Dashboards
Tailor a Role-Based Dashboard
Manage Inventory with HQApi
View and Manage Resource Data
View Inventory Properties for a Resource
View Inventory Properties for a Platform
Navigate to the Inventory Page for a Platform
Inventory Page Header
Resource Properties
Map Control for a Platform
Tools Menu for a Platform
General Properties for a Platform
Type and Network Properties for a Platform
Servers on a Platform
Services on a Platform
Groups Containing a Platform
Configuration Properties for a Platform
View Inventory Properties for a Server
Inventory Page for a Server
Inventory Page Header for a Server
Resource Properties
Map Control for a Server
Tools Menu for a Server
General Properties for a Server
Type and Host Properties
Services on a Server
Groups Containing a Server
Configuration Properties for a Server
View Inventory Properties for a Service
Inventory Page for a Service
Inventory Page Header for a Service
Resource Properties
Map Control for a Service
Tools Menu for a Service
General Properties for a Service
Groups Containing a Service
Configuration Properties for a Service
View Inventory Properties for a Group
Navigate to the Inventory Page for a Group
Inventory Page Header for a Group
Resource Properties for a Group
Map Control for a Compatible Group
Tools Menu for a Group
General Properties for a Group
Resources
Roles a Group is Assigned To
View Inventory Properties for an Application
Inventory Page for an Application
Inventory Page Header for an Application
Resource Properties
Tools Menu for an Application
General Properties for an Application
Application Properties
Service Counts for an Application
Services in an Application
Groups Containing an Application
Group Manager
Create a Platform, Server, or Service Manually
Create a Platform
When to Create a Platform Manually
Add a Platform to Inventory from the Hyperic User Interface
Configure Platform for Monitoring
Clone a Platform
Cloning a Platform
How to Clone a Platform
What Cloning is Good For
What Cloning Does
What Cloning Doesn't Do
Create a Platform Service
When to Manually Create a Platform Service
Create a Platform Service
Configuration Instructions for Platform Services
Create a Server
When to Create a Server Manually
Create a Server
Inventory Page for a New Server
Configure Server for Monitoring
Create a Service
When to Create a Service Manually
Add a Service to Inventory from the Hyperic User Interface
Remove Resources from Hyperic Inventory
Delete a Resource Manually
Delete Resources with HQApi
Plugin Deployment and Management
Key Hyperic Plugin Management Features
Version Requirements for Plugin Synchronization
Plugin Administration Tasks
Resource Plugin Deployment Directories
About Plugin Manager
About Custom Plugin Deployment with Plugin Manager
About Plugin Removal with Plugin Manager
About Plugin Sync at Startup
About Plugin Sync at Agent Startup
About Plugin Sync at Server Startup
Disable Server-Agent Plugin Synchronization
vFabric Hyperic Resource Configuration and Metrics
About vFabric Hyperic Resource Configuration and Metrics
Intended Audience
GemFire
GemFire Plugin Overview
Supported Versions
GemFire Resources and the Hyperic Inventory Model
Configuration Overview
Resource Types and Management Functions
Management Functions for GemFire Distributed System
Management Functions for JMX Agent
Management Functions for Cache Server 6.5
Management Functions for Cache Server 6.5 Region
Management Functions for Gateway Hub 6.5
Management Functions for Gateway Hub 6.5 Gateway
Management Functions for Gateway Hub 6.5 Region
Management Functions for Application Peer 6.5
Management Functions for Application Peer 6.5 Region
Configuration Instructions
Step 1: Enable GemFire Member Discovery and Monitoring
Step 2: Configure Hyperic Agent for the DS
Step 3: Configure a Platform for the DS
Step 4: Set Event Tracking Options
Step 5: Tailor Plugin Monitoring Defaults
Step 6: Configure Alert Definitions
Metric Documentation
GemFire Distributed System Metrics
Member Metrics
Region Metrics
Gateway Hub 6.5 Gateway Metrics
GemFire Events
Hyperic GemFire View
GemFire View for a DS
GemFire View for a Cache Server or Application Peer
GemFire View for a Gateway Hub
Java Applications
Auto-Discovery of Custom MBeans
Prerequisites and Supported Environments
Java Version
Supported Containers
Enable Discovery of a Stand-Alone Instrumented Java Application
MBeanServer
Create a MBeanServer in Tomcat
Create an MBeanServer for Stand-Alone Apps or Other Container
Enable ModelMBean Export in JBoss Containers
Step 1 - Set Up Resources to Export ModelMBeans
Step 2 - Verify Model MBean Export to MBeanServer
Step 3 - Verify Service Application Auto-Discovery
Solving Problems with Service Auto-Discovery
Step 4 - Configure App Services as an Application in HQ
Model MBean Naming and Descriptor Data
Key Facts About ModelMBeans and Service Discovery
ModelMBean ObjectName Format
ModelMBeanInfo Descriptors
ModelMBeanAttributeInfo Descriptors
ModelMBeanOperationInfo Descriptors
JBoss
Monitoring JBoss
JBoss Configuration Tracking
JBoss Metrics
JBoss 7 server
JBoss 7 server
JBoss 7 Datasource service
JBoss 7 Connector service
JBoss 7 deployment service
JBoss 7 Connector service
JBoss Managed 7 server
JBoss Managed 7 server
JBoss Managed 7 Connector service
JBoss Managed 7 Datasource service
JBoss Managed 7 deployment service
JBoss Host Controller 7 server
JBoss Host Controller 7 server
JBoss 6.0 server
JBoss 6.0 server
JBoss 6.0 EJB 3 service
JBoss 6.0 Hibernate Session Factory service
JBoss 6.0 JCA Connection Pool service
JBoss 6.0 JCA Data Source service
JBoss 6.0 JGroups Channel service
JBoss 6.0 JMS HornetQ QUEUE service
JBoss 6.0 JMS HornetQ Topic service
JBoss 6.0 JMS QUEUE Destination service
JBoss 6.0 JMS Topic service
JBoss 6.0 Message Driven EJB service
JBoss 6.0 Stateful Session EJB service
JBoss 6.0 Stateless Session EJB service
JBoss 6.0 WebApp service
JBoss 5.1 server
JBoss 5.1 server
JBoss 5.1 EJB 3 service
JBoss 5.1 Hibernate Session Factory service
JBoss 5.1 JCA Connection Pool service
JBoss 5.1 JCA Data Source service
JBoss 5.1 JGroups Channel service
JBoss 5.1 JMS QUEUE Destination service
JBoss 5.1 JMS Topic service
JBoss 5.1 Message Driven EJB service
JBoss 5.1 Stateful Session EJB service
JBoss 5.1 Stateless Session EJB service
JBoss 5.1 WebApp service
JBoss 5.0 server
JBoss 5.0 server
JBoss 5.0 EJB 3 service
JBoss 5.0 Hibernate Session Factory service
JBoss 5.0 JCA Connection Pool service
JBoss 5.0 JCA Data Source service
JBoss 5.0 JGroups Channel service
JBoss 5.0 JMS QUEUE Destination service
JBoss 5.0 JMS Topic service
JBoss 5.0 Message Driven EJB service
JBoss 5.0 Stateful Session EJB service
JBoss 5.0 Stateless Session EJB service
JBoss 5.0 WebApp service
JBoss 4.3 server
JBoss 4.3 server
JBoss 4.3 EJB3 service
JBoss 4.3 Entity EJB service
JBoss 4.3 Hibernate Session Factory service
JBoss 4.3 JCA Connection Pool service
JBoss 4.3 JCA Data Source service
JBoss 4.3 JGroups Channel service
JBoss 4.3 JMS Destination service
JBoss 4.3 JMS Queue Destination service
JBoss 4.3 JMS Topic service
JBoss 4.3 Message Driven EJB service
JBoss 4.3 Stateful Session EJB service
JBoss 4.3 Stateless Session EJB service
JBoss 4.2 server
JBoss 4.2 server
JBoss 4.2 EJB3 service
JBoss 4.2 Entity EJB service
JBoss 4.2 Hibernate Session Factory service
JBoss 4.2 JCA Connection Pool service
JBoss 4.2 JCA Data Source service
JBoss 4.2 JGroups Channel service
JBoss 4.2 JMS Destination service
JBoss 4.2 JMS Topic service
JBoss 4.2 Message Driven EJB service
JBoss 4.2 Stateful Session EJB service
JBoss 4.2 Stateless Session EJB service
JBoss 4.0 server
JBoss 4.0 server
JBoss 4.0 EJB3 service
JBoss 4.0 Entity EJB service
JBoss 4.0 Hibernate Session Factory service
JBoss 4.0 JCA Connection Pool service
JBoss 4.0 JCA Data Source service
JBoss 4.0 JMS Destination service
JBoss 4.0 JMS Topic service
JBoss 4.0 Message Driven EJB service
JBoss 4.0 Stateful Session EJB service
JBoss 4.0 Stateless Session EJB service
JBoss 3.2 server
JBoss 3.2 server
JBoss 3.2 Entity EJB service
JBoss 3.2 JCA Connection Pool service
JBoss 3.2 JMS Destination service
JBoss 3.2 JMS Topic service
JBoss 3.2 Message Driven EJB service
JBoss 3.2 Stateful Session EJB service
JBoss 3.2 Stateless Session EJB service
Local Platform Services
When to Manually Create a Platform Service
Create a Platform Service
Configuration Instructions for Platform Services
FileServer Directory Service
File Server Directory
Create FileServer Directory Service in Hyperic.
File Server Directory Service Configuration Options
FileServer Directory Service Metrics
Event Tracking
FileServer Directory Tree Service
File Server Directory Tree
Create FileServer Directory Tree Service in Hyperic
File Server Directory Tree Service Configuration Options
FileServer Directory Service Metrics
Event Tracking
FileServer File Service
FileServer File
Create FileServer File Service in Hyperic
File Server File Service Configuration Options
FileServer File Service Metrics
Event Tracking
FileServer Mount Service
FileServer Mount
Create FileServer Mount Service in Hyperic
FileServer Mount Service Configuration Options
FileServer Mount Service Metrics
Event Tracking
Multiprocess Service
Multiprocess
Specifying Process Queries
Create Multiprocess Service in Hyperic
Process Service Configuration Options
Process Service Metrics
Process Service
Process
Specifying Process Queries
Create Process Service in Hyperic
Process Service Configuration Options
Process Service Metrics
Control
Event Tracking
Script Service
Script Service Overview
Create Script Service in Hyperic
Script Service Configuration Options
Script Service Metrics
Event Tracking
CPU Service
CPU Service
CPU Service Metrics
Event Tracking
NetworkServer Interface Service
NetworkServer Interface
NetworkServer Interface Service Metrics
Windows Service Service
Monitoring a Windows Service
Resource Plugin, Functions, and Classes
Configure the Windows Service in Hyperic
Windows Service Configuration Properties Page
Windows Service Metrics
Windows Service Monitoring Defaults Page
Event Tracking
Nagios
Nagios Resources and the Hyperic Inventory Model
Management Functions
Auto-Discovery
Metric Collection
Log Tracking
Configure Nagios Monitoring
Prerequisites
Install Hyperic Agent
Create and Configure Nagios Server Resource for Monitoring
Configure Hyperic Alerts on Nagios Checks
View Nagios Resources and Metrics in Hyperic
View Nagios Service Detail
View a Nagios Check
NetApp Filer
NetApp Filer Plugin Overview
NetApp Filer Resources and the HQ Inventory Model
Configuration Instructions
Prerequisites
Step 1 - Configure the Filer in HQ
NetApp Filer Configuration Properties Page
NetApp Filer Configuration Options
Step 2 - Configure Tracking of Trap Events (Optional)
Step 3 - Configure Alert Definitions (Optional)
Understand NetApp Plugin Management Functions and Metrics
Auto-Discovery
NetApp Filer Platform Properties
NetApp Filer File System Properties
NetApp Filer Interface Properties
Metric Collection
NetApp Filer Metrics
NetApp Filer File System Metrics
NetApp Filer Interface Service Metrics
NetApp Filer NFS Server v2 Metrics
NetApp Filer NFS Server v3 Metrics
NetApp Filer CIFS Server Metrics
Solving Problems
NetApp Filer platform metrics
NetApp Filer CIFS Server service metrics
NetApp Filer File System service metrics
NetApp Filer Interface service metrics
NetApp Filer NFS server v2 service metrics
NetApp Filer NFS server v3 service metrics
Network Device
Monitoring a Network Device
Network Device Resources and the Hyperic Inventory Model
Configuration Instructions
Step 1 - Configure the Network Device in Hyperic
Configuration Properties Page
Network Device Configuration Options
Step 2 - Configure Tracking of Trap Events (Optional)
Step 3 - Configure Alert Definitions (Optional)
Step 4 - Define Dependency Relationships (Optional)
Management Functions
Auto-Discovery
Metric Collection
Network Device Metrics
Network Interface Metrics
Solving Problems
Network Platform Services
Hyperic Network Service Monitoring Capabilities
Configuration Requirements and Options for Monitoring Network Services
Metrics for Network Services
Classes for Monitoring a Network Service
Services Hyperic Can Monitor Over the Network
DHCP Platform Service
Monitor a Remote DHCP Service
Resource Plugin, Functions, and Classes
Configure the DHCP Service in HQ
Configuration Properties Page
DHCP Configuration Options
DHCP Metrics
DHCP Monitoring Defaults Page
Event Tracking
DNS Platform Service
Monitor a Remote DNS Service
Resource Plugin, Functions, and Classes
Configure a DNS Service in Hyperic
Configuration Properties Page
DNS Configuration Options
DNS Metrics
DNS Monitoring Defaults Page
Event Tracking
FTP Platform Service
Monitor a Remote FTP Service
Resource Plugin, Functions, and Classes
Configure the FTP Service in HQ
Configuration Properties Page
FTP Configuration Options
FTP Metrics
FTP Monitoring Defaults Page
Event Tracking
HTTP Platform Service
Monitoring a Remote HTTP Service
Resource Plugin, Functions, and Classes
Configure the HTTP Service in Hyperic
HTTP Configuration Properties Page
HTTP Configuration Options
HTTP Metrics
Http Monitoring Defaults Page
Event Tracking
IMAP Platform Service
Monitor a Remote IMAP Server
Resource Plugin, Functions, and Classes
Configure the IMAP Service in HQ
Configuration Properties Page
IMAP Configuration Options
IMAP Metrics
IMAP Monitoring Defaults Page
Event Tracking
InetAddress Ping Platform Service
Monitoring an Internet Address
Resource Plugin, Functions, and Classes
Configure the InetAddress Ping Service in Hyperic
Configuration Properties Page
InetAddress Ping Configuration Options
InetAddress Ping Metrics
InetAddress Ping Monitoring Defaults Page
Event Tracking
LDAP Platform Service
Monitor a Remote LDAP Service
Resource Plugin, Functions, and Classes
Configure the LDAP Service in HQ
Configuration Properties Page
LDAP Configuration Options
LDAP Metrics
LDAP Monitoring Defaults Page
Event Tracking
NTP Platform Service
Monitor a Remote NTP Server
Resource Plugin, Functions, and Classes
Configure the NTP Service in HQ
Configuration Properties Page
NTP Configuration Options
Metrics
NTP Monitoring Defaults Page
Event Tracking
POP3 Platform Service
Monitor a Remote POP3 Service
Resource Plugin, Functions, and Classes
Configure the POP3 Service in HQ
Configuration Properties Page
POP3 Configuration Options
Metrics
POP3 Monitoring Defaults Page
Event Tracking
RPC Platform Service
Monitor a Remote RPC Service
Resource Plugin, Functions, and Classes
Configure the RPC Service in HQ
Configuration Properties Page
RPC Configuration Options
RPC Metrics
RPC Monitoring Defaults Page
RPC Event Tracking
SMTP Platform Service
Monitoring a Remote SMTP Service
Resource Plugin, Functions, and Classes
Configure the SMTP Service in Hyperic
Configuration Properties Page
SMTP Configuration Options
SMTP Metrics
SMTP Monitoring Defaults Page
Event Tracking
SNMP Platform Service
Monitor a Remote SNMP Agent
Resource Plugin, Functions, and Classes
Configure the SNMP Service in Hyperic
Configuration Properties Page
SNMP Configuration Options
SNMP Metrics
SNMP Monitoring Defaults Page
SSH Platform Service
Resource Plugin, Functions, and Classes
Configure the SSH Service in Hyperic
Configuration Properties Page
SSH Configuration Options
SSH Metrics
SSH Monitoring Defaults
Event Tracking
TCP Socket Platform Service
Monitoring a Remote TCP Server
Resource Plugin, Functions, and Classes
Configure the TCP Socket Service in HQ
TCP Socket Configuration Properties Page
TCP Socket Configuration Options
TCP Socket Metrics
TCP Socket Monitoring Defaults Page
Event Tracking
PostgreSQL
Configure PostgreSQL Monitoring
PostgreSQL Configuration Tracking
PostgreSQL Metrics
PostgreSQL 8.4 server
PostgreSQL 8.4 server
PostgreSQL 7.4 Table service
PostgreSQL 8.3 Index service
PostgreSQL 9.0 server
PostgreSQL 9.0 server
PostgreSQL 8.0 server
PostgreSQL 8.0 server
JBoss 3.2 Hibernate Session Factory service
PostgreSQL 7.4 Index service
PostgreSQL 9.0 Index service
PostgreSQL 8.1 Table service
PostgreSQL 7.4 server
PostgreSQL 7.4 server
PostgreSQL 8.4 Table service
PostgreSQL 8.2 Index service
PostgreSQL 9.0 Table service
PostgreSQL 8.2 server
PostgreSQL 8.2 server
PostgreSQL 8.3 server
PostgreSQL 8.3 server
PostgreSQL 8.4 Index service
PostgreSQL 8.0 Index service
PostgreSQL 8.1 server
PostgreSQL 8.1 server
PostgreSQL 8.2 Table service
PostgreSQL 8.1 Index service
PostgreSQL 8.3 Table service
PostgreSQL 8.0 Table service
RabbitMQ
RabbitMQ Plugin Overview
Supported Versions and Requirements
RabbitMQ Resources and the Hyperic Inventory Model
SSL Requirements
Configuration Instructions
Step 1: Remove Previous RabbitMQ Inventory Resources and Agent Installation
Step 2: Install Hyperic Agent
Step 3: Import RabbitMQ Server(s) to Inventory
Step 4: Set Event Tracking Options
Step 5: Tailor Plugin Monitoring Defaults
Step 6: Configure Alert Definitions
Resource Types and Management Functions
Auto-Discovery
RabbitMQ Server Properties
RabbitMQ Exchange Service Properties
RabbitMQ Queue Service Properties
RabbitMQ VirtualHost Service Properties
RabbitMQ Connection Service Properties
RabbitMQ Channel Service Properties
Metric Collection
RabbitMQ Metrics
RabbitMQ Exchange Metrics
RabbitMQ Queue Metrics
RabbitMQ VirtualHost Metrics
RabbitMQ Connection Metrics
RabbitMQ Channel Metrics
RabbitMQ server
RabbitMQ VirtualHost service
RabbitMQ Queue service
RabbitMQ Exchange service
RabbitMQ Channel service
RabbitMQ Connection service
Spring Application server
Spring Insight
Spring Insight Plugin Overview
About Spring Insight
Functionality of Hyperic Spring Insight Plugin
Supported Versions and Requirements
Spring Insight Resources and the Hyperic Inventory Model
Installation Environment
Configuration Instructions
Step 1: Install Hyperic Agents
Step 2: Import Insight Dashboard to Hyperic Inventory
Step 3: Tailor Plugin Monitoring Defaults (Optional)
Step 3: Tailor Alert Definitions (Optional)
Resource Types and Management Functions
Auto-Discovery
Spring Insight
Spring Insight Application
Metric Collection
Spring Insight Dashboard Metrics
Spring Insight Application Metrics
Application Server Metrics
Database Metrics
Platform Metrics
Pre-Configured Alert Definitions
Application Health Alert
Application Error Alert
Spring Insight Applications View
Sun JVM
Step 1 - Configure JVM for JMX Monitoring
Step 2 - Add JVM to HQ Inventory
Step 3 - Configure JVM for Monitoring
tc Server
Configure a tc Server Instance
tc Runtime Configuration
Navigating tc Runtime Configuration Pages
Saving or Undoing Changes
User Permissions Required to Use the tc Runtime Features
Configuring General tc Runtime Options
Configuring Startup Options
Configuring the Context Container
Configuring JSP Options
Configuring Static Content Defaults
Using the Advanced Server Configuration Options
Reloading Settings From Server
Reverting to a Previously Saved Configuration
Uploading a Configuration File
Configuring and Creating JDBC Data Sources
Configuring and Creating tc Runtime Services
Configuring and Creating Connectors
Configuring and Creating Virtual Hosts
Configuring tc Runtime Logging
Manage tc Server Applications
tc Runtime Application Management
Navigating to a tc Runtime Instance Or Group
Creating tc Runtime Groups
Listing Applications
Deploying Applications
Undeploying Applications
Starting Applications
Stopping Applications
Reloading Applications
Server Configuration Reference
tc Runtime Configuration Reference
General Configuration
Server Properties
JMX Listener
Server Start Configuration
General
Sun Specific JVM Options
Advanced
Context Container
Static Resource Cache
Web Application Logger
Server Defaults - JSP
Server Defaults - Static Content
JDBC Configuration Reference
tc Runtime JDBC Reference
General Properties
Connection Properties
Tomcat/DBCP Connection Pool Properties
Service Configuration Reference
tc Runtime Services Reference
General Service Properties
Connector Properties
General
Security/SSL
APR SSL Settings
Engine Properties
Thread Diagnostics
Host Properties
HTTP Access Logging
Metrics
tc Runtime 6.0
SpringSource tc Runtime 6.0 Web Module Stats service
SpringSource tc Runtime 6.0 Tomcat JDBC Connection Pool Global service
SpringSource tc Runtime 6.0 Tomcat JDBC Connection Pool Context service
SpringSource tc Runtime 6.0 Thread Pools service
SpringSource tc Runtime 6.0 Thread Diagnostics Host service
SpringSource tc Runtime 6.0 Thread Diagnostics Engine service
SpringSource tc Runtime 6.0 Thread Diagnostics Context service
SpringSource tc Runtime 6.0 Servlet Monitor service
SpringSource tc Runtime 6.0 server
SpringSource tc Runtime 6.0 JSP Monitor service
SpringSource tc Runtime 6.0 Java Process Metrics service
SpringSource tc Runtime 6.0 HTTP service
SpringSource tc Runtime 6.0 Global Request Processor service
SpringSource tc Runtime 6.0 Garbage Collector service
SpringSource tc Runtime 6.0 Executor service
SpringSource tc Runtime 6.0 Data Source Global service
SpringSource tc Runtime 6.0 Data Source Context service
SpringSource tc Runtime 6.0 Cache service
tc Runtime 7.0
SpringSource tc Runtime 7.0 Web Module Stats service
SpringSource tc Runtime 7.0 Tomcat JDBC Connection Pool Global service
SpringSource tc Runtime 7.0 Tomcat JDBC Connection Pool Context service
SpringSource tc Runtime 7.0 Thread Pools service
SpringSource tc Runtime 7.0 Thread Diagnostics Host service
SpringSource tc Runtime 7.0 Thread Diagnostics Engine service
SpringSource tc Runtime 7.0 Thread Diagnostics Context service
SpringSource tc Runtime 7.0 Servlet Monitor service
SpringSource tc Runtime 7.0 server
SpringSource tc Runtime 7.0 JSP Monitor service
SpringSource tc Runtime 7.0 Java Process Metrics service
SpringSource tc Runtime 7.0 HTTP service
SpringSource tc Runtime 7.0 Global Request Processor service
SpringSource tc Runtime 7.0 Garbage Collector service
SpringSource tc Runtime 7.0 Executor service
SpringSource tc Runtime 7.0 Data Source Global service
SpringSource tc Runtime 7.0 Data Source Context service
SpringSource tc Runtime 7.0 Cache service
vSphere
vSphere Plugin Overview
Supported Versions and Requirements
vSphere Resources and the Hyperic Inventory Model
Configuration Overview
Resource Types and Management Functions
Management Functions for VMware vCenter
Management Functions for VMware vSphere Hosts
Management Functions for VMware vSphere VMs
vSphere Components in the Hyperic User Interface
vSphere Components in the Resource Hub
View a VMware vCenter Instance in the Resource Hub
View a VMware vSphere Host in the Resource Hub
View a VMware vSphere VM in the Resource Hub
vSphere Components in vFabric Hyperic
Configuration Instructions
Step 1 - Setup Agent Keystore
Step 2 - Install Hyperic Agent
Step 3 - Configure Agent Properties
Step 4 - Tune Agent and vSphere Plugin for Large Virtual Environment (Optional)
Step 5 - Configure vCenter Server Access Credentials
Step 6 - Set Event Tracking Options
Step 7 - Configure vCenter Statistics Level
Step 8 - Tailor Plugin Monitoring Defaults
Step 9 - Install Hyperic Agents in VMs
Step 10 - Configure Alert Definitions
Metric Documentation
VMware vSphere Host Metrics
VMware vSphere Host DS Metrics
VMware vSphere VM Metrics
VMware vSphere VM DS Metrics
Events
AccountCreatedEvent
AccountRemovedEvent
AccountUpdatedEvent
AdminPasswordNotChangedEvent
AlarmActionTriggeredEvent
AlarmCreatedEvent
AlarmEmailCompletedEvent
AlarmEmailFailedEvent
AlarmReconfiguredEvent
AlarmRemovedEvent
AlarmScriptCompleteEvent
AlarmScriptFailedEvent
AlarmSnmpCompletedEvent
AlarmSnmpFailedEvent
AlarmStatusChangedevent
AllVirtualMachinesLicensedevent
AlreadyAuthenticatedSessionEvent
BadUsernameSessionEvent
CanceledHostOperationEvent
ClusterComplianceCheckedEvent
ClusterCreatedEvent
ClusterDestroyedEvent
ClusterOvercommittedEvent
ClusterReconfiguredEvent
ClusterStatusChangedEvent
com.vmware.license.AddLicenseEvent
com.vmware.license.AssignLicenseEvent
com.vmware.license.LicenseAssignFailedEvent
com.vmware.license.LicenseExpiryEvent
com.vmware.license.RemoveLicenseEvent
com.vmware.license.UnassignLicenseEvent
com.vmware.vc.cim.CIMGroupHealthStateChanged
CustomFieldDefAddedEvent
CustomFieldDefEvent
CustomFieldDefRemovedEvent
CustomFieldDefRenamedEvent
CustomFieldValueChangedEvent
CustomizationFailed
CustomizationLinuxIdentityFailedEvent
CustomizationNetworkSetupFailedEvent
CustomizationStartedEvent
CustomizationSucceeded
CustomizationSysprepFailedEvent
DasAdmissionControlDisabledEvent
DasAdmissionControlEnabledEvent
DasAgentFoundEvent
DasAgentUnavailableEvent
DasClusterIsolatedEvent
DasDisabledEvent
DasEnabledEvent
DasHostFailedEvent
DasHostIsolatedEvent
DatacenterCreatedEvent
DatacenterRenamedEvent
DatastoreCapacityIncreasedEvent
DatastoreDestroyedEvent
DatastoreDiscoveredEvent
DatastoreDuplicatedEvent
DatastoreFileCopiedEvent
DatastoreFileDeletedEvent
DatastoreFileMovedEvent
DatastorePrincipalConfigured
DatastoreRemovedOnHostEvent
DatastoreRenamedEvent
DatastoreRenamedOnHostEvent
DrsDisabledEvent
DrsEnabledEvent
DrsEnteredStandbyModeEvent
DrsEnteringStandbyModeEvent
DrsExitedStandbyModeEvent
DrsExitingStandbyModeEvent
DrsExitStandbyModeFailedEvent
DrsInvocationFailedEvent
DrsRecoveredFromFailureEvent
DrsResourceConfigureFailedEvent
DrsResourceConfigureSyncedEvent
DrsVmMigratedEvent
DrsVmPoweredOnEvent
DuplicateIpDetectedEvent
DVPortgroupCreatedEvent
DVPortgroupDestroyedEvent
DVPortgroupReconfiguredEvent
DVPortgroupRenamedEvent
DvsCreatedEvent
DvsDestroyedEvent
DvsEvent
DvsHostBackInSyncEvent
DvsHostJoinedEvent
DvsHostLeftEvent
DvsHostWentOutOfSyncEvent
DvsMergedEvent
DvsPortBlockedEvent
DvsPortConnectedEvent
DvsPortCreatedEvent
DvsPortDeletedEvent
DvsPortDisconnectedEvent
DvsPortJoinPortgroupEvent
DvsPortLeavePortgroupEvent
DvsPortLinkDownEvent
DvsPortLinkUpEvent
DvsPortReconfiguredEvent
DvsPortUnblockedEvent
DvsReconfiguredEvent
DvsRenamedEvent
DvsUpgradeAvailableEvent
DvsUpgradedEvent
DvsUpgradeInProgressEvent
DvsUpgradeRejectedEvent
EnteredMaintenanceModeEvent
EnteredStandbyModeEvent
EnteringMaintenanceModeEvent
EnteringStandbyModeEvent
ErrorUpgradeEvent
ExitedStandbyModeEvent
ExitingStandbyModeEvent
ExitMaintenanceModeEvent
ExitStandbyModeFailedEvent
FailoverLevelRestored
GeneralEvent
GeneralHostErrorEvent
GeneralHostInfoEvent
GeneralHostWarningEvent
GeneralUserEvent
GeneralVmErrorEvent
GeneralVmInfoEvent
GeneralVmWarningEvent
GhostDvsProxySwitchDetectedEvent
GhostDvsProxySwitchRemovedEvent
GlobalMessageChangedEvent
HealthStatusChangedEvent
HostAddedEvent
HostAddFailedEvent
HostAdminDisableEvent
HostAdminEnableEvent
HostCnxFailedAccountFailedEvent
HostCnxFailedAlreadyManagedEvent
HostCnxFailedBadCcagentEvent
HostCnxFailedBadUsernameEvent
HostCnxFailedBadVersionEvent
HostCnxFailedCcagentUpgradeEvent
HostCnxFailedEvent
HostCnxFailedNetworkErrorEvent
HostCnxFailedNoAccessEvent
HostCnxFailedNoConnectionEvent
HostCnxFailedNoLicenseEvent
HostCnxFailedNotFoundEvent
HostCnxFailedTimeoutEvent
HostComplianceCheckedEvent
HostCompliantEvent
HostConfigAppliedEvent
HostConnectedEvent
HostConnectionLostEvent
HostDasDisabledEvent
HostDasDisablingEvent
HostDasEnabledEvent
HostDasEnablingEvent
HostDasErrorEvent
HostDasOkEvent
HostDisconnectedEvent
HostEnableAdminFailedEvent
HostExtraNetworksEvent
HostGetShortNameFailedEvent
HostInventoryFullEvent
HostInventoryUnreadableEventEventindicating that the virtual machine inventory file on the host is damaged or unreadable.
HostIpChangedEvent
HostIpInconsistentEvent
HostIpToShortNameFailedEvent
HostIsolationIpPingFailedEvent
HostLicenseExpiredEvent
HostMissingNetworksEvent
HostMonitoringStateChangedEvent
HostNoAvailableNetworksEvent
HostNoHAEnabledPortGroupsEvent
HostNonCompliantEvent
HostNoRedundantManagementNetworkEvent
HostNotInClusterEvent
HostOvercommittedEvent
HostPrimaryAgentNotShortNameEvent
HostProfileAppliedEvent
HostReconnectionFailedEvent
HostRemovedEvent
HostShortNameInconsistentEvent
HostShortNameToIpFailedEvent
HostShutdownEvent
HostStatusChangedEvent
HostSyncFailedEvent
HostUpgradeFailedEvent
HostUserWorldSwapNotEnabledEvent
HostVnicConnectedToCustomizedDVPortEvent
HostWwnChangedEvent
HostWwnConflictEvent
IncorrectHostInformationEvent
InfoUpgradeEvent
InsufficientFailoverResourcesEvent
InvalidEditionEvent
LicenseExpiredEvent
LicenseNonComplianceEvent
LicenseRestrictedEvent
LicenseServerAvailableEvent
LicenseServerUnavailableEvent
LocalDatastoreCreatedEvent
LockerMisconfiguredEvent
LockerReconfiguredEvent
MigrationErrorEvent
MigrationHostErrorEvent
MigrationHostWarningEvent
MigrationResourceErrorEvent
MigrationResourceWarningEvent
MigrationWarningEvent
NASDatastoreCreatedEvent
NoAccessUserEvent
NoDatastoresConfiguredEvent
NoLicenseEvent
NoMaintenanceModeDrsRecommendationForVM
NotEnoughResourcesToStartVmEvent
OutOfSyncDvsHost
PermissionAddedEvent
PermissionRemovedEvent
PermissionUpdatedEvent
ProfileAssociatedEvent
ProfileChangedEvent
ProfileCreatedEvent
ProfileDissociatedEvent
ProfileEvent
ProfileReferenceHostChangedEvent
ProfileRemovedEvent
ResourcePoolCreatedEvent
ResourcePoolDestroyedEvent
ResourcePoolMovedEvent
ResourcePoolReconfiguredEvent
ResourceViolatedEvent
RoleAddedEvent
RoleRemovedEvent
RoleUpdatedEvent
ScheduledTaskCompletedEvent
ScheduledTaskCreatedEvent
ScheduledTaskEmailCompletedEvent
ScheduledTaskEmailFailedEvent
ScheduledTaskEvent
ScheduledTaskFailedEvent
ScheduledTaskReconfiguredEvent
ScheduledTaskRemovedEvent
ScheduledTaskStartedEvent
ServerLicenseExpiredEvent
ServerStartedSessionEvent
SessionTerminatedEvent
TaskEvent
TaskTimeoutEvent
TemplateBeingUpgradedEvent
TemplateUpgradedEvent
TemplateUpgradeFailedEvent
TimedOutHostOperationEvent
UnlicensedVirtualMachinesEvent
UnlicensedVirtualMachinesFoundEvent
UpdatedAgentBeingRestartedEvent
UpgradeEvent
UserAssignedToGroup
UserLoginSessionEvent
UserLogoutSessionEvent
UserPasswordChanged
UserUnassignedFromGroup
UserUpgradeEvent
VcAgentUninstalledEvent
VcAgentUninstallFailedEvent
VcAgentUpgradedEvent
VcAgentUpgradeFailedEvent
VimAccountPasswordChangedEvent
VmAcquiredMksTicketEvent
VmAutoRenameEvent
VmBeingClonedEvent
VmBeingCreatedEvent
VmBeingDeployedEvent
VmBeingHotMigratedEvent
VmBeingMigratedEvent
VmBeingRelocatedEvent
VmClonedEvent
VmCloneFailedEvent
VmConfigMissingEvent
VmConnectedEvent
VmCreatedEvent
VmDasBeingResetEvent
VmDasBeingResetWithScreenshotEvent
VmDasResetFailedEvent
VmDasUpdateErrorEvent
VmDasUpdateOkEvent
VmDateRolledBackEvent
VmDeployedEvent
VmDeployFailedEvent
VmDisconnectedEvent
VmDiscoveredEvent
VmDiskFailedEvent
VmEmigratingEvent
VmEndRecordingEvent
VmEndReplayingEvent
VmEvent
VmFailedMigrateEvent
VmFailedRelayoutEvent
VmFailedRelayoutOnVmfs2DatastoreEvent
VmFailedStartingSecondaryEvent
VmFailedToPowerOffEvent
VmFailedToPowerOnEvent
VmFailedToRebootGuestEvent
VmFailedToResetEvent
VmFailedToShutdownGuestEvent
VmFailedToStandbyGuestEvent
VmFailedToSuspendEvent
VmFailedUpdatingSecondaryConfig
VmFailoverFailed
VmFaultToleranceStateChangedEvent
VmFaultToleranceTurnedOffEvent
VmFaultToleranceVmTerminatedEvent
VMFSDatastoreCreatedEvent
VMFSDatastoreExpandedEvent
VMFSDatastoreExtendedEvent
VmGuestRebootEvent
VmGuestShutdownEvent
VmGuestStandbyEvent
VmHealthMonitoringStateChangedEvent
VmInstanceUuidAssignedEvent
VmInstanceUuidChangedEvent
VmInstanceUuidConflictEvent
VmMacAssignedEvent
VmMacChangedEvent
VmMacConflictEvent
VmMaxFTRestartCountReached
VmMaxRestartCountReached
VmMessageErrorEvent
VmMessageEvent
VmMessageWarningEvent
VmMigratedEvent
VmNoCompatibleHostForSecondaryEvent
VmNoNetworkAccessEvent
VmOrphanedEvent
VMotionLicenseExpiredEvent
VmPoweredOffEvent
VmPoweredOnEvent
VmPoweringOnWithCustomizedDVPortEvent
VmPowerOffOnIsolationEvent
VmPrimaryFailoverEvent
VmReconfiguredEvent
VmRegisteredEvent
VmRelayoutSuccessfulEvent
VmRelayoutUpToDateEvent
VmRelocatedEvent
VmRelocateFailedEvent
VmRemoteConsoleConnectedEvent
VmRemoteConsoleDisconnectedEvent
VmRemovedEvent
VmRenamedEvent
VmResettingEvent
VmResourcePoolMovedEvent
VmResourceReallocatedEvent
VmRestartedOnAlternateHostEvent
VmResumingEvent
VmSecondaryAddedEvent
VmSecondaryDisabledBySystemEvent
VmSecondaryDisabledEvent
VmSecondaryEnabledEvent
VmSecondaryStartedEvent
VmShutdownOnIsolationEvent
VmStartingEvent
VmStartingSecondaryEvent
VmStartRecordingEvent
VmStartReplayingEvent
VmStaticMacConflictEvent
VmStoppingEvent
VmSuspendedEvent
VmSuspendingEvent
VmTimedoutStartingSecondaryEvent
VmUnsupportedStartingEvent
VmUpgradeCompleteEvent
VmUpgradeFailedEvent
VmUpgradingEvent
VmUuidAssignedEvent
VmUuidChangedEvent
VmUuidConflictEvent
VmWwnAssignedEvent
VmWwnChangedEvent
VmWwnConflictEvent
vprob.net.connectivity.lost
vprob.net.e1000.tso6.notsupported
vprob.net.migrate.bindtovmk
vprob.net.proxyswitch.port.unavailable
vprob.net.redundancy.degraded
vprob.net.redundancy.lost
vprob.storage.connectivity.lost
vprob.storage.redundancy.degraded
vprob.storage.redundancy.lost
vprob.vmfs.heartbeat.recovered
vprob.vmfs.heartbeat.timedout
vprob.vmfs.heartbeat.unrecoverable
vprob.vmfs.journal.createfailed
vprob.vmfs.lock.corruptondisk
AccountCreatedEvent
AccountRemovedEvent
AccountUpdatedEvent
AdminPasswordNotChangedEvent
AlarmActionTriggeredEvent
AlarmCreatedEvent
AlarmEmailCompletedEvent
AlarmEmailFailedEvent
AlarmReconfiguredEvent
AlarmRemovedEvent
AlarmScriptCompleteEvent
AlarmScriptFailedEvent
AlarmSnmpCompletedEvent
AlarmSnmpFailedEvent
AlarmStatusChangedevent
AllVirtualMachinesLicensedevent
AlreadyAuthenticatedSessionEvent
BadUsernameSessionEvent
CanceledHostOperationEvent
ClusterComplianceCheckedEvent
ClusterCreatedEvent
ClusterDestroyedEvent
ClusterOvercommittedEvent
ClusterReconfiguredEvent
ClusterStatusChangedEvent
com.vmware.license.AddLicenseEvent
com.vmware.license.AssignLicenseEvent
com.vmware.license.LicenseAssignFailedEvent
com.vmware.license.LicenseExpiryEvent
com.vmware.license.RemoveLicenseEvent
com.vmware.license.UnassignLicenseEvent
com.vmware.vc.cim.CIMGroupHealthStateChanged
CustomFieldDefAddedEvent
CustomFieldDefEvent
CustomFieldDefRemovedEvent
CustomFieldDefRenamedEvent
CustomFieldValueChangedEvent
CustomizationFailed
CustomizationLinuxIdentityFailedEvent
CustomizationNetworkSetupFailedEvent
CustomizationStartedEvent
CustomizationSucceeded
CustomizationSysprepFailedEvent
DasAdmissionControlDisabledEvent
DasAdmissionControlEnabledEvent
DasAgentFoundEvent
DasAgentUnavailableEvent
DasClusterIsolatedEvent
DasDisabledEvent
DasEnabledEvent
DasHostFailedEvent
DasHostIsolatedEvent
DatacenterCreatedEvent
DatacenterRenamedEvent
DatastoreCapacityIncreasedEvent
DatastoreDestroyedEvent
DatastoreDiscoveredEvent
DatastoreDuplicatedEvent
DatastoreFileCopiedEvent
DatastoreFileDeletedEvent
DatastoreFileMovedEvent
DatastorePrincipalConfigured
DatastoreRemovedOnHostEvent
DatastoreRenamedEvent
DatastoreRenamedOnHostEvent
DrsDisabledEvent
DrsEnabledEvent
DrsEnteredStandbyModeEvent
DrsEnteringStandbyModeEvent
DrsExitedStandbyModeEvent
DrsExitingStandbyModeEvent
DrsExitStandbyModeFailedEvent
DrsInvocationFailedEvent
DrsRecoveredFromFailureEvent
DrsResourceConfigureFailedEvent
DrsResourceConfigureSyncedEvent
DrsVmMigratedEvent
DrsVmPoweredOnEvent
DuplicateIpDetectedEvent
DVPortgroupCreatedEvent
DVPortgroupDestroyedEvent
DVPortgroupReconfiguredEvent
DVPortgroupRenamedEvent
DvsCreatedEvent
DvsDestroyedEvent
DvsEvent
DvsHostBackInSyncEvent
DvsHostJoinedEvent
DvsHostLeftEvent
DvsHostWentOutOfSyncEvent
DvsMergedEvent
DvsPortBlockedEvent
DvsPortConnectedEvent
DvsPortCreatedEvent
DvsPortDeletedEvent
DvsPortDisconnectedEvent
DvsPortJoinPortgroupEvent
DvsPortLeavePortgroupEvent
DvsPortLinkDownEvent
DvsPortLinkUpEvent
DvsPortReconfiguredEvent
DvsPortUnblockedEvent
DvsReconfiguredEvent
DvsRenamedEvent
DvsUpgradeAvailableEvent
DvsUpgradedEvent
DvsUpgradeInProgressEvent
DvsUpgradeRejectedEvent
EnteredMaintenanceModeEvent
EnteredStandbyModeEvent
EnteringMaintenanceModeEvent
EnteringStandbyModeEvent
ErrorUpgradeEvent
ExitedStandbyModeEvent
ExitingStandbyModeEvent
ExitMaintenanceModeEvent
ExitStandbyModeFailedEvent
FailoverLevelRestored
GeneralEvent
GeneralHostErrorEvent
GeneralHostInfoEvent
GeneralHostWarningEvent
GeneralUserEvent
GeneralVmErrorEvent
GeneralVmInfoEvent
GeneralVmWarningEvent
GhostDvsProxySwitchDetectedEvent
GhostDvsProxySwitchRemovedEvent
GlobalMessageChangedEvent
HealthStatusChangedEvent
HostAddedEvent
HostAddFailedEvent
HostAdminDisableEvent
HostAdminEnableEvent
HostCnxFailedAccountFailedEvent
HostCnxFailedAlreadyManagedEvent
HostCnxFailedBadCcagentEvent
HostCnxFailedBadUsernameEvent
HostCnxFailedBadVersionEvent
HostCnxFailedCcagentUpgradeEvent
HostCnxFailedEvent
HostCnxFailedNetworkErrorEvent
HostCnxFailedNoAccessEvent
HostCnxFailedNoConnectionEvent
HostCnxFailedNoLicenseEvent
HostCnxFailedNotFoundEvent
HostCnxFailedTimeoutEvent
HostComplianceCheckedEvent
HostCompliantEvent
HostConfigAppliedEvent
HostConnectedEvent
HostConnectionLostEvent
HostDasDisabledEvent
HostDasDisablingEvent
HostDasEnabledEvent
HostDasEnablingEvent
HostDasErrorEvent
HostDasOkEvent
HostDisconnectedEvent
HostEnableAdminFailedEvent
HostExtraNetworksEvent
HostGetShortNameFailedEvent
HostInventoryFullEvent
HostInventoryUnreadableEventEventindicating that the virtual machine inventory file on the host is damaged or unreadable.
HostIpChangedEvent
HostIpInconsistentEvent
HostIpToShortNameFailedEvent
HostIsolationIpPingFailedEvent
HostLicenseExpiredEvent
HostMissingNetworksEvent
HostMonitoringStateChangedEvent
HostNoAvailableNetworksEvent
HostNoHAEnabledPortGroupsEvent
HostNonCompliantEvent
HostNoRedundantManagementNetworkEvent
HostNotInClusterEvent
HostOvercommittedEvent
HostPrimaryAgentNotShortNameEvent
HostProfileAppliedEvent
HostReconnectionFailedEvent
HostRemovedEvent
HostShortNameInconsistentEvent
HostShortNameToIpFailedEvent
HostShutdownEvent
HostStatusChangedEvent
HostSyncFailedEvent
HostUpgradeFailedEvent
HostUserWorldSwapNotEnabledEvent
HostVnicConnectedToCustomizedDVPortEvent
HostWwnChangedEvent
HostWwnConflictEvent
IncorrectHostInformationEvent
InfoUpgradeEvent
InsufficientFailoverResourcesEvent
InvalidEditionEvent
LicenseExpiredEvent
LicenseNonComplianceEvent
LicenseRestrictedEvent
LicenseServerAvailableEvent
LicenseServerUnavailableEvent
LocalDatastoreCreatedEvent
LockerMisconfiguredEvent
LockerReconfiguredEvent
MigrationErrorEvent
MigrationHostErrorEvent
MigrationHostWarningEvent
MigrationResourceErrorEvent
MigrationResourceWarningEvent
MigrationWarningEvent
NASDatastoreCreatedEvent
NoAccessUserEvent
NoDatastoresConfiguredEvent
NoLicenseEvent
NoMaintenanceModeDrsRecommendationForVM
NotEnoughResourcesToStartVmEvent
OutOfSyncDvsHost
PermissionAddedEvent
PermissionRemovedEvent
PermissionUpdatedEvent
ProfileAssociatedEvent
ProfileChangedEvent
ProfileCreatedEvent
ProfileDissociatedEvent
ProfileEvent
ProfileReferenceHostChangedEvent
ProfileRemovedEvent
ResourcePoolCreatedEvent
ResourcePoolDestroyedEvent
ResourcePoolMovedEvent
ResourcePoolReconfiguredEvent
ResourceViolatedEvent
RoleAddedEvent
RoleRemovedEvent
RoleUpdatedEvent
ScheduledTaskCompletedEvent
ScheduledTaskCreatedEvent
ScheduledTaskEmailCompletedEvent
ScheduledTaskEmailFailedEvent
ScheduledTaskEvent
ScheduledTaskFailedEvent
ScheduledTaskReconfiguredEvent
ScheduledTaskRemovedEvent
ScheduledTaskStartedEvent
ServerLicenseExpiredEvent
ServerStartedSessionEvent
SessionTerminatedEvent
TaskEvent
TaskTimeoutEvent
TemplateBeingUpgradedEvent
TemplateUpgradedEvent
TemplateUpgradeFailedEvent
TimedOutHostOperationEvent
UnlicensedVirtualMachinesEvent
UnlicensedVirtualMachinesFoundEvent
UpdatedAgentBeingRestartedEvent
UpgradeEvent
UserAssignedToGroup
UserLoginSessionEvent
UserLogoutSessionEvent
UserPasswordChanged
UserUnassignedFromGroup
UserUpgradeEvent
VcAgentUninstalledEvent
VcAgentUninstallFailedEvent
VcAgentUpgradedEvent
VcAgentUpgradeFailedEvent
VimAccountPasswordChangedEvent
VmBeingClonedEvent
VmBeingCreatedEvent
VmBeingDeployedEvent
VmBeingHotMigratedEvent
VmBeingMigratedEvent
VmBeingRelocatedEvent
VmClonedEvent
VmCloneFailedEvent
VmConfigMissingEvent
VmConnectedEvent
VmCreatedEvent
VmDasBeingResetEvent
VmDasBeingResetWithScreenshotEvent
VmDasResetFailedEvent
VmDasUpdateErrorEvent
VmDasUpdateOkEvent
VmDateRolledBackEvent
VmDeployedEvent
VmDeployFailedEvent
VmDisconnectedEvent
VmDiscoveredEvent
VmEndRecordingEvent
VmEndReplayingEvent
VmEvent
VmFailedMigrateEvent
VmFailedRelayoutEvent
VmFailedRelayoutOnVmfs2DatastoreEvent
VmFailedStartingSecondaryEvent
VmFailedToPowerOffEvent
VmFailedToPowerOnEvent
VmFailedToRebootGuestEvent
VmFailedToResetEvent
VmGuestShutdownEvent
VmGuestStandbyEvent
VmHealthMonitoringStateChangedEvent
VmInstanceUuidAssignedEvent
VmInstanceUuidChangedEvent
VmInstanceUuidConflictEvent
VmMacAssignedEvent
VmMacChangedEvent
VmMacConflictEvent
VmMaxFTRestartCountReached
VmMaxRestartCountReached
VmMessageErrorEvent
VmMessageEvent
VmMessageWarningEvent
VmMigratedEvent
VmNoCompatibleHostForSecondaryEvent
VmOrphanedEvent
VMotionLicenseExpiredEvent
VmPoweredOffEvent
VmPoweredOnEvent
VmPoweringOnWithCustomizedDVPortEvent
VmPowerOffOnIsolationEvent
VmPrimaryFailoverEvent
VmReconfiguredEvent
VmRegisteredEvent
VmRelayoutSuccessfulEvent
VmRelayoutUpToDateEvent
VmRelocatedEvent
VmRelocateFailedEvent
VmRemoteConsoleConnectedEvent
VmRemoteConsoleDisconnectedEvent
VmRemovedEvent
VmRenamedEvent
VmResettingEvent
VmResourcePoolMovedEvent
VmResourceReallocatedEvent
VmRestartedOnAlternateHostEvent
VmResumingEvent
VmSecondaryAddedEvent
VmSecondaryDisabledBySystemEvent
VmSecondaryDisabledEvent
VmSecondaryEnabledEvent
VmSecondaryStartedEvent
VmShutdownOnIsolationEvent
VmStartingEvent
VmStartingSecondaryEvent
VmStartRecordingEvent
VmStartReplayingEvent
VmStaticMacConflictEvent
VmStoppingEvent
VmSuspendedEvent
VmSuspendingEvent
VmTimedoutStartingSecondaryEvent
VmUnsupportedStartingEvent
VmUpgradeCompleteEvent
VmUpgradeFailedEvent
VmUpgradingEvent
VmUuidAssignedEvent
VmUuidChangedEvent
VmUuidConflictEvent
VmWwnAssignedEvent
VmWwnChangedEvent
VmWwnConflictEvent
vprob.net.connectivity.lost
vprob.net.e1000.tso6.notsupported
vprob.net.migrate.bindtovmk
vprob.net.proxyswitch.port.unavailable
vprob.net.redundancy.degraded
vprob.net.redundancy.lost
vprob.storage.connectivity.lost
vprob.storage.redundancy.degraded
vprob.storage.redundancy.lost
vprob.vmfs.heartbeat.recovered
vprob.vmfs.heartbeat.timedout
vprob.vmfs.heartbeat.unrecoverable
vprob.vmfs.journal.createfailed
vprob.vmfs.lock.corruptondisk
vprob.vmfs.nfs.server.disconnect
vprob.vmfs.nfs.server.restored
vprob.vmfs.resource.corruptondisk
vprob.vmfs.volume.locked
WarningUpgradeEvent
vprob.vmfs.nfs.server.restored
vprob.vmfs.resource.corruptondisk
vprob.vmfs.volume.locked
WarningUpgradeEvent
WebLogic Server
Introduction
Configuration Overview
Configure WebLogic Server Monitoring
Specify Agent JRE
Run Agent with Required Permissions
Configure WLS Location
Configure SSL
One-Way SSL
Two-Way SSL
Restart Agent
Verify Auto-Discovery of Administration Server
Configure Monitoring
Required Administration Server Configuration
Configure Log Event Tracking and Service Monitoring
Verify Managed Server Auto-Discovery
Complete Monitoring Configuration
Troubleshoot WebLogic Server Auto-Discovery Problems
Solve Administration Server Auto-Discovery Problems
Test Auto-Discovery
Check Network Access
Verify Permissions
If Plugin Lacks Necessary Permissions
If Plugin Has Necessary Permissions
Add Administration Server Manually
Solve Managed Server Auto-Discovery Problems
How the Plugin Discovers Managed ServersÂ
Check if the Agent Can Access config.xml
Resolve Managed Server IP Address/FQDN Mismatch
Configuration Files Tracked by Default
Metrics
Weblogic 6.1 Application service
Weblogic 6.1 Entity EJB service
Weblogic 6.1 Execute Queue service
Weblogic 6.1 JDBC Connection Pool service
Weblogic 6.1 JMS Destination service
Weblogic 6.1 JMS Server service
Weblogic 6.1 JTA Resource service
Weblogic 6.1 Message Driven EJB service
Weblogic 6.1 server
Weblogic 6.1 Stateful EJB service
Weblogic 6.1 Stateless EJB service
Weblogic 6.1 Webapp service
Weblogic 7.0 Application service
Weblogic 7.0 Entity EJB service
Weblogic 7.0 Execute Queue service
Weblogic 7.0 JDBC Connection Pool service
Weblogic 7.0 JMS Destination service
Weblogic 7.0 JMS Server service
Weblogic 7.0 JTA Resource service
Weblogic 7.0 Message Driven EJB service
Weblogic 7.0 server
Weblogic 7.0 Stateful EJB service
Weblogic 7.0 Stateless EJB service
Weblogic 7.0 Webapp service
Weblogic 8.1 Application service
Weblogic 8.1 Entity EJB service
Weblogic 8.1 Execute Queue service
Weblogic 8.1 JDBC Connection Pool service
Weblogic 8.1 JMS Destination service
Weblogic 8.1 JMS Server service
Weblogic 8.1 JTA Resource service
Weblogic 8.1 Message Driven EJB service
Weblogic 8.1 server
Weblogic 8.1 Stateful EJB service
Weblogic 8.1 Stateless EJB service
Weblogic 8.1 Webapp service
Weblogic 9.1 Application service
Weblogic 9.1 Entity EJB service
Weblogic 9.1 Execute Queue service
Weblogic 9.1 JDBC Connection Pool service
Weblogic 9.1 JMS Destination service
Weblogic 9.1 JMS Server service
Weblogic 9.1 JTA Resource service
Weblogic 9.1 Message Driven EJB service
Weblogic 9.1 server
Weblogic 9.1 Stateful EJB service
Weblogic 9.1 Stateless EJB service
Weblogic 9.1 Webapp service
Weblogic 9.2 Application service
Weblogic 9.2 Entity EJB service
Weblogic 9.2 Execute Queue service
Weblogic 9.2 JDBC Connection Pool service
Weblogic 9.2 JMS Destination service
Weblogic 9.2 JMS Server service
Weblogic 9.2 JTA Resource service
Weblogic 9.2 Message Driven EJB service
Weblogic 9.2 server
Weblogic 9.2 Stateful EJB service
Weblogic 9.2 Stateless EJB service
Weblogic 9.2 Webapp service
Weblogic 10.0 Application service
Weblogic 10.0 Entity EJB service
Weblogic 10.0 Execute Queue service
Weblogic 10.0 JDBC Connection Pool service
Weblogic 10.0 JMS Destination service
Weblogic 10.0 JMS Server service
Weblogic 10.0 JTA Resource service
Weblogic 10.0 Message Driven EJB service
Weblogic 10.0 server
Weblogic 10.0 Stateful EJB service
Weblogic 10.0 Stateless EJB service
Weblogic 10.0 Webapp service
Weblogic 10.1 Application service
Weblogic 10.1 Entity EJB service
Weblogic 10.1 Execute Queue service
Weblogic 10.1 JDBC Connection Pool service
Weblogic 10.1 JMS Destination service
Weblogic 10.1 JMS Server service
Weblogic 10.1 JTA Resource service
Weblogic 10.1 Message Driven EJB service
Weblogic 10.1 server
Weblogic 10.1 Stateful EJB service
Weblogic 10.1 Stateless EJB service
Weblogic 10.1 Webapp service
Weblogic 10.2 Application service
Weblogic 10.2 Entity EJB service
Weblogic 10.2 Execute Queue service
Weblogic 10.2 JDBC Connection Pool service
Weblogic 10.2 JMS Destination service
Weblogic 10.2 JMS Server service
Weblogic 10.2 JTA Resource service
Weblogic 10.2 Message Driven EJB service
Weblogic 10.2 server
Weblogic 10.2 Stateful EJB service
Weblogic 10.2 Stateless EJB service
Weblogic 10.2 Webapp service
Weblogic 10.3 Application service
Weblogic 10.3 Entity EJB service
Weblogic 10.3 Stateless EJB service
Weblogic 10.3 Execute Queue service
Weblogic 10.3 JDBC Connection Pool service
Weblogic 10.3 JMS Destination service
Weblogic 10.3 JMS Server service
Weblogic 10.3 JTA Resource service
Weblogic 10.3 Message Driven EJB service
Weblogic 10.3 server
Weblogic 10.3 Stateful EJB service
Weblogic 10.3 Webapp service
Weblogic Admin 6.1 Application service
Weblogic Admin 6.1 Entity EJB service
Weblogic Admin 6.1 Execute Queue service
Weblogic Admin 6.1 JDBC Connection Pool service
Weblogic Admin 6.1 JMS Destination service
Weblogic Admin 6.1 JMS Server service
Weblogic Admin 6.1 JTA Resource service
Weblogic Admin 6.1 Message Driven EJB service
Weblogic Admin 6.1 server
Weblogic Admin 6.1 Stateful EJB service
Weblogic Admin 6.1 Stateless EJB service
Weblogic Admin 6.1 Webapp service
Weblogic Admin 7.0 Application service
Weblogic Admin 7.0 Entity EJB service
Weblogic Admin 7.0 Execute Queue service
Weblogic Admin 7.0 JDBC Connection Pool service
Weblogic Admin 7.0 JMS Destination service
Weblogic Admin 7.0 JMS Server service
Weblogic Admin 7.0 JTA Resource service
Weblogic Admin 7.0 Message Driven EJB service
Weblogic Admin 7.0 server
Weblogic Admin 7.0 Stateful EJB service
Weblogic Admin 7.0 Stateless EJB service
Weblogic Admin 7.0 Webapp service
Weblogic Admin 8.1 Application service
Weblogic Admin 8.1 Entity EJB service
Weblogic Admin 8.1 Execute Queue service
Weblogic Admin 8.1 JDBC Connection Pool service
Weblogic Admin 8.1 JMS Destination service
Weblogic Admin 8.1 JMS Server service
Weblogic Admin 8.1 JTA Resource service
Weblogic Admin 8.1 Message Driven EJB service
Weblogic Admin 8.1 server
Weblogic Admin 8.1 Stateful EJB service
Weblogic Admin 8.1 Stateless EJB service
Weblogic Admin 8.1 Webapp service
Weblogic Admin 9.1 Application service
Weblogic Admin 9.1 Entity EJB service
Weblogic Admin 9.1 Execute Queue service
Weblogic Admin 9.1 JDBC Connection Pool service
Weblogic Admin 9.1 JMS Destination service
Weblogic Admin 9.1 JMS Server service
Weblogic Admin 9.1 JTA Resource service
Weblogic Admin 9.1 Message Driven EJB service
Weblogic Admin 9.1 server
Weblogic Admin 9.1 Stateful EJB service
Weblogic Admin 9.1 Stateless EJB service
Weblogic Admin 9.1 Webapp service
Weblogic Admin 9.2 Application service
Weblogic Admin 9.2 Entity EJB service
Weblogic Admin 9.2 Execute Queue service
Weblogic Admin 9.2 JDBC Connection Pool service
Weblogic Admin 9.2 JMS Destination service
Weblogic Admin 9.2 JMS Server service
Weblogic Admin 9.2 JTA Resource service
Weblogic Admin 9.2 Message Driven EJB service
Weblogic Admin 9.2 server
Weblogic Admin 9.2 Stateful EJB service
Weblogic Admin 9.2 Stateless EJB service
Weblogic Admin 9.2 Webapp service
Weblogic Admin 10.0 Application service
Weblogic Admin 10.0 Entity EJB service
Weblogic Admin 10.0 Execute Queue service
Weblogic Admin 10.0 JDBC Connection Pool service
Weblogic Admin 10.0 JMS Destination service
Weblogic Admin 10.0 JMS Server service
Weblogic Admin 10.0 JTA Resource service
Weblogic Admin 10.0 Message Driven EJB service
Weblogic Admin 10.0 server
Weblogic Admin 10.0 Stateful EJB service
Weblogic Admin 10.0 Stateless EJB service
Weblogic Admin 10.0 Webapp service
Weblogic Admin 10.1 Application service
Weblogic Admin 10.1 Entity EJB service
Weblogic Admin 10.1 Execute Queue service
Weblogic Admin 10.1 JDBC Connection Pool service
Weblogic Admin 10.1 JMS Destination service
Weblogic Admin 10.1 JMS Server service
Weblogic Admin 10.1 JTA Resource service
Weblogic Admin 10.1 Message Driven EJB service
Weblogic Admin 10.1 server
Weblogic Admin 10.1 Stateful EJB service
Weblogic Admin 10.1 Stateless EJB service
Weblogic Admin 10.1 Webapp service
Weblogic Admin 10.2 Application service
Weblogic Admin 10.2 Entity EJB service
Weblogic Admin 10.2 Execute Queue service
Weblogic Admin 10.2 JDBC Connection Pool service
Weblogic Admin 10.2 JMS Destination service
Weblogic Admin 10.2 JMS Server service
Weblogic Admin 10.2 JTA Resource service
Weblogic Admin 10.2 Message Driven EJB service
Weblogic Admin 10.2 server
Weblogic Admin 10.2 Stateful EJB service
Weblogic Admin 10.2 Stateless EJB service
Weblogic Admin 10.2 Webapp service
Weblogic Admin 10.3 Application service
Weblogic Admin 10.3 Entity EJB service
Weblogic Admin 10.3 Execute Queue service
Weblogic Admin 10.3 JDBC Connection Pool service
Weblogic Admin 10.3 JMS Destination service
Weblogic Admin 10.3 JMS Server service
Weblogic Admin 10.3 JTA Resource service
Weblogic Admin 10.3 Message Driven EJB service
Weblogic Admin 10.3 server
Weblogic Admin 10.3 Stateful EJB service
Weblogic Admin 10.3 Stateless EJB service
Weblogic Admin 10.3 Webapp service
Weblogic NodeManager 6.1 server
Weblogic NodeManager 7.0 server
Weblogic NodeManager 8.1 server
Weblogic NodeManager 9.1 server
Weblogic NodeManager 9.2 server
Weblogic NodeManager 10.0 server
Weblogic NodeManager 10.1 server
Weblogic NodeManager 10.2 server
Weblogic NodeManager 10.3 server
WebSphere MQ
Configuration Requirements
Metrics
WebSphere MQ QManager 6 server
WebSphere MQ QManager 6 Process service
WebSphere MQ QManager 6 Local Queue service
WebSphere MQ QManager 6 Remote Queue service
WebSphere MQ QManager 6 Receiver Channel service
WebSphere MQ QManager 6 Sender Channel service
WebSphere MQ QManager 6 System Queue service
WebSphere MQ QManager 6 Channel service
WebSphere MQ QManager 6 Cluster service
WebSphere MQ QManager 6 Alias Queue service
WebSphere MQ QManager 7 server
WebSphere MQ QManager 7 Sender Channel service
WebSphere MQ QManager 7 Cluster service
WebSphere MQ QManager 7 Process service
WebSphere MQ QManager 7 Receiver Channel service
WebSphere MQ QManager 7 Local Queue service
WebSphere MQ QManager 7 Remote Queue service
WebSphere MQ QManager 7 System Queue service
WebSphere MQ QManager 7 Topic service
WebSphere MQ QManager 7 Channel service
WebSphere MQ QManager 7 Alias Queue service
vFabric Hyperic Monitoring and Management
About vFabric Hyperic Monitoring and Management
Intended Audience
Use and Tailor the Hyperic Dashboard
Introduction to the Hyperic Dashboard
Hyperic Dashboard
Portlet Quick Facts and Links
Tailor Dashboard
Using Multiple Dashboards in vFabric Hyperic
Auto-Discovery Portlet
Contents of the Auto-Discovery Portlet
Import or Skip Resources in Auto-Discovery Portlet
Configure the Number of Auto-Discoveries Displayed
Availability Summary Portlet
About the Availability Summary Portlet
Configure the Availability Summary Portlet
Control Actions Portlet
About the Control Actions Portlet
Configure the Control Actions Portlet
Favorite Resources Portlet
About the Favorite Resources Portlet
Select a Favorite Resource On the Fly
Configure Favorite Resources on the Dashboard
Group Alert Summary Portlet
About the Group Alerts Portlet
Configure the Group Alerts Portlet
Metric Viewer Portlet
About the Metric Viewer Portlet
Configure the Metric Viewer Portlet
Problem Resources Portlet
About the Problem Resources Portlet
Configure the Problem Resources Portlet
Recent Alerts Portlet
About the Recent Alerts Portlet
Configure the Recent Alerts Portlet
Saved Charts Portlet
About the Saved Charts Portlet
Add Chart to Saved Charts Portlet
Remove Chart from Saved Charts Portlet
Summary Counts Portlet
About the Summary Counts Portlet
Configure the Summary Counts Portlet
Monitor Resources in the Resource Tab
Browsing to Resources
List Resources by Inventory Type
List Resources by Resource Type
Filter Platforms, Servers, and Services by Group
Filter Resources by Name, Owner, and Availability
Indicators Minitab
Overview of Indicators Minitab
Availability Bar and Timeslices
Metric Charts in the Indicators Minitab
Event Icons and Popups
Resources Minitab
Metric Data Minitab
Metric Data Minitab
Metric Data Minitab for a Single Resource
Metric Data Minitab for an Autogroup or Compatible Group
Compare Metrics for Resources in a Compatible Group
View Metric Details and Metadata
Set Page Refresh Frequency
Tailor Metric Collection Settings for the Resource
Disable Collection of a Metric
Enable Collection of a Metric
Set Collection Interval for a Metric
Configure Metric Baselines
Resources Minitab
Resources Minitab
Resources Minitab
Resource Lists in the Resources Minitab
Availability Icons in the Resources Minitab
Availability Details in the Resources Minitab
Metric Summaries in the Resources Minitab
View Metric Data for Related Resources in the Resources Minitab
Use Controls and Popup Options in the Resources Minitab
Filter Metrics by Category and Value Type
Metric Display Range
Default Metric Display Range
Select a Number of Minutes, Hours, or Days
Advanced Settings for Metric Display Range
Charting Metric Data
Charting Metric Data
Chart Types - What They Are and How to View Them
How a Chart is Constructed
Read a Full Page Chart
Contents of a Full Page Chart
Observed Measurements
Peak, Average, and Low Values
Baseline and Acceptable High and Low Values
Participating Resources
Metric Baseline and Expected Range
Filter Chart Data
Change Metric Display Range
Save Chart to Dashboard
Save the Chart in CSV Foromat
Tools Menu
Map Control
Overview of the Map Control
Resource Map for a Platform
Resource Map for a Server
Resource Map for a Service
Resource Map for a Compatible Group
Metric Extrapolation View for Groups
Extrapolating Metrics for a Group
Understanding Extrapolation Charts
Global Management Views
Alert Center
View Alerts In the Alert Center
Filter Alert List
Fix or Acknowledge an Alert in the Alert Center
View Alert Definitions In the Alert Center
Filter Alert Definition List
Event Center
Event Center
Filter the Event List
Contents of the Event Center Page
Currently Down
Currently Down Resources
Contents of the Currently Down Page
Filter Resources of the Currently Down Page
Operations Center
Filter by Problem Type and Resource
Set Table Controls
Contents of Operations Center Page
Current Filter Totals
Resource Details for All Hosts
Nagios Availability
View Nagios Resources and Metrics in Hyperic
View Nagios Service Detail
View a Nagios Check
Report Center
Report Center Overview
Navigate to the Report Center
Built-In Reports
Custom Reports
Specifying Report Description and Report Parameters
Actionable Reports
Views for Specific Resource Types
GemFire View
GemFire View for a DS
GemFire View for a Cache Server or Application Peer
GemFire View for a Gateway Hub
HQ vSphere View
About the HQ vSphere Page
Display the HQ vSphere Page
HQ vSphere and Resource Permissions
HQ vSphere Inventory Tab
HQ vSphere Summary Tab
Summary Tab for vCenter
Summary Tab for vSphere Hosts
Summary Tab for vSphere VM
Summary Tab for a Managed Resource in the VM
HQ vSphere Performance Tab
View Metrics
Correlate Metrics
HQ vSphere Control Tab
Metrics
VMware vSphere Host Metrics
VMware vSphere VM Metrics
tc Server Application Management View
tc Runtime Application Management
Navigating to a tc Runtime Instance Or Group
Creating tc Runtime Groups
Listing Applications
Deploying Applications
Undeploying Applications
Starting Applications
Stopping Applications
Reloading Applications
Agent Control View
Restart an Agent or a Group of Agents
Ping an Agent or a Group of Agents
Upgrade an Agent or Group of Agents to a Newer Version
Push a Plugin to an Agent or Group of Agents
Spring Insight View
Spring Insight Applications
Understanding Application Metrics
Application Health
Application Vitals
Unfixed Alert Count
Error Rate
Response Time Levels
Contents of the Spring Insight Applications Page
Dashboards Tab
Health Tab for all Applications
Performance Tab for a Dashboard
Application Server Performance
Platform Performance
Performance Tab for an Application
Data Service Performance
Jump to Insight Operations
Run Live System and Metric Queries
JMX MBean Query for JVMs
Using JMX MBean Query
Entering Query Options
Enabling Automatic Refresh
Defining Saved Mbean Searches
Schema for JMX Search Criteria
Run Live Exec Queries
Live Exec Commands
Run Live Exec on a Platform or Group of Platforms
Use Resource Control Actions
Run Resource Control Actions
Overview of Running Control Actions
Run a Built-in Control Action
Select and Run a Custom Control Action
Select from a List of All Custom Control Actions
Select from a List Custom Control Actions for a Platform
Run Custom Control Action
Schedule a Control Action
View Control Action Status and History
View Recently Performed Control Actions
About the Control Actions Portlet
Configure the Control Actions Portlet
View Control History for a Resource
View Alerts and Update Alert Status
List Recent Alerts
List Alerts for a Resource
View Alerts Across All Resources
Monitor Unfixed Alerts
View Alert Detail
Acknowledge or Fix an Alert
vFabric Hyperic Web Services API
About vFabric Hyperic Web Services API
Intended Audience
Introduction to HQApi
Overview of HQApi
Version Compatibility
What HQApi is Good For
User Permissions and HQApi
How to Access HQApi
How to Install HQApi
API Package Contents
HQApi Command-Line Tools
Command-Line Tools Overview
Invoking Command-Line Tools
Common Subcommands
list
sync
delete
Required Command Qualifiers and How to Supply Them
Define a Connection Properties File
Encrypt Hyperic Password
Supply Properties File Path on Command Line
Tips and Reminders for CLI Tools
Sync with Caution
How to Find a Resource ID
HQApi agent command
agent Functionality
agent Command Options
agent list
Structure of an AgentsResponse Element
Content of an Agent Element
agent list Command Qualifiers
agent list Example
agent ping
agent ping Command Qualifiers
agent ping examples
agent transferPlugin
agent transferPlugin Command Qualifiers
agent transferPlugin Examples
agent bundle-list
Structure of an AgentBundleFilesResponse Element
Content of an AgentBundleFile Element
agent bundle-list Command Qualifiers
agent bundle-list Example
agent bundle-status
agent bundle-status Command Qualifiers
agent bundle-status example
bundle-push
agent bundle-push Command Qualifiers
agent bundle-push example
HQApi alertdefinition command
alertdefinition Functionality
Understanding Alert Definition Options
alertdefinition Command Options
alertdefinition list
alertdefinition list Command Qualifiers
Structure of an AlertDefinitionsResponse
Attributes in an AlertDefinitionsResponse
AlertCondition Attributes for Different Condition Types
AlertActionConfig Attributes for Different Action Types
alertdefinition sync
alertdefinition sync Command Qualifiers
alertdefinition delete
alertdefinition create
alertdefinition create Command Qualifiers
alertdefinition Command Examples
alertdefinition list
alertdefinition list --typeAlerts
AlertCondition Examples
alertdefinition sync
alertdefinition delete
alertdefinition create - based on existing alert definition
alertdefinition create - new alert definition
HQApi alert command
Functionality
alert Command Options
alert list
Structure of an AlertsResponse Element
Attributes in an AlertsResponse
List Examples
List Last n Alerts
List Last n Alerts in Escalation
List Last n Unfixed Alerts
List Alerts that Fired During an Interval
List Unfixed Alerts with Severity Level
alert ack
alert fix
alert delete
HQApi application command
Functionality
application Command Options
application list
Structure of an ApplicationResponse
Attributes in an ApplicationResponse
Example - application list
application sync
Example - Create Applications with application sync
Example - Update Applications with application sync
application delete
HQApi autodiscovery command
Functionality
autodiscovery Command Options
autodiscovery list
autodiscovery list Command Qualifiers
Structure of a QueueResponse
Attributes in a QueueResponse
autodiscovery approve
autodiscovery approve Command Qualifiers
Examples
autodiscovery list
autodiscovery approve
autodiscovery approve with Regex Qualifier
HQApi control command
Functionality
control Command Options
control actions
control history
control execute
control Command Examples
control actions --resourceId
control history --resourceId
control execute --action --resourceId
control execute --action --resourceId – option
HQApi dependency command
dependency Functionality
dependency Command Options
dependency list
dependency list Command Qualifiers
Structure of ResourcesResponse
Atributes of ResourcesResponse
Structure of ResourceEdgesResponse element
dependency list Examples
dependency list
dependency list --prototype
Dependency List --name
dependency list --prototype --name
dependency list --children --id
dependency list --children --prototype
dependency list --children --name
dependency list --children --prototype --name
Dependency List --children --id --relation=containment
dependency sync
dependency sync Command Qualifiers
dependency delete
dependency delete Command Qualifiers
dependency select
dependency select Command Qualifiers
HQApi escalation command
Functionality
escalation Command Options
escalation list
escalation list Command Qualifiers
Structure of an EscalationsResponse
Attributes in an EscalationsResponse
escalation sync
Examples
escalation list
escalation sync
HQApi event command
Functionality
event Command Options
event list
Structure of an EventsResponse
Attributes in an EventResponse Element
event Command Examples
event list --resourceId
event list
Example Event Element for Different Event Types
Event Element for an Alert Event
Event Element for an Control Action Event
Event Element for an Log Event
Event Element for an Configuration Event
HQApi groovyshell command
groovshell Functionality
groovyshell Command Qualifiers
HQApi group command
Functionality
group Command Options
group list
group list Command Qualifiers
Structure of a GroupsResponse
Attributes in a GroupsResponse
group sync
group sync Command Qualifiers
group delete
group delete Command Qualifiers
Examples
group list
group delete
group sync via XML
group sync - Create or Update a Compatible Group from Command Line
group sync - Create or Update a Mixed Group from Command Line
HQApi maintenance command
Functionality
maintenance Command Options
maintenance schedule
maintenance unschedule
maintenance get
Examples
maintenance schedule
maintenance get
maintenance unschedule
Sample Script for Scheduling Recurring Maintenance
Using group_maintenance_api.pl
Set Environment Variables
Schedule Maintenance for a Group
Check Maintenance Schedule
Cancel a Maintenance Schedule
Set Up a Recurring Maintenance Schedule
Use Time Only for Start and End Arguments
Tip - Wrap the Script Invocation
HQApi metric command
Functionality
metric Command Options
metric list
Metric list Command Qualifiers
Structure of a MetricsResponse
Attributes in a MetricsResponse
metric sync
metric reschedule
Examples
metric list
metric sync
metric reschedule
HQApi metricData command
Functionality
Command Options
list
list Command Output
list Command Qualifiers
Examples
List Measurements for a Metric
List Measurements for a Resource
List Measurements for a Compatible Group
HQApi metricTemplate command
Functionality
metricTemplate Command Options
metricTemplate list
metricTemplate list Command Qualifiers
Structure of a metricTemplatesResponse
Attributes in a MetricTemplatesResponse
metricTemplate sync
Examples
metricTemplate list
metricTemplate sync
HQApi resource command
Functionality
resource Command Options
resource list
resource list Command Qualifiers
Structure of a ResourcesResponse
Attributes in an ResourcesResponse
resource sync
resource delete
resource createPlatform
resource createPlatform Command Qualifiers
resource createServer
resource createServer Command Qualifiers
resource createService
resource createService Command Qualifiers
resource move
resource move Command Qualifiers
Examples
List Resources of the Same Type
List Resources of the Same Type Verbosely
Write Resource Data to a File
Update Resource Properties
Delete a Resource
Create a New Platform
Create a New Server
Create a New Service
HQApi resourceprototype command
Functionality
resourceprototype Command Options
resourceprototype list
Attributes in an ResourcePrototype Element
resourceprototype Command Examples
resourceprototype list --existing
HQApi role command
Functionality
Command Options
list
list Command Output
list Command Qualifiers
sync
Samples
role list
role sync
Understanding Role Permissions
Operations List
HQApi serverConfig command
Functionality
serverConfig Command Options
serverConfig get
Structure of a ServerConfigResponse Element
Attributes in an ServerConfigResponse
Example - serverConfig get
Example - Write Results of serverConfig get to a file
serverConfig set
serverConfig getParameter
serverConfig setParameter
Server Configuration Reference
Hyperic Email Configuration Properties
Data Manager Configuration Properties
Global Alert Properties
Notification Throttling Configuration Properties
Automatic Baseline Configuration Properties
LDAP Configuration Properties
Kerberos Configuration Properties
SNMP Properties
Configure HQ Server for SNMP v1
Configure HQ Server for SNMP v2c
Configure HQ Server for SNMP v3
Server Configuration Reference
Hyperic Email Configuration Properties
Data Manager Configuration Properties
Global Alert Properties
Notification Throttling Configuration Properties
Automatic Baseline Configuration Properties
LDAP Configuration Properties
Kerberos Configuration Properties
SNMP Properties
Configure HQ Server for SNMP v1
Configure HQ Server for SNMP v2c
Configure HQ Server for SNMP v3
HQApi user command
Functionality
Command Options
list
list command output
list Command Qualifiers
sync
Examples
user list
user sync
HQApi Java API
vFabric Hyperic User Interface
About vFabric Hyperic User Interface
Intended Audience
ui-Dashboard
Hyperic Dashboard
Portlet Quick Facts and Links
Tailor Dashboard
Using Multiple Dashboards in vFabric Hyperic
ui-Login
Hyperic Dashboard
HQ Dashboard Settings: Add Resources
Tasks Available on This Screen
ui-Dashboard.Alerts
About the Recent Alerts Portlet
Configure the Recent Alerts Portlet
ui-Dashboard.Availability
About the Availability Summary Portlet
Configure the Availability Summary Portlet
ui-Dashboard.AutoDiscovery
Contents of the Auto-Discovery Portlet
Import or Skip Resources in Auto-Discovery Portlet
Configure the Number of Auto-Discoveries Displayed
ui-Dashboard.Charts
About the Saved Charts Portlet
Add Chart to Saved Charts Portlet
Remove Chart from Saved Charts Portlet
ui-Dashboard.Control
About the Control Actions Portlet
Configure the Control Actions Portlet
ui-Dashboard.FavoriteResources
About the Favorite Resources Portlet
Select a Favorite Resource On the Fly
Configure Favorite Resources on the Dashboard
Group Alerts Summary Portlet
About the Group Alerts Portlet
Configure the Group Alerts Portlet
ui-Dashboard.Metric
About the Metric Viewer Portlet
Configure the Metric Viewer Portlet
ui-Dashboard.ProblemResources
About the Problem Resources Portlet
Configure the Problem Resources Portlet
ui-Dashboard.RecentlyAdded
About the Recently Added Portlet
Configure the Recently Added Portlet
ui-Dashboard.Summary
About the Summary Counts Portlet
Configure the Summary Counts Portlet
ui-Resources
Resources Browse
About the Browse Page
Filter the Resource List
Navigation and View Options
Switch Between Chart and List View
Navigate to a Resource
About Breadcrumb Links
Create a Platform
Create an Application
Create a New Group
Select and Add Platforms, Servers, or Services to a New or Existing Group
Create a New Group of Groups
Delete a Resource
Enable or Disable Alert Definitions
ui-Monitor
ui-Monitor.CurrentHealth
Overview of Indicators Minitab
Availability Bar and Timeslices
Metric Charts in the Indicators Minitab
Event Icons and Popups
Resources Minitab
ui-Monitor.CurrentHealth.Chart
Metric Chart
For Single Resources
Sections on This Screen
Metric Chart
Participating Resource
Metric Baseline and Expected Range
Reading a Chart
Time Slices
Display of Dynamic Data vs. Static Data
Display of Cumulative Data
ui-Monitor.CurrentHealth.Metrics
Metric Data Minitab
Metric Data Minitab for a Single Resource
Metric Data Minitab for an Autogroup or Compatible Group
Compare Metrics for Resources in a Compatible Group
View Metric Details and Metadata
Set Page Refresh Frequency
Tailor Metric Collection Settings for the Resource
Disable Collection of a Metric
Enable Collection of a Metric
Set Collection Interval for a Metric
Configure Metric Baselines
Resources Minitab
ui-Monitor.Group.Compare
Compare Metrics for Resources in a Compatible Group
Select Metrics to Compare
Contents of the Compare Groups Page
ui-Monitor.Group.Extrapolate
Extrapolating Metrics for a Group
Understanding Extrapolation Charts
ui-Monitor.Server.MbeanBrowser
Using JMX MBean Query
Entering Query Options
Enabling Automatic Refresh
Defining Saved Mbean Searches
Schema for JMX Search Criteria
Edit Display Range
ui-Alert
ui-Alert.Script
Define a Script Action for an Alert
Environment Variables for Fired Alert Data
Example Script
Assign the Script Action to an Alert
ui-Alert.Edit
Edit Alert Properties
Edit Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Create or Edit Alert Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
ui-Alert.ControlAction
Configure a Control Action as an Alert Action
ui-Alert.ListTypeDefinition
List Alert Definitions for a Resource Type
Create a Resource Type Alert Definition
Enable or Disable a Resource Type Alert Definition
Edit a Resource Type Alert Definition
Delete Resource Type Alert Definition
ui-Alert.Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
ui-Alert.Condition
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Edit Alert Add Notification
Notify Roles *
Notify HQ Users
Notify Other Recipients
ui-Alert.Detail
Alert Detail Page
View Alert Detail
Mark Alert Fixed
Acknowledge Alert
Go to the Alert Definition Page
Go to the Resource's Indicators Page
ui-Alert.List
Alert List for a Resource
View Alerts and Status for a Different day
Mark One or More Alert Fixed
Acknowledge Alert with Escalation
View and Update Alert Definitions for the Resource
ui-Alert.New
Navigate to the New Alert Definition Page
Define Alert Properties
Define Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Save the Alert Definition
Define Alert Actions
ui-Alert.ListDefinition
Display a List of Alert Definitions
Create an Alert Definition for a Resource
Enable or Disable a Resource Alert Definition
Edit a Resource Alert Definition
Delete a Resource Alert Definition
ui-Alert.Properties
ui-Control
Managing Control Actions
Run a Control Action on Demand
Schedule a Control Action
Edit a Scheduled Control Action
Delete a Scheduled Control Action
Sections on This Screen
Current Status
Quick Control
Control Action Schedule
Editing a Scheduled Control Action
ui-Control.History
Scheduling Control Actions
ui-Views
Views Tab for a Resource
ui-SpringInsight
Spring Insight Applications
Understanding Application Metrics
Application Health
Application Vitals
Unfixed Alert Count
Error Rate
Response Time Levels
Contents of the Spring Insight Applications Page
Dashboards Tab
Health Tab for all Applications
Performance Tab for a Dashboard
Application Server Performance
Platform Performance
Performance Tab for an Application
Data Service Performance
Jump to Insight Operations
ui-tcserver.ServerConfiguration
tc Runtime Configuration
Navigating tc Runtime Configuration Pages
Saving or Undoing Changes
User Permissions Required to Use the tc Runtime Features
Configuring General tc Runtime Options
Configuring Startup Options
Configuring the Context Container
Configuring JSP Options
Configuring Static Content Defaults
Using the Advanced Server Configuration Options
Reloading Settings From Server
Reverting to a Previously Saved Configuration
Uploading a Configuration File
Configuring and Creating JDBC Data Sources
Configuring and Creating tc Runtime Services
Configuring and Creating Connectors
Configuring and Creating Virtual Hosts
Configuring tc Runtime Logging
ui-tcserver.ServerConfigurationRef
tc Runtime Configuration Reference
General Configuration
Server Properties
JMX Listener
Server Start Configuration
General
Sun Specific JVM Options
Advanced
Context Container
Static Resource Cache
Web Application Logger
Server Defaults - JSP
Server Defaults - Static Content
ui-tcserver.ApplicationManagement
tc Runtime Application Management
Navigating to a tc Runtime Instance Or Group
Creating tc Runtime Groups
Listing Applications
Deploying Applications
Undeploying Applications
Starting Applications
Stopping Applications
Reloading Applications
ui-tcserver.ServerServicesRef
tc Runtime Services Reference
General Service Properties
Connector Properties
General
Security/SSL
APR SSL Settings
Engine Properties
Thread Diagnostics
Host Properties
HTTP Access Logging
ui-tcserver.ServerJDBCRef
tc Runtime JDBC Reference
General Properties
Connection Properties
Tomcat/DBCP Connection Pool Properties
ui-vSphere
About the HQ vSphere Page
Display the HQ vSphere Page
HQ vSphere and Resource Permissions
HQ vSphere Inventory Tab
HQ vSphere Summary Tab
Summary Tab for vCenter
Summary Tab for vSphere Hosts
Summary Tab for vSphere VM
Summary Tab for a Managed Resource in the VM
HQ vSphere Performance Tab
View Metrics
Correlate Metrics
HQ vSphere Control Tab
Metrics
VMware vSphere Host Metrics
VMware vSphere VM Metrics
ui-LiveExec
Live Exec Commands
Run Live Exec on a Platform or Group of Platforms
ui-Views.AgentCommands
Restart an Agent or a Group of Agents
Ping an Agent or a Group of Agents
Upgrade an Agent or Group of Agents to a Newer Version
Push a Plugin to an Agent or Group of Agents
ui-Views.GemFire
GemFire View for a DS
GemFire View for a Cache Server or Application Peer
GemFire View for a Gateway Hub
ui-CurrentlyDown
Currently Down Resources
Contents of the Currently Down Page
Filter Resources of the Currently Down Page
View Nagios Resources and Metrics in Hyperic
View Nagios Service Detail
View a Nagios Check
ui-Inventory
ui-Inventory.Server
Inventory Page for a Server
Inventory Page Header for a Server
Resource Properties
Map Control for a Server
Tools Menu for a Server
General Properties for a Server
Type and Host Properties
Services on a Server
Groups Containing a Server
Configuration Properties for a Server
ui-Inventory.Server.New
When to Create a Server Manually
Create a Server
Inventory Page for a New Server
Configure Server for Monitoring
Edit a Server's Type and Host Properties
ui-Inventory.Service
Inventory Page for a Service
Inventory Page Header for a Service
Resource Properties
Map Control for a Service
Tools Menu for a Service
General Properties for a Service
Groups Containing a Service
Configuration Properties for a Service
Inventory Page - Service
ui-Inventory.Service.New
Learn About Platform Services
Configure a Platform Service
Platform Service Types
Inventory Tab - Server
ui-Inventory.Owner
ui-Inventory.GeneralProperties
ui-Inventory.Configuration
Navigate to the Configuration Properties Page
Configure Shared Properties
Configure Monitoring Properties - Log Tracking
Configure Monitoring Properties - Configuration Tracking
Configure Control Properties
Configure Alert Definitions Based on Events
ui-Inventory.Platform
Navigate to the Inventory Page for a Platform
Inventory Page Header
Resource Properties
Map Control for a Platform
Tools Menu for a Platform
General Properties for a Platform
Type and Network Properties for a Platform
Servers on a Platform
Services on a Platform
Groups Containing a Platform
Configuration Properties for a Platform
ui-Inventory.Platform.AutoDiscovery
ui-Inventory.Platform.New
When to Create a Platform Manually
Add a Platform to Inventory from the Hyperic User Interface
Edit a Platform's Type and Network Properties
ui-Inventory.Platform.Clone
Cloning a Platform
How to Clone a Platform
What Cloning is Good For
What Cloning Does
What Cloning Does Not Do
Inventory Tab - Platform
ui-Inventory.AutoDiscovery
ui-Inventory.AutoDiscovery.Results
Contents of the Auto-Discovery Results Page
Import or Skip Resources in Auto-Discovery Results Page
ui-Inventory.Application
Inventory Page for an Application
Inventory Page Header for an Application
Resource Properties
Tools Menu for an Application
General Properties for an Application
Application Properties
Service Counts for an Application
Services in an Application
Groups Containing an Application
Group Manager
Create an Application
Add Services to an Application
Edit Application Properties
ui-Inventory.Application.SvcDep
ui-Inventory.Group
Navigate to the Inventory Page for a Group
Inventory Page Header for a Group
Resource Properties for a Group
Map Control for a Compatible Group
Tools Menu for a Group
General Properties for a Group
Resources
Roles a Group is Assigned To
Create a Group
ui-Inventory.AssignRolesToGroups
Assign Roles to a Group
Adding the Current Resource to a Group
Tasks Available on This Screen
Assign Resource Groups
ui-Analyze
ui-Event.Center
Event Center
Filter the Event List
Contents of the Event Center Page
ui-Alert.Center
View Alerts In the Alert Center
Filter Alert List
Fix or Acknowledge an Alert in the Alert Center
View Alert Definitions In the Alert Center
Filter Alert Definition List
ui-Operations.Center
Filter by Problem Type and Resource
Set Table Controls
Contents of Operations Center Page
Current Filter Totals
Resource Details for All Hosts
ui-Report.Center
Navigate to the Report Center.
Run a Report
View a Report
ui-Admin
Administration Page
Authentication/Authorization
HQ Server Settings
Plugins
HQ License Information
ui-Admin.HQServer
HQ Email Configuration Properties
HQ Announcement Properties
Data Manager Properties
Global Alert Properties
Notification Throttling Configuration Properties
Automatic Baseline Configuration Properties
LDAP Configuration Properties
LDAP Authentication in vFabric Hyperic
Configure LDAP Authentication and Role Assignment
Kerberos Configuration Properties
SNMP Server Configuration Properties
Configure HQ Server for SNMP v1
Configure HQ Server for SNMP v2c
Configure HQ Server for SNMP v3
Groovy Console
ui-tcserverclient
HQ API
ui-Admin.Dependency
Define Network Host Relationships
Step 1 - Select a Top Level Platform to Update
Option A - Browse a Filtered List of Top Level Platforms
Option B - Navigate from a Dependent Platform
Step 2 - Manage a Top Level Platform's Dependents
ui-Admin.User
ui-Admin.User.AssignRole
ui-Admin.User.Edit
ui-Admin.User.List
ui-Admin.User.New
ui-Admin.User.Password
ui-Admin.Role
Properties Section
Permissions Section
Assigned Users
Assigned Groups
Alert Calendar
ui-Admin.Role.AssignUser
ui-Admin.Role.Groups
ui-Admin.Role.List
ui-Admin.Role.New
ui-Admin.Role.Permissions
About Permission Levels
Permission Tips
How HQ Validates Platform-Server-Service Permission Level Assignments
ui-HQHealth
HQ Health
Key Statistics
Diagnostics Tab
Cache Tab
Load Tab
Database Tab
Agents Tab
Maintenance Tab
Inventory Summary Tab
ui-Admin.Escalation
Create an Escalation
Step 1 - Create New Escalation Scheme
Step 2 - Create Escalation Actions
Create an Email or SMS Action
Create a Sys Log Action
Create an SNMP Notification Action
Create a Suppress Alerts Action
View an Escalation
Edit an Escalation
Delete an Escalation
Escalations
ui-Admin.Monitor
Monitoring Defaults Page
What's on the Monitoring Defaults Page
Navigate to Monitoring Configuration and Resource Lists
ui-Admin.Monitor.NewResourceTypeAlert
Define a Resource Type Alert
Step 1 - Select Target Resource Type
Step 2 - Define Alert Properties
Step 3 - Define Alert Condition Set
Condition Set
Define Additional Conditions
Define Recovery Alert Behavior
Enable Actions
Enable Action Filters
Disable an Alert Definition upon Firing
Disregard Control Actions for Related Alerts.
Step 4 - Define Alert Actions
Escalation
Control Action
Notify Roles
Notify HQ Users
Notify Other Recipients
Script
OpenNMS
SNMP Notification
ui-Admin.Monitor.MetricTemplate
Navigate to the Monitoring Defaults Page for a Resource Type
Enable Collection of a Metric
Disable Collection of a Metric
Change a Metric Collection Interval
Set Indicator Metrics
APIs for Metric Collection Settings
ui-Administration.Plugin.Manager
About Plugin Manager
View the Plugin Manager Page
Contents of the Plugin Manager Page
Determine Why an Agent is not Synchronizing
View Agent Sync Detail for a Plugin
Upload a Plugin
Remove Plugins
Troubleshooting
vFabric Hyperic Product Plug-in Development
About vFabric Hyperic Product Plug-in Development
Intended Audience
Introduction to Plugin Management Functions
Auto-Discovery Overview
Using Auto-Discovery Support Classes in Plugins
Auto-Discovery Class Hierarchy
Overview of Auto-Discovery Classes
Auto-Discovery Interfaces
How to Specify Auto-Discovery Implementation for a Resource Type
How to Supply Parameters for Auto-Discovery Implementation
Dynamic Service Type Detection
Introduction to Dynamic Service Type Detection
Implement discoverServiceTypes method
Using ServiceTypeInfo
Using ServiceType
Handle service settings
Custom properties
Properties
Plugins
Control actions
Measurements
Measurement Plugin
Measurement Plugins
Writing the XML Descriptor
Measurement Support Classes
Specify Measurement Plugin in Plugin Descriptor
Defining Measurements with the metric Tag
Using Templates to Collect Metric Data
Using Support Classes to Simplify Metric Collection
Using a Filter to Efficiently Apply a Template to Metrics
Getting Your Plugin to Auto-Discover Resources
Introduction to Plugin Development
Plugin Development Center
What Plugins Do
What Role the Server and Agent Play in Plugins
Technical Overview
Plugin Implementations
Using Support Classes to Simplify Your Plugin
Writing a Plugin
Testing Your Plugin
Deploying Your Plugin
Writing Plugins
JMX Plugin
Discovering Custom Properties
Implementing Log and Config Tracking
Example Custom MBean Plugins
tomcat-string-cache-plugin.xml
tomcat-webapp-cache-plugin.xml
SQL Query Plugin
SQL Query Plugin
Custom SQL Query Plugins
JDBC Drivers
Support Classes
Write a SQL Query Plugin
Step 1 - Create Plugin Descriptor File
Step 2 - Create Root plugin Element
Step 3 - Define service Element
Step 4 - Define config Element
Step 5 - Define metric Elements
Metric Template Format for SQL Query Plugins
Hard-Code the metric Elements
Parameterize metric Attributes
Step 6 - Review Complete Descriptor
Test Plugin
Deploy Plugin
Use the Deployed Plugin
Script Plugins
Facts About Script Plugins
What is a Script Plugin?
Script Plugin Contents and Packaging
Requirements for Script
How to Define the Proxy Resources in Plugin Descriptor
How to Define Management Functions
Auto-Discovery
Measurement
Control
Other Properties to Define
Script Plugin Examples
Control Script Example
iostat
iostat Tutorial
Command Line Test
Create an I/O Device service
I/O Device plugin sources
How often are my scripts executed?
samba
sendmail Plugin Descriptor
Write an SNMP Plugin
Writing an SNMP Plugin
Getting Started
Iteration 1 - A Very Basic Plug-in
Iteration 2 - Additional Platform Metrics
Iteration 3 - Pulling in Network Interfaces as Platform Services
Iteration 4 - Collecting Network Interface Service Metrics
Iteration 5 - Adding Auto-Discovery Components for the Platform
The Final Product
Additional SNMP Plugin Examples
Resources
JMX-Based Management with Hyperic
Introduction
JMX Resources an the Hyperic Inventory Model
Auto-Discovery of JMX Resources
Identify Target MBeans and Attributes
Configuration Properties Required for JMX Monitoring
Create a Custom JMX Plugin
Defining Service Types to Provide Management via Custom MBeans
Defining an ObjectName to Access Custom MBeans
Defining Configuration Properties to Be Displayed in the UI
Defining and Gathering Metrics
Specifying Availability Metric for MBeans
Implementing Control Actions
Define Server Auto-Inventory Element
Discovering Custom Properties
Implementing Log and Config Tracking
Example Custom MBean Plugins
Running and Testing Plugins from Command Line
Invoking Plugins from the Command Line
hq-pdk.jar Command Syntax
-m method specifies the method to run
-p PluginName specifies the plugin to run
-t ResourceType specifies the target resource type
-a MethodAction specifies a method argument
-DOption sets a property value
Generating and Using Resource Properties Files
Resource Properties Files
Names and Location of Properties Files
Content of Properties Files
Inherited Resource Properties
Properties for Controlling Agent Behavior and Plugin Execution
hq-pdk.jar Methods and Functionality
lifecyle - Initialize and Check Syntax
Example Results of lifecycle Method on a Plugin with No Errors
Example Results of lifecycle Method on a Plugin with Errors
discover - Auto-Discover Resources and Configuration
metric - Fetch Metrics
Syntax for metric Method Using Resource Properties File
Syntax for metric Method Specifying Configuration Data on Command Line
Example Invocations
Results returned by -metric method default action
Results returned by metric method translate action
track - Watch for Log or Configuration Events
Examples
control - Perform a Control Action on a Resource
Examples
livedata - Fetch Live System Information
Results of cpu Command
cpuperc Command Results
ifconfig Command Results
who Command Results
generate - Create Plugin Documentation
Syntax
Running Protocol Checks from Command Line
Deploy Plugin
Plugin Descriptors
Key Facts About HQ Plugin Descriptors
Descriptor Defines Resource Types, Management Functions, and Metrics
Managed Resource Type Hierarchy
Management Functions and Classes for each Resource Type
Inventory and Configuration Data for Each Resource Type
Metrics to Collect for Each Resource Type
Resource Hierarchy is the Skeleton of a Descriptor
A Functional View of Common Plugin Descriptor Elements
First Facts About Metric Templates
Inheritance and Reuse in Plugin Descriptors
Every Plugin Requires a Version Property
A Graphical View of Descriptor Elements and Functions
Plugin Descriptor Tips and Techniques
Understanding Metric Templates
Introduction to Metric Templates
Anatomy of a Metric Template
What a Metric Template Looks Like
Where the Data for a Metric Template Comes From
How a Metric's template Attribute is Specified
Learn More About Variables in Plugin Descriptors
Metric Template Rules for Each Collection Method
Variables in Plugin Descriptors
Variables Simplify Metric Template
Configuration Option Variables
Metric Attribute Variables
Resource Property Variables
Convenience Variables
Variables and Global Configs
configname.config Returns Option Name Value Pairs
configname.template Includes Domain for Metric Template
JMX Metric Templates
Components of the Template for a JMX Metric
template Attribute for a JMX Metric
Example Definition of JMX Metric Template
Using Global Configuration Schemas
Globally Available Resource Configurations
Include a Global Configuration Schema by Reference
Variables for Returning Formatted Config Schemas
Including a Descriptor in Another
Overriding the Value of a Resource property at Platform Level
Plugin Descriptor Element and Attribute Reference
actions
Element Overview
Parent Elements
Child Elements and Attributes
Examples
Specifying actions in the include attribute
Specifying actions in the include element
Limiting actions to a platform type
classpath
Element Overview
Parent Elements
Child Elements and Attributes
Examples
classpath specifies path to JDBC drivers
classpath specifies path to a JMX library
classpath specifies path to another plugin JAR file
classpath specifies path to multiple vendor jars
classpath specifies jars in HQ Server installation
config
Element Overview
Parent Elements
Child Elements and Attributes
Examples
config element defines a globally available configuration schema
config elements define and reference a globally available configuration schema
config element references a globally available configuration schema
config element includes two schemas by reference
filter
Element Overview
Parent Elements
Child Elements and Attributes
Examples
filter defines metric template components using configuration and metric alias
filter defines metric template using a values supplied by a property and a metric alias attribute
filter references globally available configuration schema
filter uses value of config option to provide domain portion of metric template
help
Element Overview
Parentage
Contents
Examples
help element defines a named block of HTML
help element defines help for a service type explicitly and by reference with append attribute
help element defines help for a service type by reference with append and include attributes
help element references a named block of HTML, by virtue of element location
help element references two named blocks of HTML using include and append attributes
include
Element Overview
Parentage
metric
Element Overview
Parentage
Contents
name
alias
category
units
indicator
collectionType
defaultOn
interval
group
rate
query
template
Examples
template for a metric obtained via a vendor API
template for metric obtained with network collector
template for metric obtained with SIGAR
template for metric obtained with JDBC
template for metric obtained with SQL Query
template for metric obtained with JMX
template for metric obtained with script
template for metric obtained with SNMP, constructed with globally available config
Metric Parameters
Plugin UOM
metrics
Element Structure
Parentage
Contents
Examples
unnamed metrics element within a service element
metrics element defined
metrics element is referenced using include attribute
metrics elements included using include element
metrics element includes several metric groups, plus a metric definition
metrics name matches resource's Name Attribute string
option
Element Overview
Parent Elements
Child Elements and Attributes
option Examples
option element defines selector list values
option element for an optional option
option element defines default value
platform
Element Overview
Parent Elements
platform Element Structure
Child Elements
platform Examples
Structure of a simple platform element
Simple platform element in full
plugin - Platform, Server and Service
Element Overview
Parent Elements
Element Structure
Child Attributes and Elements
Examples
plugin elements for a server type
config_track Plugin Element
plugin - root
Element Overview
Element Structure
Child Elements and Attributes
Examples
plugin name and package specified in plugin root
plugin class specified in root
plugin version specified in plugin root
properties
Element Overview
Parentage
Child Elements
Examples
properties element for a platform type
property
Element Overview
Parent Elements
Child Attributes
Examples
property defines connection string that a support class appends to metric templates
property defines OBJECT_NAME for use in plugin descriptor and class
property overrides the default value of an option
scan
Element Overview
Element Structure
Parent Elements
Child Attributes and Elements
Examples
Scan process table for Apache servers on Unix-like operating system
Scan Windows registry for Apache servers
Scan Unix filesystem for MySQL servers
script
Element Overview
Parent Elements
Child Attributes and Content
Example
server
Element Overview
Parent Elements
Child Attributes and Elements
Element Overview
Parent Elements
Child Attributes and Elements
Examples
server element example
server element contents are defined by reference using include attribute
Server type is limited to specific platforms types using platforms attribute
Server type is defined as virtual
service
Element Overview
Element Structure
Parent Elements
Child Attributes and Elements
Examples
service defines service that runs on a server
service defines platform service
Global Configuration Schemas Reference
basicauth config
credentials config
dhcp config
dns config
ftp config
http config
InetAddress Ping config
jmx config
ldap config
ntp config
pop3 config
protocol config
rpc config
smtp config
snmp config
sockaddr config
sql config
ssh config
ssl config
sslprotocol config
sslsockaddr config
tcp config
url config
Example Plugin Descriptor
Plugin Support Classes
Auto-Discovery Support Classes
AutoServerDetector
Overview
Interface Hierarchy
Interface References
Implementing Methods
Example Usage
Standalone Invocation
DaemonDetector
Overview
Class Hierarchy
Resource Properties
Example Usage
Draft MxServerDetector
FileServerDetector
Interface Hierarchy
Interface References
Implementing Methods
Example Usage
Standalone Invocation
MxServerDetector
Overview
Class Hierarchy
Resource Properties
Usage
RegistryServerDetector
Overview
Interface Hierarchy
Interface References
Implementing Methods
Example Usage
Standalone Invocation
ServerDetector
Overview
Class Hierarchy
Resource Properties
Using Extra Filters
Using INSTALLPATH
Using AUTOINVENTORY_NAME
Using INVENTORY_ID
Implementing Methods
setDescription
setCustomProperties
discoverServers
discoverServices
discoverServiceTypes
createServerResource
SNMPDetector
Overview
Class Hierarchy
Resource Properties
Usage
Control Support Classes
Control Plugins
Script Execution
Windows Service Manager
ControlPlugin.doAction Method
Mx Server Control Plugin
Script Control Plugin
Win32 Control Plugin
Event Tracking Support Classes
FileChangeTrackPlugin
FileChangeTrackPlugin Functionality
Class Hierarchy
Using FileChangeTrackPlugin
Sample Usage
ConfigFileTrackPlugin
ConfigFileTrackPlugin Functionality
Class Hierarchy
Using ConfigFileTrackPlugin
Sample Usage
Log4JLogTrackPlugin
Overview
Class Hierarchy
Configurable Options
Resource Properties
Return Type
Example Usage
LogFileTailPlugin
Log File Tracking Plugin
About Event Volume
Example
Win32 Event Log Track Plugin
Measurement Support Classes
MeasurementPlugin
Overview
Class Hierarchy
Configurable Options
Resource Properties
Implementing Methods
init
getManager
getMeasurementProperties
getMeasurements
getPlatformHelpProperties
getPluginXMLHelp
getHelp
getValue
getNewCollector
getCollectorProperties
translate
getConfigSchema
SNMP Measurement Plugin
Win32 Measurement Log Track Plugin
Product Plugin
ServerResource
Overview
Class Hierarchy
Implementing Methods
setInstallPath
getInstallPath
setPlatformFqdn
getPlatformFqdn
addService
addServiceType
setIdentifier
getIdentifier
setType
getType
setName
getName
setDescription
getDescription
setProductConfig
getProductConfig
setMeasurementConfig
getMeasurementConfig
setControlConfig
getControlConfig
setCustomProperties
getCustomProperties
ServiceResource
Overview
Class Hierarchy
Implementing Methods
setName
ConfigResponse
Overview
Class Hierarchy
Implementing Methods
setValue
Example Usage
Plugin Tutorials
JMX Plugin Tutorial
JMX Measurement Plugin
Develop Sample JMX Plugin
Step 1 - Understand how the Plugin Fits into Inventory Model
Step 2 - Configure the JMX-Enabled Application for Remote Connection
Step 3 - Determine Which Metrics to Collect in the Plugin
Step 4 - Review the Sample JMX Measurement Plugin Descriptor
Step 5 - What Plugin Will Show in the HQ UI
Step 6 - Understand and Modify Each Piece of the Sample Plugin XML Descriptor
Include Standard Process Metrics
Include JMX Libraries
Define Metrics
Specify Server Resource
Tell the Plugin About Services the Server Hosts
Enable the Plugin to Connect to the MBean Server
Identify the Processes You Want to Collect Metrics From
Gather Metrics
Auto-Discover the Server
Identify and Gather Metrics from the Server's Hosted Services
Provide Configuration Instructions
Step 7 - Test the Plugin.
Step 8 - Deploy the Plugin.
Plugins Tutorial
Plugins Tutorials
Tutorials by Plugin Type and Implementation
How Plugins and the HQ Inventory Model Work Together
Every Plugin Needs an XML Descriptor
XML Descriptor for Measurement Plugins
Auto-Discovery
Availability Metric
Troubleshooting
vFabric Hyperic HQU Plug-in Development
About vFabric Hyperic HQU Plug-in Development
Intended Audience
HQU Overview
What is HQU?
What is HQU Good For?
HQU Plugins and the HQ UI
Overview of HQU Plugin Development
HQU Anatomy and Components
HQU Design Pattern
Plugin Files
Plugin.groovy
plugin.properties
Controller_Name Controller.groovy
index.gsp
plugin_name _i18n.properties
Plugin Directories
Key HQU Framework Files
Plugins and the HQ Portal
HQU Deployment
Invoking an HQU Plugin as a Web Service
HQU Request Processing
Planning an HQU Plugin
Plugin Mission and Type
Access and Authorization
Required HQ Data and Functions
User Supplied Parameters
View Plugin Requirements
Integration Plugin Requirements
Automation Plugins
Developing an HQU Plugin
Step 1 - Create Plugin Scaffolding
Scaffolding Syntax and Arguments
Files and Directories Created by Scaffolding Task
Contents of the Generated Plugin Files
Step 2 - Build the Plugin
Step 3 - Deploy and Run the Plugin
Step 4 - Set Location Properties for a View Plugin
Excerpt from Plugin.groovy as Created
Understanding Attachment Properties and Options
Specify View Location in Plugin.groovy
Attach Plugin to a Masthead Menu
Attach Plugin to Administration Page
Attach Plugin to Resource>View page
Detaching and Removing HQU Plugins
Step 4 - Program the Plugin Behavior
Step 5 - Localize the Plugin
Contents of the I18n Properties as Created
Understanding How Plugin Views Obtain Localization Strings
Writing Plugin Controller Logic
Accessing HQ Data and Functions
HQU APIs
Backend APIs
Defining User Interaction
Defining Parameters
Creating Dojo Tables
Rendering
Obtaining Localized Strings
Rendering Ajax
Returning XML from Controllers
Returning JSON from Controllers
Miscellaneous Controller Topics
Groovy Console*
Re-using Markup with Groovy Templates
Using Variables in Controllers
Authorization
Snippets
Groovy Tips
Links to Groovy Topics
Groovy def
Property Accessor Methods
Accessibility Modifiers
Inferred Types
Plugin Scaffolding
Plugin.groovy
ControllerName Controller.groovy
index.gsp
plugin_name _i18n.properties
plugin.properties
HQ Groovy APIs
Coding Conventions
Obtaining a Helper Instance
BaseController Utility Methods
MetaClasses and Categories
ResourceHelper.groovy
AlertHelper.groovy
AuditHelper.groovy
BaseHelper.groovy
MetricHelper.groovy
AgentHelper.groovy
Sample Plugin
Currently Down View
SystemsdownController.groovy
vFabric RabbitMQ 2.4
Server
Installation
Introduction
Installing as Part of vFabric Cloud Application Platform
Windows
Installing Prerequisites
Installing RabbitMQ Server
Verifying the Installation
Finding Command Scripts and App Data
Running RabbitMQ Server as an Application
Running RabbitMQ Server as a Service
Managing RabbitMQ Server
Logging
RPM-based Linux (RHEL / CentOS)
Installing RabbitMQ Server
Running RabbitMQ Server
Managing RabbitMQ Server
Logging
Generic Unix or Linux
Installing RabbitMQ Server
Running RabbitMQ Server
Managing RabbitMQ Server
Logging
Activate a Local vFabric RabbitMQ License
Troubleshooting
Configuration
Introduction
Customise RabbitMQ Environment
RabbitMQ Environment Variables
Configuration File
Administration
Default database contents
Management and monitoring
Access control
Plugins
Management and Monitoring
Features
Installation
Getting started
Permissions
Configuration
Note on clustering
HTTP API
Manual Pages
Section 1 - General Commands
Section 5 - File formats
Clustering
Clustering overview
Clustering transcript
Upgrading clusters
A cluster on a single machine
Firewalled nodes
Extensions
Consumer Cancellation Notifications
Client and Server Capabilities
Negative Acknowledgements
Confirms (aka Publisher Acknowledgements)
Per-Queue Message TTL
Exchange to Exchange Bindings
Queue Leases
Alternate Exchanges
Validated User-ID
Memory-based flow control
Sender-selected Distribution
Changelog
Clients
Java Client API
Core API
Basic RPC
Shutdown Protocol
Javadoc documentation
.NET Client Library User Guide
.NET Client API documentation
Developer Tools
AMQP
Protocol & API Quick Reference
basic
basic.ack
basic.cancel
basic.consume
basic.deliver
basic.get
basic.nack
basic.publish
basic.qos
basic.recover
basic.recover-async
basic.reject
basic.return
channel
channel.close
channel.flow
channel.open
confirm
confirm.select
exchange
exchange.bind
exchange.declare
exchange.delete
exchange.unbind
queue
queue.bind
queue.declare
queue.delete
queue.purge
queue.unbind
tx
tx.commit
tx.rollback
tx.select
AMQP 0-9-1 Complete Reference Guide
Protocol Information
Classes
connection
channel
exchange
queue
basic
tx
confirm
Domains
Constants
RabbitMQ's compatibility and conformance with the AMQP specification
Plugins
Plugin Installation Guide
Plugin Development Guide
Why Write A Plugin?
Why To Not Write A Plugin
Getting Started
Installing Plugins During Development
Plugin Quality Tips
Example Plugin: Metronome
Specific Plugin Pages
rabbitmq-erlang-client - RabbitMQ's Erlang Client
Introduction
Programming Model
AMQP Commands
Including Header Files
Connecting To A Broker
Creating Channels
Managing Exchanges And Queues
Sending Messages
Receiving Messages
Subscribing To Queues
Closing Channels And The Connection
Complete Example
Client Deployment
Egress Flow Control
Ingress Flow Control
Handling Returned Messages
rabbitmq-management - Management plugin provides a web interface and HTTP API for managing and monitoring RabbitMQ.
Features
Installation
Getting started
Permissions
Configuration
Note on clustering
HTTP API
rabbitmq-shovel - Allows chaining of brokers
rabbitmq-stomp - Exposes AMQP functionality via a STOMP gateway
General Documentation
How to use SSL with RabbitMQ
Introduction
Keys, Certificates and CA Certificates
Enabling SSL Support in RabbitMQ
Levels of Trust
Configuring the .Net client
Configuring the Erlang client
How to configure authentication with RabbitMQ
Introduction
Built-in mechanisms
Server configuration
Client configuration
How to make a highly available RabbitMQ broker with Pacemaker and DRBD
Introduction
Requirements
Assumptions
DRBD in Pacemaker
Simple HA Rabbit
Getting an IP address to move with Rabbit
HA within a RabbitMQ Cluster
Configuration Parameters
Interoperability with other implementations of AMQP
Interoperation with Qpid
Interoperation with OpenAMQ
RabbitMQ versions tested
Learn more about Mercurial, the source and version control system that we use
What is Mercurial?
Branching policy: Branch per bug
The default branch
Maintenance branches
Tags
Information on Erlang's suitability for AMQP implementations
Distribution
Live code upgrade
Built in Process Monitoring and Control
Predictable High Speed
Point to Point
Enterprise Ready
Portability
Getting Started with RabbitMQ
Java Tutorials
Tutorial One: Hello World!
Tutorial Two: Work Queues
Tutorial Three: Publish/Subscribe
Tutorial Four: Routing
Python Tutorials
Tutorial One: Hello World!
Tutorial Two: Work Queues
Tutorial Three: Publish/Subscribe
Tutorial Four: Routing
Tutorial Five: Topics
Tutorial Six: RPC
Server
Installation
Introduction
Installing as Part of vFabric Cloud Application Platform
Windows
Installing Prerequisites
Installing RabbitMQ Server
Verifying the Installation
Finding Command Scripts and App Data
Running RabbitMQ Server as an Application
Running RabbitMQ Server as a Service
Managing RabbitMQ Server
Logging
RPM-based Linux (RHEL / CentOS)
Installing RabbitMQ Server
Running RabbitMQ Server
Managing RabbitMQ Server
Logging
Generic Unix or Linux
Installing RabbitMQ Server
Running RabbitMQ Server
Managing RabbitMQ Server
Logging
Activate a Local vFabric RabbitMQ License
Troubleshooting
Configuration
Introduction
Customise RabbitMQ Environment
RabbitMQ Environment Variables
Configuration File
Administration
Default database contents
Management and monitoring
Access control
Plugins
Management and Monitoring
Features
Installation
Getting started
Permissions
Configuration
Note on clustering
HTTP API
Manual Pages
Section 1 - General Commands
Section 5 - File formats
Clustering
Clustering overview
Clustering transcript
Upgrading clusters
A cluster on a single machine
Firewalled nodes
Extensions
Consumer Cancellation Notifications
Client and Server Capabilities
Negative Acknowledgements
Confirms (aka Publisher Acknowledgements)
Per-Queue Message TTL
Exchange to Exchange Bindings
Queue Leases
Alternate Exchanges
Validated User-ID
Memory-based flow control
Sender-selected Distribution
Changelog
Clients
Java Client API
Core API
Basic RPC
Shutdown Protocol
Javadoc documentation
.NET Client Library User Guide
.NET Client API documentation
Developer Tools
AMQP
Protocol & API Quick Reference
basic
basic.ack
basic.cancel
basic.consume
basic.deliver
basic.get
basic.nack
basic.publish
basic.qos
basic.recover
basic.recover-async
basic.reject
basic.return
channel
channel.close
channel.flow
channel.open
confirm
confirm.select
exchange
exchange.bind
exchange.declare
exchange.delete
exchange.unbind
queue
queue.bind
queue.declare
queue.delete
queue.purge
queue.unbind
tx
tx.commit
tx.rollback
tx.select
AMQP 0-9-1 Complete Reference Guide
Protocol Information
Classes
connection
channel
exchange
queue
basic
tx
confirm
Domains
Constants
RabbitMQ's compatibility and conformance with the AMQP specification
Plugins
Plugin Installation Guide
Plugin Development Guide
Why Write A Plugin?
Why To Not Write A Plugin
Getting Started
Installing Plugins During Development
Plugin Quality Tips
Example Plugin: Metronome
Specific Plugin Pages
rabbitmq-erlang-client - RabbitMQ's Erlang Client
Introduction
Programming Model
AMQP Commands
Including Header Files
Connecting To A Broker
Creating Channels
Managing Exchanges And Queues
Sending Messages
Receiving Messages
Subscribing To Queues
Closing Channels And The Connection
Complete Example
Client Deployment
Egress Flow Control
Ingress Flow Control
Handling Returned Messages
rabbitmq-management - Management plugin provides a web interface and HTTP API for managing and monitoring RabbitMQ.
Features
Installation
Getting started
Permissions
Configuration
Note on clustering
HTTP API
rabbitmq-shovel - Allows chaining of brokers
rabbitmq-stomp - Exposes AMQP functionality via a STOMP gateway
General Documentation
How to use SSL with RabbitMQ
Introduction
Keys, Certificates and CA Certificates
Enabling SSL Support in RabbitMQ
Levels of Trust
Configuring the .Net client
Configuring the Erlang client
How to configure authentication with RabbitMQ
Introduction
Built-in mechanisms
Server configuration
Client configuration
How to make a highly available RabbitMQ broker with Pacemaker and DRBD
Introduction
Requirements
Assumptions
DRBD in Pacemaker
Simple HA Rabbit
Getting an IP address to move with Rabbit
HA within a RabbitMQ Cluster
Configuration Parameters
Interoperability with other implementations of AMQP
Interoperation with Qpid
Interoperation with OpenAMQ
RabbitMQ versions tested
Learn more about Mercurial, the source and version control system that we use
What is Mercurial?
Branching policy: Branch per bug
The default branch
Maintenance branches
Tags
Information on Erlang's suitability for AMQP implementations
Distribution
Live code upgrade
Built in Process Monitoring and Control
Predictable High Speed
Point to Point
Enterprise Ready
Portability
Getting Started with RabbitMQ
Java Tutorials
Tutorial One: Hello World!
Tutorial Two: Work Queues
Tutorial Three: Publish/Subscribe
Tutorial Four: Routing
Python Tutorials
Tutorial One: Hello World!
Tutorial Two: Work Queues
Tutorial Three: Publish/Subscribe
Tutorial Four: Routing
Tutorial Five: Topics
Tutorial Six: RPC
PDF
PDF Product Documentation
PDF Product Documentation