Chapter 2. General Management

This section covers the configuration, files, and options for the JBoss Operations Network server and agents.

2.1. JBoss ON File Locations

This section covers the common files and directories by JBoss ON servers and agents. A basic reference for these files can make managing and troubleshooting JBoss ON easier.

2.1.1. Server File Locations

All JBoss Operations Network servers are installed in a single, user-defined server root directory. In the documentation and examples, this is called serverRoot. The directory layout within that server root directory are the same for every server.
                           serverRoot
                               |
                              jon
                               |
      ----------------------------------------------------------
      |          |     |      |       |        |       |       |
alert-scripts/  bin/  etc/  EULA  jbossas/  LICENSE  logs/  plugins/
The directories and files that are most commonly used to managed JBoss ON servers are listed in Table 2.1, “Server Directories and Files”. The server root varies for each installation and each platform, but the layout of the JBoss ON subdirectories is the same for every platform.

Table 2.1. Server Directories and Files

Configuration Area Directory or File Location Description
Configuration directory serverRoot/bin/ Contains the server start scripts, PID files, and configuration file.
Start scripts serverRoot/bin/rhqctl The management script which is used to start and stop, install, and upgrade the server, storage nodes, and local agents.
Server configuration file serverRoot/bin/rhq-server.properties The configuration file for all server settings that are not stored in the JBoss ON database.
Storage node configuration file serverRoot/bin/rhq-storage.properties The configuration file for all storage node settings that are not stored in the JBoss ON database.
Password hash script serverRoot/bin/rhq-encode-password.{sh|bat} For a migrated server, it generates an encoded form of the database password to use in the rhq-server.properties file.
SNMP files serverRoot/etc/RHQ-mib.txt The JBoss ON MIB file to use for setting SNMP traps.
Log files serverRoot/logs/ The JBoss ON server log files are automatically created in this directory. The current log is named rhq-server-log4j.log. Older log files are named rhq-server-log4j.log.#, and the higher the number, the older the log file.
Custom plug-in deployment directory serverRoot/plugins/ The directory where custom plug-in files can be dropped for them to be automatically detected and polled by the JBoss ON server.
JBoss AS directory serverRoot/jbossas/ Contains all of the required JBoss AS client and server libraries. [a]
Server JAR files serverRoot/jbossas/default/deploy/rhq.ear/ Contains all of the JAR files used by JBoss ON servers, web interface, and clients.
Server-side plug-ins directory serverRoot/jbossas/default/deploy/rhq.ear/rhq-serverplugins/ Contains all of the JAR files for the default JBoss ON server-side plug-ins.
Agent plug-ins directory serverRoot/jbossas/default/deploy/rhq.ear/rhq-downloads/rhq-plugins/ Contains all of the JAR files for the default JBoss ON agent plug-ins.
Server-side plug-ins directory serverRoot/jbossas/default/deploy/rhq.ear/rhq-serverplugins/ Contains all of the JAR files for the default JBoss ON server-side plug-ins.
Agent package directory serverRoot/jbossas/default/deploy/rhq.ear/rhq-downloads/rhq-agent/ Contains the snapshot packages for the JBoss ON agent.
Web interface directory serverRoot/jbossas/default/work/jboss.web/localhost/ Contains the directories that hold the files for rendering the web interface.
[a] Most of the libraries and files in this directory don't relate directly to JBoss ON.

2.1.2. Agent File Locations

Like the server, the JBoss ON agent is installed in a single, user-defined root directory. All of the agent files and directories are under the rhq-agent/ directory in that root directory.
                   serverRoot
                       |
                  rhq-agent/
                       |
      ------------------------------------
      |      |     |      |      |       |
     bin/  conf/  data/  lib/  logs/  plugins/

Table 2.2. Agent Directories and Files

Configuration Area Directory or File Location Description
Start scripts serverRoot/rhq-agent/bin/ Contains the agent start scripts.
Configuration file serverRoot/rhq-agent/conf/agent-configuration.xml The configuration file for basic agent settings.
Library files serverRoot/rhq-agent/lib/ Contains the libraries used by the agent to monitor resources.
Start scripts serverRoot/rhq-agent/logs/ The JBoss ON agent log files are automatically created in this directory. The current log is named agent.log. Older log files are named agent.log.#, and the higher the number, the older the log file.
Plug-ins directory serverRoot/rhq-agent/plugins/ Contains the plug-ins used by the agent for managing resources (like editing resource configuration).

2.1.3. Storage Node File Locations

The storage node is installed within the server's directory, /opt/jon/jon-server-3.3.0.GA.
                   serverRoot
                       |
                  jon-server-3.3.0.GA/
                       |
      -----------------------------------------
      |      |     |           |      |       |
     bin/  conf/  interface/  lib/   pylib/  tools/
Additionally, there is a separate directory which stores all of the metrics data and backup data.
           /opt/jon
                |
            rhq-data/
                |
      ---------------------
      |            |      |
     commit_log/  data/  saved_caches/

Table 2.3. Storage Directories and Files

Configuration Area Directory or File Location Description
Distributed database scripts serverRoot/rhq-storage/bin/ Contains the scripts used to manage the distributed database nodes. These are invoked most frequently by the JBoss ON agent which manages the storage node, not the administrator.
PID file serverRoot/rhq-storage/bin/cassandra.pid The PID file for the node process.
Configuration file serverRoot/rhq-storage/conf/rhq-storage-auth.conf The configuration file for basic storage node settings.
Logging configuration file serverRoot/rhq-storage/conf/log4j-server.properties The configuration file for log4j for the storage node.
Library files
  • serverRoot/rhq-agent/lib/
  • serverRoot/rhq-agent/pylib/
  • serverRoot/rhq-agent/tools/
Contains the libraries used by the storage node.
Data files serverRoot/rhq-data/ The parent directory for the data, cache files, and backups for the distributed storage database notes.
Data files serverRoot/rhq-data/commit_log/ Contains binary commit logs which store write operations before they are written to the storage database.
Data files serverRoot/rhq-data/saved_caches/ Contains database cache files for each database in the data/ subdirectories.
Data files serverRoot/rhq-data/data/ Contains data files and snapshots for the node, organized by the keyspace and the table. There are four keyspaces: rhq, system, system_auth, and system_traces.
Data files serverRoot/rhq-data/data/rhq/ Contains data for all the metric tables. This is all of the new (raw) metrics and tables for each level of aggregation (one hour, six hour, and 24 hour). This also contains schema and index information for the version of metrics being collected.
Data files serverRoot/rhq-data/data/system/ Contains information for the distributed database nodes.
Data files serverRoot/rhq-data/data/system_auth/ Contains information for the credentials, users, and permissions configured for the distributed database.
Data files serverRoot/rhq-data/data/system_traces/ Contains information on database sessions and events.