boom Administration

  • boom server administration
  • boom agent administration
  • boom GUI administration


  • boom server administration


    Starting and Stopping the boom server

    On Unix systems:

    The boom server runs as daemon and is managed by the init scripts. To start or stop the server manually, enter the following command:

       /etc/init.d/boom_srv start | stop | status


    On Windows systems:

    The boom server runs as Windows service and is managed by the service control.




    Checking the boom server process

    On Unix systems:

    To check the boom server process, enter the following command:

       # ps -eo args| grep BOOMSERVER
    		    java -DBOOMSERVERPROC -Xmx512M -Dfile.encoding=UTF8
    		    -Dsun.net.inetaddr.ttl=300 -Djava.awt.headless=true -jar boom_server.jar
    	    

    The parameters limit the Java process heap to 512MB memory (Xmx) and restrict the TTL of the Java internal DNS cache to
    300 seconds. For production systems the Java heap size should be increased e.g. to 2GB: -Xmx2048MB. The startup parameters can be changed in the </opt/boom/server>/boom_srv startup script.

    To check the status of the boom server, enter the following command:

       /etc/init.d/boom_srv status





    boom server configuration file

    The boom server configuration file contains setup information for the server. The file is located in:

    <boom_server_installdir>/boom.props


    Configuration parameters:


    Parameter Default Description
    AGENT_PORT 23021 Defines the default Port on which the Agent will listen.
    This Parameter is used to generate the default Agent configuration settings when the agent deployment package is downloaded from the embedded HTTP server.
    MAIN_SERVER_PORT 23020 Defines the port on which the boom Server listens for Agent connections.
    This Parameter is used to generate the default Agent configuration settings when the agent deployment package is downloaded from the embedded HTTP server.
    GUI_PORT 23022 Defines the port on which the Server will listen for UI clients.
    HTTP_PORT 8888 (fixed) Defines the port for the embedded HTTP server.
    HB_INTERVAL 10 Heartbeat interval in seconds.
    LOGLEVEL 1 Loglevel of the Server 1 to 5 (1-errors only ... 5 support debug)
    AUTO_APPROVAL false (true|false) If this flag is set to true the boom server will automatically approve new boom agents and skip the manual approval process.
    CLUSTER_NODES - A list of hostnames or IP addresses of all boom Servers that might need to communicate with the Agent. All specified Servers can perform remote actions and initiate heartbeats on the Agent.
    This Parameter is used to generate the default Agent configuration settings when the agent deployment package is downloaded from the embedded HTTP server.
    PERF_TABLE_MAX_SIZE_MB 50 The boom Server will send a "major" indication if one of the performance tables exceeds the specified size (in MB). The Server will continue to log the performance data, but some of the history data should be removed.
    LOGDIR - Directory for logfiles of the Server.
    AUTO_ARCHIVE_DAYS - Server will archive closed indications automatically after specified amount of days.
    AUTO_DELETE_DAYS - Server will delete archived indications automatically after specified amount of days.
    AUTO_CLOSE_DAYS - Server will close active indications automatically after specified amount of days.





    boom database configuration files

    The boom server allows you to configure one single database for fault management and performance data or to configure a separate database only for performance data.

    The boom database configuration file db.props contains information which is necessary for the connection to the database. All fault management data are written to this database. The file is located in:

    <boom_server_installdir>/db.props



    Configuration parameters:

    Parameter Default Description
    EnPass - Defines the encrypted database password.
    DbName - Defines the name of the databse (boom)
    Host - Defines the FQDN of the database host.
    Driver Oracle.jdbc.OracleDriver Defines the driver for the boom DB connection.
    Password - Password field for encryption
    Login - Login name of the database user
    SID - Oracle system ID
    Port - Listener port



    boom server allows you to setup a separate database for performance data. The performance database configuration file db_perf.props contains information which is necessary for the connection to the performance database and can be configured separately from the main db.props file. All performance data are written to this database. Both db.props and db_perf.props can point to the same database. The file is located in:
    <boom_server_installdir>/db_perf.props



    Configuration parameters:

    Parameter Default Description
    EnPass - Defines the encrypted database password.
    DbName - Defines the name of the databse (boom)
    Host - Defines the FQDN of the database host.
    Driver Oracle.jdbc.OracleDriver Defines the driver for the boom DB connection.
    Password - Password field for encryption
    Login - Login name of the database user
    SID - Oracle system ID
    Port - Listener port





    boom server logfiles

  • LOGLEVEL:
    Set the server LOGLEVEL via the GUI Action "Set Server Log Level". In this case no server restart is required.
    You can also edit the boom.props file. In this case a restart is required (stop the server before changing the file).
    The LOGLEVEL can be set from 1 to 5 (1-errors only ... 5 support debug).

  • Logfile:
    Every time the boom server starts the following log file is created:
    /opt/boom/server/BOOMServer_<date>_#.log
    The logfiles are rotated very day. Logfiles older than 8 days are deleted.






  • boom agent administration



    Starting and Stopping the boom agent

    On Unix systems:

    The boom agent runs as a java process and is managed by the init scripts. To start, restart or stop the agent manually, enter the following command:

       /etc/init.d/boom_agt start | restart | stop | status


    On Windows systems:

    The boom agent runs as Windows service and is managed by the service control.




    Checking the boom agent process

    On Unix systems:

    To check the boom agent process, enter the following command:

       # ps -eo args| grep BOOMAGENT
    		    java -DBOOMAGENTPROC -jar boom_agent.jar
    	    

    To check the status of the boom agent, enter the following command:

       /etc/init.d/boom_agt status





    boom agent configuration file

    The install script creates the boom agent configuration file automatically. It contains setup information for the agent. The file is located in:

    <boom_agent_installdir>/conf/agent.conf

    IMPORTANT: Please stop the boom agent before modifying the configuration file. The agent overwrites any changes during shutdown. It's recommended to use the integrated GUI BOOM_AGENT Action to modify the configuration.


    Configuration parameters:

    Parameter Default Description
    AGENT_ID auto Do not change this field manually. It is created automatically during first clean start of the boom Agent.
    AGENT_PORT 23021 Defines the Port on which the Agent will listen.
    AGENT_HOST auto|manual Defines the Agents hostname. It will be determined automatically unless the FIXED_NAME parameter is set to true.
    AGENT_IP auto|manual Defines the Agents IP Address that it will report back to the Server. It will be determined automatically unless the FIXED_IP parameter is set to true.
    MAIN_SERVER_NAME auto|manual The boom Server hostname. This parameter is set by the boom Server when it creates the agent package.
    MAIN_SERVER_IP auto|manual The boom Server IP Address. The agent will determine the IP based on the Server name, if it is not defined.
    MAIN_SERVER_PORT 23020 Defines the port on which the boom Server listens. This parameter is set by the boom Server when it creates the agent package.
    HB_INTERVAL 5 Heartbeat interval in seconds.
    MAX_BUFFERED_MESSAGES 3000 Maximum number of indication or monitor values that can be buffered by agent when communication with Server lost. This value sets the limit for each kind of indications separately. In other words: 3000 indications, 3000 monitor values can be buffered. When the buffer is filled, the oldest indications and values will be dropped.
    DISABLED false (true|false) This parameter is set by the boom Server if an Agent needs to be disabled (e.g. for System Maintenance). In disabled mode the agent does not trigger any monitors and does not send any indications, but it will react on action requests from the Server.
    LOGLEVEL 1 Loglevel of the Agent 1 to 5. (1-errors only ... 5 support debug)
    LOGDIR - Specify the logfile directory for the boom Agent. Without this key the Agent will create the logfiles in its installation directory. For Agents on Windows Systems use doubled backslashes and double quote around the path. I.e.
    (Windows) LOGDIR="C:\\temp\\Boom Log Dir"
    (Unix) LOGDIR=/var/log/boom
    MODE 0 (0|7) The Mode Flag is used to specify the Firewall mode of the Agent.
    0 indicates that Agent will actively communicate with the Server. It will try to recognize if the Server is online, offline or firewalled and submit data to the Server.
    7 switches the Agent to a passive, listen only mode. The Agent will not actively send any heartbeat or data to the Server. The Server will take the responsibility to send the heartbeats and poll the data from the Agent. This mode is recommended to avoid unnecessary load on the firewall in environments where incoming traffic to the boom Server is not allowed and must be blocked by a firewall.
    FIXED_IP false (true|false) This flag turns the automatic detection of the IP address off or on. This IP address is send to the Server and defines how the Server can reach the agent.
    true - skips the detection of the IP address and use the IP that is specified in the AGENT_IP parameter. This can be used for multi-homed environments, where the agent might detect an internal IP, which the Server can not reach.
    false - the agent will automatically detect its IP address.
    FIXED_NAME false (true|false) This flag turns the automatic detection of the Agent hostname off or on. This hostname is send to the Server and defines under which name the Server can reach the agent.
    true - skips the detection of the hostname and use the name that is specified in the AGENT_HOST parameter. This can be used for multi-homed environments, where the agent might detect an internal system name, which the Server can not resolve.
    false - the agent will automatically detect its hostname.
    SHARED_IP false (true|false) Activate sending the Agent ID for NAT based environments. Setting this flag to true will instruct the Agent to include its ID in all communication to the Server, so that the Server can differentiate the Agents behind a NAT device. This does increase the network traffic, so it should only be turned on if necessary.
    CLUSTER_NODES - A list of hostnames or IP addresses of all boom Servers that might need to communicate with the Agent. All specified Servers can perform remote actions and initiate heartbeats on the Agent.
    If the boom Server is installed on a cluster, the active cluster node might use it's physical IP instead of the package/virtual/service IP to communicate with the Agent, so all cluster node IPs should be listed. This list can be used to implement other concepts like central development or configuration Servers.
    LOGSIZE in MB LOGSIZE 10 - Sets the maximum size per logfile e.g. to 10 MB.
    LOGCOUNT number LOGCOUNT 3 - Sets the maximum number of logfiles to e.g. 3.
    ACTIONS_ENABLED true (true|false) This flag is used to control remote actions. Set the flag to FALSE to reject all remote actions, auto-actions and operator initiated actions. Internal action won't be disabled e.g. BOOM_AGENT GET_ID.
    Manual steps are necessary to enable remote actions again:
    1. stop the agent
    2. set ACTIONS_ENABLED=true in agent.conf or remove the parameter
    3. start the agent
    MSD_MAX_PER_MINUTE number maximum messages per minute
    MSD_BLOCK_MINUTES number blocking period in minutes



    boom agent logfiles

  • LOGLEVEL:
    Set the agent LOGLEVEL via the GUI Action "Set Agent Log Level". In this case no agent restart is required.
    You can also edit the agent.conf file. In this case a restart is required (stop the server before changing the file).
    The LOGLEVEL can be set from 1 to 5 (1-errors only ... 5 support debug).

  • Logfile:
    Every time the boom agent starts the following log file is created:
    /opt/boom/agent/BOOMAGENT_<date>_#.log
    The logfiles are rotated very day. Logfiles older than 8 days are deleted.






  • boom agent configuration on cluster nodes (unix/linux)

    Cluster nodes might have additional virtual network interfaces and virtual names.

    The boom server - agent communication is name based, but also checks the originating IP addresses.

    Depending on OS and Cluster software, the communication from agent to server might use a virtual interface, leading to an address update on the server side

    Failover might cause confusion in the IP resolution if both cluster nodes are having agents


    For cluster nodes set the following flags in the agent.conf

    		SHARED_IP=true		#indicates that multiple agents might share one address
    		FIXED_IP =true		#skip IP detection on agent and bind connection to the configured address
    		FIXED_NAME=true		#skip hostname detection on agent and report configured name to server
    		AGENT_HOST=abc.domain.com
    		AGENT_IP=10.168.10.199
    		CLUSTER_NODES=list of boom servers	#e.g. netage-boo01, netage-boom02, netage-boomvirtual
    							all cluster nodes (physical and virtual) to which the 
    					  		agent connects
    		




    boom agents connecting to a clustered boom server environment

    boom agents connecting to a boom server which runs in a cluster environment have to set the following parameter in the agent.conf file

    		CLUSTER_NODES=list of boom servers	#e.g. netage-boo01, netage-boom02, netage-boomvirtual
    							all cluster nodes (physical and virtual) to which the 
    					  		agent connects
    		




    boom agent configuration in a SUN Solaris Global Zone

    In a SUN Solaris global zone only the agent PID must be used to control the agent (e.g. stop agent). Please proceed the following steps to configure PID-only agent control:

    1. Stop the agent: /etc/init.d/boom_agt stop
    2. Set the variable PID_ONLY in the /opt/boom/agent/boom_agt control file:
    PID_ONLY=true
    3. Start the agent: /etc/init.d/boom_agt





    boom GUI administration


    For the GUI administration please see GUI settings