Installation

All boom components are packaged in the boom.zip server package. The first installation step therefore is always the server installation. The installation of all other components can only be performed after the server is installed and running.

boom Server Installation

After downloading the latest package, unzip the package to the folder in which the server should be installed (e.g. C:\Program Files\boom\boom_server or /usr/boom/boom_server).
The installer is a java based program. Java needs to be in the search path of the system or user.

Make sure that your database is up and running.
For MySQL create a database user that has rights to create databases or create the databases BOOM and BOOM_PERF manually and give the database user full access rights on these two databases.
For Oracle create two users with identical password and rights as described in <boom_server>\ORACLE_SQL\step1_create_boom_db.sql. It is recommended to use separate tablespaces for BOOM and BOOM_PERF to be able to manage the server and performance data independently.

On Unix

The installation needs to be performed by a user that has administrative rights (i.e. root) to be able to add files to the system startup directories. As first step change the permissions of the install script to be able to execute it. Enter the following command:

chmod 750 install.sh

Run the installation script "install.sh" by entering
./install.sh

The script will trigger the installer which queries the configuration settings, updates the configuration files and performs all steps that are necessary to install the server. The installer can handle most Linux distributions, HP-UX, SUN Solaris and Windows. In most cases the default values that are proposed by the installer can be used without change, so only the database type and authentication information needs to be entered. If necessary the configuration can always be changed by running the installer again or by editing the property files as described below.

Manual Installation on Unix

For platforms that are not fully supported by the installer or if for some reasons the install program should not be used, the following steps need to be performed manually to install the server:

  • Create the databases and initial table data by executing either the MySql or the Oracle SqlPlus command
    mysql -u root -p </usr/boom/boom_server/step1_create_boom_db.sql
    or
    sqlplus <user>/<password>@<tnsname> </usr/boom/boom_server/ORACLE_SQL/step1_create_boom_db.sql
    Attention: existing tables will be deleted and re-created!
  • For MySQL edit the database configuration file /usr/boom/boom_server/db.props and update it with the MySQL instance and logon information
    For Oracle move the database configuration file from /usr/boom/boom_server/ORACLE_SQL/db.props to /usr/boom/boom_server/db.props. Update the file with the Oracle instance and logon information.
  • Edit the server management script boom_srv. Set the BOOM_SERVER variable to the installation directory, the JAVA and PATH information as described in the file.
  • Edit the server rc scripts ux_daemon.cfg/boom_srv exactly with the same information as above.
  • Copy the server rc script from ux_daemon.cfg/boom_srv to the init.d directory of the system. The exact location varies depending on the platform.
  • Create the symbolic links in the rc level directories as required and use the insserv command if available. The location and the meaning of these vary for the different platforms.
  • Verify that all configurations are done correctly by starting the server with e.g.
    /etc/init.d/boom_srv start
    Check if any errors showed up or are logged in the server's log file in <install_dir>/BOOMServer_<date>.log

    On Windows

    Verify that Java is in the System Search Path.
    The installation needs to be performed by a user that has administrative rights (i.e. Administrator) to be able to add the Windows Service. On platforms with enabled UAC like Windows Vista and Server 2008 the commands must be executed with advanced privileges.
    Open a command window by selecting Start->Run... or Start->Search and enter cmd, press OK (or right click and choose "Run as Administrator).
    In the command window change to the installation directory and run the installer by entering

    cd <install dir> (e.g. cd c:\Program Files\boom\boom_server)
    install.cmd
    The script will trigger the installer which queries the configuration settings, updates the configuration files and performs all steps that are necessary to install the server.
    In most cases the default values that are proposed by the installer can be used without change, so only the database type and authentication information needs to be entered. If necessary the configuration can always be changed by running the installer again or by editing the property files as described below.

    Manual Installation on Windows

  • Create the databases and the initial table data by executing either the MySql or the Oracle SqlPlus command
    mysql -u root -p <C:\Program Files\boom\boom_server\step1_create_boom_db.sql
    or
    sqlplus <user>/<password>@<tnsname> <C:\Program Files\boom\boom_server\ORACLE_SQL\step1_create_boom_db.sql
    Attention: Existing tables will be deleted and re-created!
  • For MySQL edit the database configuration file C:\Program Files\boom\boom_server\db.props and update it with the MySQL instance and logon information
    For Oracle move the database configuration file from C:\Program Files\boom\boom_server\ORACLE_SQL\db.props to C:\Program Files\boom\boom_server\db.props. Update the file with the Oracle instance and logon information.
  • Open a command window by selecting Start->Run... and enter cmd, press OK.
    In the command window change to the installation directory by entering
    cd <install dir> (e.g. cd c:\Program Files\boom\boom_server)
    Register the boom Server as Windows Service with the command:
    booms_service_setup.exe -i
    Note: On platforms with UAC like Windows Vista and Server 2008 the command must be executed with advanced privileges.
  • Verify that all configurations are done correctly by starting the server with the Windows Service Control Panel. Check if any errors showed up or are logged in the server's log file in <install_dir>/BOOMServer_<date>.log

     

    boom Agent Installation

    Play video:  boom Agent installation (Linux/Unix)  

    The Agent packages are placed on the server and can be downloaded from its built-in web server. The server will prepare the agent configuration files and generate the packages when a download request is received. Therefore it is mandatory to at least once download an agent from this web server to have all packages build. Afterwards the packages can be also copied by other means to the target systems.
    To download the agent point your browser to the following address: http://<server-name>:8888

    Unzip the boom Agent package to the folder in which the agent should be installed (e.g. C:\Program Files\boom\boom_agent or /usr/boom/boom_agent).

    On Unix

    As first step change the permissions of the install script to be able to execute it. Enter the following command:

    chmod 750 install

    Run the installation script "install". It will query the configuration settings, update the configuration files and perform all steps that are necessary to install the agent. The script can handle most Linux distributions, HP-UX, SUN Solaris and VMWare ESX.
    For others some manual steps might be required e.g. to integrate the server with the system start-up and shutdown routines.

    Manual Installation

    If for some reasons the install script should or cannot be used, the following steps need to be performed manually to install the server:

  • Verify that the boom Server name and port settings are correctly entered in the configuration file conf/agent.conf
    All other values will be filled automatically by the agent.
    Note: Do not change this file while the agent is running, since the agent will overwrite it.
  • Edit the agent's management script boom_agt. Set the BOOM_ROOT variable to the installation directory, the JAVA and PATH information as described in the file.
  • Edit the agent's rc scripts ux_daemon.cfg/boom_agt exactly with the same information as above.
  • Change the file permissions to have full access (read, write, execute) for the root user.
  • Copy the agent's rc script from ux_daemon.cfg/boom_srv to the init.d directory of the system. The exact location varies depending on the platform.
  • Create the symbolic links in the rc level directories as required. The location and the meaning of these vary for the different platforms.
  • Verify that all configurations are done correctly by starting the agent with e.g. /etc/init.d/boom_agt start Check if the Service is running or any errors are logged in the agent's log file in <install_dir>/BOOMAgent_<date>.log

    Non-Root Agent

    To start agent as non-root user, set variable USER in boom_agt script in agent installation directory and restart agent.

    Note: Some of the monitoring policies and packages has to be adapted to non-root restrictions (default SNMP trap receiver port cannot be used, no access to certain log files or executables, ...).

    On Windows

    On the Windows platform only two steps are need to install the agent:

  • Verify that the boom Server name and port settings are correctly entered in the configuration file conf/agent.conf
    All other values will be filled automatically by the agent.
    Note: Do not change this file while the agent is running, since the agent will overwrite it.
  • Open a command window by selecting Startmenu->Run... and enter cmd, press OK.
    In the command window change to the installation directory by entering
    cd <install dir> (e.g. cd C:\Program Files\boom\boom_agent)
    Register the boom Agent as Windows Service with the command:
    booma_service_setup.exe -i
    Note: On platforms with UAC like Windows Vista, Server 2008 the command must be executed with advanced privileges.
  • Verify that all configurations are done correctly by starting the agent with the Windows Service Control Panel. Check if any errors showed up or are logged in the agent's log file in <install_dir>/BOOMAgent_<date>.log

    Non-Root Agent

    The non-root agent is only supported on Linux/UNIX servers.


    Assignment Group "BOOM"

    For full agent functionality, deploy the Assignment Group "BOOM" to the agent, which contains the policy "BOOM_Messages" for internal messages and the package "BoomJavaMonitors" for agent specific Java classes.


    boom Client/User Interface

    Download the boomgui package that suits your platform from the Server's web page as described for the agent.

    Unzip the package to the folder in which the user interface should be installed (e.g. C:\boom\boom_gui or /usr/boom/boom_gui).
    No further installation steps are necessary. Java needs to be in the current user's search path in order to startup the GUI.
    Start the user interface by executing the boomgui program.

    Note: If there is an older client version installed, run "boomgui -clean" to empty precompiled classes and hashes otherwise unpredictable behaviour can occur.