- About Hyperic Server Configuration
- Server Property Definitions
- server.connection-validation-sql
- server.database
- server.database-blockingtimeout
- server.database-driver
- server.database-maxpoolsize
- server.database-minpoolsize
- server.database-password
- server.database-url
- server.database-user
- server.encryption-key
- server.hibernate.dialect
- server.java.opts
- server.jms.highmemory
- server.jms.maxmemory
- server.mail.host
- server.quartzDelegate
- server.webapp.port
- server.webapp.secure.port
- Clustering Properties in Hyperic Enterprise
About Hyperic Server Configuration
Configuration Settings in hq-server.conf
hq-server.conf contains the configuration settings that Hyperic Server requires to start up and get ready for work. For instance, hq-server.conf has properties that tell the server how to connect to the database and where to listen for agent and web application communications.
When you install Hyperic Server, the selections you can make - port selections, use of plaintext or SSL communications, and so on - correspond to properties in hq-server.conf. The configuration settings you supply during installation are persisted in ServerHome/conf/hq-server.conf.
In addition to the properties that reflect installation choices, hq-server.conf contains properties with default values that you can modify, after installation, based on the your environment and the size of your Hyperic deployment. For example, there are properties in hq-server.conf that set defaults for database and JMS configuration options.
Each time Hyperic Server starts up, it reads the values of the properties in hq-server.conf.
Note: Hyperic Server supports some properties that do not appear in hq-server.conf unless you add them explicitly.
After you change the values of properties in hq-server.conf or add new properties to the file, you must restart the server for the new settings to take effect.
Configuration Settings in the Database
Some of the configuration data that governs Hyperic Server behavior is stored in the Hyperic Server database. For example, the data Hyperic Server needs to contact an Hyperic Agent is stored in in the Hyperic Database. For information about how Hyperic Server obtains Hyperic Agent address information, see Agent Server Communications Diagram.
Server Property Definitions
server.connection-validation-sql
Description
The SQL query to run in order to validate a connection from the pool.
Default
server.connection-validation-sql=select 1
server.database
Description
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
server.database-blockingtimeout
Description
Maximum time in milliseconds to wait for a connection from the pool.
Default
10000
server.database-driver
Description
The JDBC driver to use. You shouldn't change this unless you really know what you're doing.
Default
None. The value is set as a result of the database selected during HQ Server installation.
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
100
server.database-minpoolsize
Description
The minimum number of database connections to keep in the pool
Default
5
server.database-password
Description
The database user's password.
Default
hqadmin
server.database-url
Description
The JDBC URL to connect to.
Default
None. The value is set as a result of the database selected during HQ Server installation.
| If you select... | the default database URL is... |
|---|---|
| HQ Built-in Databasel PostgreSQL | postgresql://127.0.0.1:9432/hqdb?protocolVersion=2 |
| Oracle | jdbc:oracle:thin:@localhost:1521:HYPERIC_HQ |
| MySql | jdbc:mysql://localhost:3306/HQ |
| PostgreSQL (external) | jdbc:postgresql://localhost:5432/HQ?protocolVersion=2 |
server.database-user
Description
The database user to connect as.
Default
hqadmin
server.encryption-key
Description
The key for decrypting the HQ database user password. The key must be at least 8 characters long, and can contain letters and numbers.
Default
None. The HQ installer prompts for server.encryption-key during HQ Server installation.
server.hibernate.dialect
Description
The database-specific dialect class used by Hibernate in HQ
Default
org.hyperic.hibernate.dialect.PostgreSQLDialect
server.java.opts
Description
Additional options to pass to Java.
Default
For For information about changing heap size, see Scaling and Tuning Hyperic Performance.
| Setting Hyperic Server Timzone You can set the time zone for the JVM in which Hyperic Server runs by adding -Duser.timezone=Area/Location to server.java.opts, where:
|
For information about using different Java options when starting Hyperic Server, see Scaling and Tuning Hyperic Performance.
server.jms.highmemory
Description
The high memory mark for the JMS queue.
Default
350
server.jms.maxmemory
Description
Configures the JMS broker memory limit.
If the broker memory limit is reached, the broker will block the send() call until some messages are consumed and space becomes available on the broker.
The recommended setting for server.jms.maxmemory is 90% of the Java heap size. Erratic alert behavior or missed alerts may indicate the settings are too low.
Default
400
server.mail.host
Description
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
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
None. The value is set as a result of the database selected during HQ Server installation.
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
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
Clustering Properties in Hyperic Enterprise
For information about properties for configuring an Hyperic Server cluster, see [Clustering Hyperic Servers for Failover].