Binary Packages

Scripts, executables and configuration files that belong to one monitoring area or to one Management Plug-In are grouped together in so called Binary Packages. These packages are directly reflected on the file system structure of the boom server.

As you can see from the picture, the content of the package (Package_ABC folder) will be deployed to the default package location on the agent (%BOOM_ROOT%/spi/) without the package name. Any subdirectory structure below the package folder will be reflected ‘as is’ on the agent side. The %BOOM_ROOT%/spi directory is the default working directory for all monitor calls and triggers that are declared in the Policies.
Please note: The files in the different binary packages must have unique names to avoid conflicts. Therefore it is recommended to place these files into a uniquely named subfolder below the package name directory. Just the package property file should be placed in the top level folder (Package_ABC/) and the Java Monitors have to be placed in the predefined location (Package_ABC/jars/).

The boom GUI reflects the file structure that is stored on the boom Server system (srv/packages/). For the creation of a new Binary Package it is enough to create a new directory under srv/packages/. Changes on the server side are automatically reflecting in the boom Client. The boom GUI also provides helper file oriented actions in the Packages view. Together with the integrated editor that allows editing the server side files it helps to maintain Packages even without direct access to the boom Server.

The deployment on single file level is not supported. You can deploy the Binary Packages directly or as part of an Assignment.

Note:
The renaming of the top package folder directly on the file system will cause problems in the assignment tree and on the stored assignments. Please use the boom GUI Action "Rename package" for this purpose.

During the deployment of a Package, the content of the Package folder will be copied to the remote agent system.

All Java Monitors (if any) in a Package must be delivered as .jar files and must be placed in: 

srv/packages/Package_ABC/jars/*.jar
The boom Agent automatically recognizes the jar files and loads them without a restart.

If the Package contains the property file named <packageName>.props - the boom Agent will try to perform special processing steps during the deployment. This file can be used for defining STOP and START commands when the package has a stand-alone collector running separately from the agent. 

      # Package_ABC property file
      # command to start collector (relative to %BOOM_ROOT%/spi/)
      START=pkgABC_bin/init.sh -start
      # command to stop collector (relative to %BOOM_ROOT%/spi/)
      STOP=pkgABC_bin/init.sh -stop
      # timeout in seconds for both commands
      TIMEOUT=30
When an agent recognizes the Package property file, it will execute the START/STOP commands when the boom Agent gets started or stopped. During the package distribution the agent will execute the STOP command, (re)places files and triggers START as the last step. This allows replacing the files without running into trouble with files that are locked by a running collector.

Note: If a Binary Package is no longer needed on the agent side, the deployed files can be simply removed.