Professional Documents
Culture Documents
Configure and Run The HQ Server-13-3
Configure and Run The HQ Server-13-3
Table of Contents
1. Start and Stop HQ Server ......................................................................................................... 3 1.1. Starting the Server on Unix-Based Platforms ..................................................................... 3 1.2. Starting the Server on Windows To Run as a Service .......................................................... 3 1.3. Troubleshooting HQ Server Startup Problems .................................................................... 3 2. Configure HQ Server Communications and Connections ................................................................ 4 2.1. Updating SSL Certs for HQ Server .................................................................................. 5 2.2. Configure User Interface Help Location ........................................................................... 6 2.3. Configure the Maximum Number of Agent - Server Connections .......................................... 7 2.4. Configure Size of HQ Server Database Connection Pool ...................................................... 8 2.5. Configure HQ Version and Security Announcements .......................................................... 9 2.6. Configure HQ Server Alert Notification Email Properties ................................................... 10 3. Configure HQ Server Memory, Garbage Collection, and Caches .................................................... 11 3.1. Configure HQ Server Caches for Improved Performance .................................................... 12 3.2. Configure HQ Server Heap and Memory Settings ............................................................. 14 4. Configure Metric Baselining and Alert Processing Behavior .......................................................... 16 4.1. Configure Global Alert Properties .................................................................................. 17 4.2. Configure Alert Notification Throttling ........................................................................... 18 4.3. Configure Metric Baselining Properties ........................................................................... 19 5. Managing the HQ Database .................................................................................................... 20 5.1. HQ Database Backup and Recovery ............................................................................... 21 5.2. Building a Metric Data Warehouse ................................................................................ 22 5.3. Configure HQ Server Data Compression and Purge Behavior .............................................. 31 5.4. Monitoring the HQ Database ........................................................................................ 33 6. Configuring HQ for Large Environments and Improved Performance .............................................. 34 6.1. Increasing Java Heap and Changing GC Settings .............................................................. 34 6.2. Increase JMS Memory Settings ..................................................................................... 35 6.3. Increase Max Lather Connections .................................................................................. 35 6.4. Increase the Number Connections to Database ................................................................. 36 6.5. Configure HQ Cache Settings for Improved Performance ................................................... 36 7. Integrate HQ Server with Other Systems ................................................................................... 39 7.1. Configure LDAP Properties .......................................................................................... 40 7.2. Configure Kerberos Properties ...................................................................................... 41 7.3. Configuring HQ Server for SMTP Server ........................................................................ 42 7.4. Enable Hyperic Enterprise to Send SNMP Traps .............................................................. 44 7.5. Configure HQ Server for Hyperic IQ ............................................................................. 48 8. HQ Server Proxy and Failover Configurations ............................................................................ 49 8.1. Configure an Apache Proxy Server for HQ Server ............................................................ 50 8.2. Clustering HQ Servers for Failover ................................................................................ 54 9. HQ Database Table Schemas .................................................................................................. 59 9.1. Key Resource and Measurement Tables .......................................................................... 59 9.2. Table Documentation .................................................................................................. 60 10. Server Properties ................................................................................................................. 68 10.1. About HQ Server Configuration .................................................................................. 69 10.2. Server Property Definitions ......................................................................................... 69
The script will display some startup information on stdout, then it will detach and run in the background. The URL that HQ is configured to listen on will display startup progress information until it is completely started. Then it will redirect to the login page. The server.log file in the logs directory under the server installation directory will have detailed startup information.
<Server Installation directory>\bin\hq-server.exe -i Henceforth, use the Windows Service control panel to start and stop the server.
10
11
This listing shows each cache, its size, and its hit counts. At the end of the listing there is a summary for the total size of all HQ caches.
12
Configure HQ Server Caches for Improved Performance If a cache has an unusually high miss rate or becomes full, you can manually configure it to improve performance. For example, consider this cache:
Measurement.findByTemplateForInstance 10000 6766 25772
The cache has 10,000 elements. With only 6766 hits and 25,772 misses, the hit ratio is around 20-25%. Ideally the number of misses should peak at about the maximum size of the cache. (There are some exceptions to this: the UpdateTimestampsCache and the PermissionCache have items invalidated from the cache frequently, so these rules do not apply.) So, increasing this cache's size would probably improve HQ performance.
You may need to iterate on the cache size to find the optimal setting. The format of this file is described in EHCache's documentation.
This cache is set to expire the checks after 60 seconds. In an environment where the user and role definitions are not updated frequently, you can increase the timeToLiveSeconds value to effect a significant performance increase. While the right value for timeToLiveSeconds depends on the environment, the rule of thumb is that it should be set no higher than the acceptable time for a permission-related operation to take effect. Perhaps this is even zero, but that can be costly because the Server needs to go to the database to check permission on every resource the user views.
13
If you increase heap size, you may need to change JMS memory settings as well. For more information, see the Increase JMS Memory Settings below. Note: If you are running HQ Server on a 64-bit system with 4GB (4096 MB) or less memory, Hyperic recommends you use 32-bit JVM. A 64-bit JVM is not recommended unless you have more memory. You might need twice as much heap on a 64-bit system as on a a 32-bit system to achieve the same performance.
Update HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Hyperic HQ Server\Parameters \OptionString.8 = -Xmx1024m Add HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Hyperic HQ Server\Parameters \OptionString.11 = -Xms1024m Update HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Hyperic HQ Server\Parameters \NumOptions = 12
14
15
16
17
18
The frequency with which HQ cal- 3 days culates a baseline for each metric. The time range of metric data used 7 days in calculating the baseline. The minimum number of data points used in calculating a baseline. 40
19
20
You can back up these files while HQ Server is running. The contents of these files are stable. Changes are infrequent once your HQ Server is installed at configured. Back them up at that time and after making changes to the sever configuration.
21
4. Read the dblink.sql file into PostgreSQL to enable the secondary database to access data in the primary HQ database.
$ psql hqdata < $PGHOME/contrib/dblink.sql
Where $PGHOME is the PostgreSQL installation directory, for example, /usr/share/pgsql. 5. Configure PostgreSQL network access to allow remote queries.
$ vi $PGDATA/pg_hba.conf
23
Building a Metric Data Warehouse The $PGDATA variable represents the path where the databases are being stored. By default this is /var/lib/ pgsql/data. 6. Edit the pg_hba.conf file to include an entries for the primary database and the secondary database.
# TYPE DATABASE USER CIDR-ADDRESS METHOD # "local" is for Unix domain socket connections only local all all trust # IPv4 local connections: host all all 127.0.0.1/32 trust # ADD THE FOLLOWING TWO HOST ENTRIES}} # main hq database ip}} host all all 10.2.0.206/32 trust # replicated hq database ip (even though loop back is already specified) host all all 10.2.0.100/32 trust
Note: In the entries for the "main hq database ip" and "replicated hq database" replace the IP addresses (10.2.0.206/32 and 10.2.0.100/32) to those of your primary and secondary databases respectively. 7. Create database tables. a) Create table for raw measurements:
create table EAM_MEASUREMENT_DATA ( TIMESTAMP bigint, MEASUREMENT_ID int, VALUE numeric(24, 5), primary key (TIMESTAMP, MEASUREMENT_ID) );
24
25
26
27
28
29
30
2 days
Controls whether HQ Nightly reindexes metric data tables every night. If configured to re-index night-
31
Configure HQ Server Data Compression and Purge Behavior ly, HQ re-indexes the tables around midnight. Delete Alerts Older Than Delete Events and Logs Older Than Controls how long HQ stores alert event data. 31 days
Controls how long HQ 31 days stores other HQ event and log data.
32
33
If you increase heap size, you may need to change JMS memory settings as well. For more information, see the Increase JMS Memory Settings below. Note: If you are running HQ Server on a 64-bit system with 4GB (4096 MB) or less memory, Hyperic recommends you use 32-bit JVM. A 64-bit JVM is not recommended unless you have more memory. You might need twice as much heap on a 64-bit system as on a a 32-bit system to achieve the same performance.
34
35
36
This listing shows each cache, its size, and its hit counts. At the end of the listing there is a summary for the total size of all HQ caches. If a cache has an unusually high miss rate or becomes full, you can manually configure it to improve performance. For example, consider this cache:
Measurement.findByTemplateForInstance 10000 6766 25772
The cache has 10,000 elements. With only 6766 hits and 25,772 misses, the hit ratio is around 20-25%. Ideally the number of misses should peak at about the maximum size of the cache. (There are some exceptions to this: the UpdateTimestampsCache and the PermissionCache have items invalidated from the cache frequently, so these rules do not apply.) So, increasing this cache's size would probably improve HQ performance.
You may need to iterate on the cache size to find the optimal setting. The format of this file is described in EHCache's documentation.
This cache is set to expire the checks after 60 seconds. In an environment where the user and role definitions are not updated frequently, you can increase the timeToLiveSeconds value to effect a significant performance increase. While the right value for timeToLiveSeconds depends on the environment, the rule of thumb is that it should be set no higher than the acceptable time for a permission-related operation to take effect. Perhaps this is even
37
Configure HQ Cache Settings for Improved Performance zero, but that can be costly because the Server needs to go to the database to check permission on every resource the user views.
38
39
Search Base
40
41
Add this line to the configuration section for the MailService (below the "SMTP" comment):
<property name="mail.smtp.auth" value="true"/>
If you need to specify a port other than 25 for SMTP authentication connections (in the sample code line below, the submission port, 587, is used), add this line in the same SMTP section (using the correct port number for the SMTP server):
<property name="mail.smtp.port" value="587"/>
3. Enable TLS for SMTP Authentication. If your mail servers require TLS connections for SMTP authentication: Add additional connection information to the SMTP configuration properties section in <HQ Server directory>/conf/templates/jboss-service-events.xml. In the file <HQ Server directory>/conf/templates/jboss-service-events.xml, add the following line to the configuration section for the MailService (below the "SMTP" comment):
<property <property <property <property name="mail.smtp.starttls.enable" value="true" /> name="mail.smtp.socketFactory.port" value="465" /> name="mail.smtp.socketFactory.fallback" value="false" /> name="mail.smtp.socketFactory.class" value="javax.net.ssl.SSLSocketFactory" />
Note: If the 465 setting for the socket factory port does not work, verify the TLS connection port. 4. To add the SMTP Server's TLS certificate to the JRE keystore: Obtain a copy of the public certificate for the SMTP server's TLS configuration (not the private key) on the HQ Server.
42
Configuring HQ Server for SMTP Server As the user that owns the HQ installation, execute the following in the server installation directory:
jre/bin/keytool \-keystore jre/lib/security/cacerts \-import \-storepass changeit \-file / path/to/smtp_server_tls.cert
When asked if you want to trust the certificate, answer "yes." Note: The certificate import example above assumes the use of a JRE that is bundled with the HQ Server. When using a non-bundled JRE, use that JRE's keytool and cacerts file.
43
44
Enable Hyperic Enterprise to Send SNMP Traps Community For version 1: Trap OID Community Generic ID Specific ID Enterprise ID Agent Address
45
Enable Hyperic Enterprise to Send SNMP Traps Configuration Option Specific ID Description The specific trap code for an enterprise-specific trap (when Generic ID is set to to 6). Address of the managed object that generates the trap. Allowable Values
Agent Address
Configure HQ Server 4.3 and Later for SNMP v2c Configuration Option SNMP Trap OID Description The OID of the notification to be sent. Supplies the value of snmpTrapOID.0 - the second varbind in a trap or inform that HQ Server generates. (The first varbind is SysUpTime.0.) Specifies the default notification V1 Trap type that will appear in configuration dialogs when an authorized us- V2c Trap er configures an SNMP notification as an alert action, or as a step in an Inform escalation. This choice simply defines the default option - the user configuring an alert action or escalation can choose a different message type. The community name to be sent with the trap. Allowable Values
Community
Configure HQ Server 4.3 and Later for SNMP v3 This section lists the properties for enabling HQ Enterprise to sent SNMP notifications to an NMS. When HQ is so enabled, you can use SNMP notifications in alert definitions - as alert actions and escalation steps. Configuration Option SNMP Trap OID Description The OID of the notification to be sent. Supplies the value of snmpTrapOID.0 - the second varbind in a trap or inform that HQ Server generates. (The first varbind is SysUpTime.0.) Specifies the default notification V1 Trap type that will appear in configuration dialogs when an authorized us- V2c Trap er configures an SNMP notification as an alert action, or as a step in an Inform escalation. This choice simply defines the default option - the user configuring an alert action or escaAllowable Values
46
Enable Hyperic Enterprise to Send SNMP Traps Configuration Option Description lation can choose a different message type. The username HQ's SNMP agent should use when sending notifications to the NMS. ID of HQ's SNMP agent; this value appears automatically, and is not user-configurable. The SNMP authentication protocol none HQ Server should use for commu MD5 nications with the NMS. The SNMP authorization passphrase configured for use when communication with the NMS. The SNMP Privacy Protocol HQ Server should use for communication with the NMS. SHA Allowable Values
Security Name
Required.
Local Engine ID
Auth Protocol
Auth Passphrase
Privacy Protocol
Privacy Passphrase
The SNMP privacy passphrase configured for use when communication with the NMS. The EngineID of the NMS. This, along with Context Name, identifies the SNMP context for accessing management data. The name of the SNMP context that provides access to management information on the NMS. A context is identified by the Context Name and Context Engine ID.
AES-256
Context Engine ID
Context Name
47
48
49
8.1.1. Introduction
This page has instructions for setting up an Apache web server as a proxy server for HQ Server. The example implementation assumes Apache is running on Red Hat Enterprise Linux (RHEL) 5. The overall process applies to other Apache distributions, but the details may vary.
8.1.2. Prerequisites
These instructions assume that: The reader understands operating system basics, the use of shell commands, and text file editing. HQ Server is installed, configured, and running. Apache httpd is installed, configured, and running. RHEL httpd-devel (or an equivalent package that provides apxs) is installed. The development tools required to build mod_jk (compiler, make, lib files, and so on) are available.
50
Configure an Apache Proxy Server for HQ Server This guide uses Tomcat's JK connector to proxy to HQ. mod_jk uses a binary protocol (ajp) to communicate with HQ's Tomcat server. This proxy mechanism is faster than HTTP. Alternatively, you could use mod_proxy_ajp; however, the version of mod_proxy_ajp in RHEL 5.x is out-of-date and has bugs that can cause unexpected behavior in the user interface. 1. Download the latest Tomcat JK Connectors source.
cd /usr/local/addons wget http://www.apache.org/dist/tomcat/tomcat-connectors/jk/source/tomcat-connectorscurrent-src.tar.gz
3. Build and install the connector. These instructions are for RHEL. For other environments, see native/BUILDING.txt. (Change tomcat-connectors-1.2.28-src to match the newly created directory for the version you downloaded.)
cd tomcat-connectors-1.2.28-src cd native ./configure --with-apxs=/usr/sbin/apxs make make install
4. Add configuration file for mod_jk. Create (or update) /etc/httpd/conf.d/mod_jk.conf with the following (adjust paths for your environment):
<IfModule !mod_jk.c> LoadModule jk_module modules/mod_jk.so </IfModule>
Note: You can configure a different redirect port; if you do, make a note of the port number.
51
Configure an Apache Proxy Server for HQ Server 2. In /opt/hyperic/hq/server/server-4.2.0-EE/conf/template/jbossweb-service.xml, verify that UseJK is set to "true":
<attribute name="UseJK">true</attribute>
2. Create or update /etc/httpd/conf.d/workers.properties with the following content: Note: If /etc/httpd/conf.d/workers.properties already exists and has a worker.list line, append "ajp13-hq" to the existing line. The file should have only one worker.list line.
worker.list=ajp13-hq worker.ajp13-hq.type=ajp13 worker.ajp13-hq.host=localhost worker.ajp13-hq.port=9009
If the response is not "Syntax OK", find and fix the error before proceeding. 4. Restart httpd.
service httpd restart
52
53
55
# # Property ha.node.cacheListener.port # # This property defines the multicast port that is used to discover cache peers. # property is not required and defaults to 45567 #ha.node.cacheListener.port=45567
This
# # Property ha.node.cacheProvider.port # # This property defines the multicast port that is used to synchronize caches throughout # the HQ cluster. This property is not required and defaults to 45568. #ha.node.cacheProvider.port=45568
Required Cluster Properties For each HQ Server in the cluster you must specify: ha.partition ha.node.address Name of the cluster---this value is identical for each node in the cluster Multicast listen address---specifies IP address or hostname upon which the node listens for multicast traffic; this value is unique to each node in the cluster.
Note: If you are upgrading from a pre-v3.0 failover configuration, the each server's .conf file will contain obsolete cluster properties, including server.cluster.mode and server.ha.bind_addr properties. Delete these properties and replace with the current failover properties described below. Optional Cluster Properties If desired, you can control these communication behaviors for the nodes in the cluster: ha.node.mcast_addr and ha.node.mcast_port ha.node.cacheListener.port and ha.node.cacheProvider.port Address and port for sending multicast messages to other nodes. Note: ha.node.mcast_addr must be the same on each node. Ports used for discovering and synchronizing with cache peers.
56
Clustering HQ Servers for Failover Ensure these lines in HQServerHome/conf/template.server.xml are not commented out:
<Connector port="9009" address="${jboss.bind.address}" emptySessionPath="true" enableLookups="false" redirectPort="7443" protocol="AJP/1.3"/>
Note: The value of jvmRoute must match the name of the primary node, node1 in this example. 3. In <HQ Server service.xml change UseJK to true: directory>/hq-engine/server/default/deploy/jbossweb.deployer/META-INF/jboss-
<attribute name="UseJK">true</attribute>
4. Repeat these steps for every node in the cluster. 5. Now restart Apache and all the nodes (HQ Servers).
57
The console output above shows that the HQCluster cluster has started and lists the cluster's two members: 10.2.0.138:2099 and 10.2.0.139:2099. When you start up other nodes with the same partition name, you should see additional entries in the membership list. Troubleshooting a Failover Configuration This section describes the most common sources of problems the failover configuration. Multicast blocking---The cluster detection and cache peer detection relies on multicast. Make sure your router isn't blocking multicast packets; otherwise the HQ cluster will fail to initialize properly. It's also common for virtualization technologies like VMware and Xen to not enable multicast by default. Don't register agents using the loopback address---If install an HQ Agent on the same machine as an HQ Server node, when you specify the IP address the server should use to contact the agent, don't specify loopback address (127.0.0.1). Alerts that were currently firing or in escalation were "lost"--A failover to another cluster node occurred in the middle of the alerts being fired or escalated. The alert state could be lost.
58
59
Table Documentation
60
9.2.1. EAM_PLATFORM
Contains a row for each platform in inventory. Click the thumbnail to see example column data.
Field ID VERSION_COL
Description An ID for the platform, unique among platforms. Version of the row. Increments when the row is modified. increments with any change to configuration of this row Fully qualified domain name of the platform. SSL Certificate for the agent which is monitoring this platform. not used Description of platform. Creation time of platform. Last modification time of the platform. Last modification user. String entered by user, optionally. String entered by user, optionally. Number of CPUs on this platform. ID for the platform type. Points to EAM_PLATFORM_TYPE table. Link to configuration string in plugin xml file. A unique identifier to the agent which is monitoring this platform. Uniquely identifies the resource, unique across platforms, servers, services. Points to the EAM_RESOURCE table.
FQDN CERTDN CID DESCRIPTION CTIME MTIME MODIFIED_BY LOCATION COMMENT_TEXT CPU_COUNT PLATFORM_TYPE_ID CONFIG_RESPONSE_ID AGENT_ID RESOURCE_ID
varchar(200) varchar(200) int4 varchar(256) int8 int8 varchar(100) varchar(100) varchar(256) int4 int4 int4 Int4 int4
9.2.2. EAM_PLATFORM_TYPE
Contains a row table for each HQ-supported platform type. Click the thumbnail to see column names and example column data
61
Table Documentation
9.2.3. EAM_SERVER
Contains a row for each server in HQ inventory. Field ID VERSION_COL Type int4 int8 Description A unique identifier of the server. A column which increments with any change to configuration of this row Description of server. Creation time of servver Last modification time of the server. Last modification user The Unique ID of the platform on which this server is installed A unique ID describing this server via the plugin XML. Note: Added in 4.2. Is runtime autodiscovery enabled on this server? Was this server autodiscovered? Not used. Were there deletions on the client side for this server? Install path of this server on the platform. Unique ID of the server type that describes this server.
AUTOINVENTORYIDENTIFIER varchar(250)
62
Table Documentation CONFIG_RESPONSE_ID RESOURCE_ID int4 int4 Link to configuration string in plugin xml file. Uniquely identifies the resource, unique across platforms, servers, services. Points to the EAM_ RESOURCE table.
9.2.4. EAM_SERVICE
Contains a row for each service in HQ inventory Field ID VERSION_COL Type int4 int8 Description An ID for the service, unique among services. A column which increments with any change to configuration of this row Description of service. Creation time of service. Last modification time of the service. Last modification user. Not used. Were there deletions on the client side for this service? Is response time enabled for this service? Is end user response time enabled for this service? Unique ID into the parent service for this service. Were there deletions on the client side for this server? A unique ID describing this server via the plugin XML. Note: Added in 4.2. Unique ID of service type for this service. Link to configuration string in plugin xml file. Uniquely identifies the resource, unique across platforms, servers, services. Points to the EAM_ RESOURCE table.
CID DESCRIPTION CTIME MTIME MODIFIED_BY LOCATION AUTODISCOVERY_ZOMBIE SERVICE_RT ENDUSER_RT PARENT_SERVICE_ID SERVER_ID
int4 varchar(200) int8 int8 varchar(100) varchar(100) bool bool bool int4 int4
AUTOINVENTORYIDENTIFIER varchar(500)
63
Table Documentation
9.2.5. EAM_RESOURCE
This table contains a row for each type in the HQ inventory and access control model, and a row for each instance of each type in the HQ database, including: basic inventory types - Platforms, Servers, and Services configurable inventory types - Groups and Applications Users and Roles Escalations Click the thumbnail to see example column data.
Description Uniquely identifies a type or an instance of a type. Increments with any change to configuration of this row. Identifies a type in the HQ inventory and access control model. The values this attribute identify a resource as one of the following: Uniquely identifies a type or an instance of a particular type in the inventory and access control model. For a type, corresponds to the ID column in one of the following tables: EAM_PLATFORM_TYPE, EAM_SERVER_TYPE&, EAM_SERVICE_TYPE, EAM_APPLICATION_TYPE, or EAM_RESOURCE_TYPE. For an instance of a type, corresponds to the ID column in one of the following tables: EAM_PLATFORM, EAM_SERVER, EAM_SERVICE, EAM_RESOURCE_GROUP,
INSTANCE_ID
int4
64
Table Documentation EAM_APPLICATION, EAM_ROLE, EAM_SUBJECT. EAM_ESCALATION SUBJECT_ID PROTO_ID int4 int4 Identifies the HQ user owns the resource. For a type, value is zero. For an instance of a type, contains the value of the ID column for the type in this table. Display name for a resource, for example, "My-Office-MacBook-Pro-15.local JBoss 4.2 default ServiceManager Stateless Session EJB". Same as the NAME column but all in upper case, for example, "MY-OFFICE-MACBOOK-PRO-15.LOCAL JBOSS 4.2 DEFAULT SERVICEMANAGER STATELESS SESSION EJB". Last modification time of the resource.
NAME
varchar(500)
SORT_NAME
varchar(500)
FSYSTEM MTIME
boolean int8
9.2.6. EAM_MEASUREMENT
Each row contains information about a measurement for a resource under management. Click the thumbnail to see example column data.
Field ID
Type int4
Description Unique ID for a metric that can be collected for a resource. Points to actually measurements in EAM_MEASUREMENT_DATA_* tables.
65
Table Documentation VERSION_COL int8 Indicates version of the row, increments upon each change to the row. The resource type the measurement is for. Uniquely identifies a resource type of a given inventory level - platform, server, service. For example, the ID 10001 uniquely identifies the platform type "MacOSX". ID of a template points to the EAM_MEASUREMENT_TEMPL table. Time modified. Is this metric enabled? How often this metric is collected. A string which describes the measurement from the plugin-xml text. Uniquely identifies the resource for which the metric is associated, unique across platforms, servers, services. Points to the EAM_ RESOURCE table.
INSTANCE_ID
int4
TEMPLATE_ID
int4
9.2.7. EAM_MEASUREMENT_TEMPL
Contains a row for a every measurement that HQ can collect, for every resource type it can manage, with information about the default metric collection settings. Field ID Type int4 Description A unique identifier of a measurement template for a metric for a resource. A column which increments with any change to configuration of this row Name of this measurement template. String that describes the alias portion of XML file. Units of this measurement. Static/Dynamic data. Does this measurement collect by default? The default collection interval of this metric.
VERSION_COL
int8
66
Table Documentation DESIGNATE TEMPLATE PLUGIN CTIME MTIME MONITORABLE_TYPE_ID CATEGORY_ID bool varchar(2048) varchar(250) int8 int8 int4 int4 Is this metric on the indicator page by default? Template string from plugin XML. Name of the plugin which houses this measurement template. Creation time of server. Last modification time of the server. Key into the monitorable type data. Key into the category ID table.
67
Server Properties
68
10.2.2. hq-engine.server.port
Description The JRMP listen port Default 9093
10.2.3. server.database
Description
69
Server Property Definitions The kind of database the HQ server will use. The HQ server adjusts its interactions with the database according to the value of this property. Valid values are: PostgreSQL Oracle8 Oracle9i Default PostgreSQL
10.2.4. server.database-blockingtimeout
Description Maximum time in milliseconds to wait for a connection from the pool. Default 10000
10.2.5. server.database-driver
Description The JDBC driver to use. You shouldn't change this unless you really know what you're doing. Default org.postgresql.Driver
10.2.6. server.database-maxpoolsize
Description The maximum number of database connections to keep in the pool. This must be set lower than the total number of connections allowed to the backend database. Default 90
10.2.7. server.database-minpoolsize
Description The minimum number of database connections to keep in the pool Default 5
70
10.2.8. server.database-password
Description The database user's password. Default hqadmin
Known problem in HQ 4.2 (HQ-2151) with changing the database user username or password.
In HQ 4.2, changing either of the following server properties in server.conf causes the HQ Server to fail to start and to write "Access Denied" errors to server.log: server.database-user server.database-password To avoid this problem, in addition to changing the property value in server.conf, set the corresponding property in hq-engine/server/default/deploy/hq.ear/META-INF/ hibernate.cfg.xml to the new value. Those properties are: hibernate.connection.username hibernate.connection.password
10.2.9. server.database-url
Description The JDBC URL to connect to. Default jdbc:postgresql://127.0.0.1:9432/hqdb?protocolVersion=2
10.2.10. server.database-user
Description The database user to connect as. Default hqadmin
Known problem in HQ 4.2 (HQ-2151) with changing the database user username or password.
In HQ 4.2, changing either of the following server properties in server.conf causes the HQ Server to fail to start and to write "Access Denied" errors to server.log: server.database-user
71
Server Property Definitions server.database-password To avoid this problem, in addition to changing the property value in server.conf, set the corresponding property in hq-engine/server/default/deploy/hq.ear/META-INF/ hibernate.cfg.xml to the new value. Those properties are: hibernate.connection.username hibernate.connection.password
10.2.11. server.java.opts
Description Additional options to pass to Java. Default In HQ 4.2, default is: -XX:MaxPermSize=192m -Xmx512m -Xms512m -XX:+HeapDumpOnOutOfMemoryError In previous versions of HQ 4.x, the default was: -XX:MaxPermSize=192m -Xmx512m -Xms512m For information about changing heap size, see Increasing Java Heap and Changing GC Settings. For information about using different Java options when starting HQ Server, see Increasing Java Heap and Changing GC Settings. For information about how to change Java heap settings on Windows, see Changing Heap Size on Windows.
10.2.12. server.jms.highmemory
Description The high memory mark for the JMS queue. Default 350
10.2.13. server.jms.maxmemory
Description The max memory mark for the JMS queue. Default 400
10.2.14. server.mail.host
Description
72
Server Property Definitions The IP or hostname of the SMTP server that the HQ server will use for sending alerts and other HQ-related emails. Most UNIX platforms have a local SMTP server, in which case localhost or 127.0.0.1 can be used here. Default 127.0.0.1
10.2.15. server.quartzDelegate
Description The database-specific plugin class used by HQ's internal scheduler service. If you use Oracle as your HQ database, specify: org.quartz.impl.jdbcjobstore.oracle.OracleDelegate If you use the either HQ's internal PostgreSQL database or an external PostgreSQL database as your HQ database, specify: org.quartz.impl.jdbcjobstore.PostgreSQLDelegate Default org.quartz.impl.jdbcjobstore.PostgreSQLDelegate
10.2.16. server.webapp.port
Description The HTTP listen port. This is for the HQ web-based GUI and also HQ agents that communicate with the HQ server in non-secure mode Default 7080
10.2.17. server.webapp.secure.port
Description The HTTPS listen port. This is for the HQ web-based GUI and also HQ agents that communicate with the HQ server in secure mode Default 7443
73