wiki:Software/Configuration/Files

Version 9 (modified by smith@…, 5 years ago) (diff)

--

Raptor File Listings

This page contains a listing of the main files installed by each Raptor package, along with a brief description of the purpose of that file.

Note that the files in bold are considered system files and may be overwritten on upgrade. Those not in bold are considered user configuration files and will not be overwritten on upgrade (unless otherwise noted in the release notes for a particular version)

Raptor ICA

Within the Raptor ICA's home directory (/opt/raptor/ica on linux, C:\Program Files\Raptor\ICA on Windows) are the following files:

  • raptor-ica.jar - The main Raptor ICA classfile.
  • conf/ - Contains all configuration files for the Raptor ICA.
    • conf/event-parse-formats-custom.xml - custom configurations can be added here, for parsing arbitrary log files.
    • conf/event-parse-formats-system.xml - configures how the ICA parses log files.
    • conf/event-parse.xml - configures which log files the ICA is monitoring.
    • conf/event-release.xml - configures the event release policies for the ICA.
    • conf/ica-core.xml - the core ICA springbean configuration file.
    • conf/logging.xml - configures logging for the ICA. Change level within to DEBUG to generate more detailed logging.
    • conf/metadata.xml - configures the ICA instance's information such as name. Used in the UI and stored in the database.
    • conf/server.properties - configures Jetty - which port the ICA's webserver should run on''
  • lib/ - contains all libraries used by the Raptor ICA.
    • lib/*.jar - many java library files.
  • keys/ - contains the Raptor ICA's keystore and truststore.
    • keys/raptor-ica.jks - contains the Raptor ICA's public and private keys used for secure communication.
    • keys/raptor-ica-public.crt - the PEM encoded version of the ICA's public key extracted from raptor-ica.jks
    • keys/authorised-keys.jks - contains the public keys of every MUA the ICA is authorised to communicate with.
  • logs/ - contains the Raptor ICA's log files
    • logs/raptor-ica-process.log - the main log file for the ICA.

Raptor MUA

Within the Raptor MUA's home directory (/opt/raptor/mua on linux, C:\Program Files\Raptor\MUA on Windows) are the following files:

  • batchimport - contains various directories where you can drop old log files for batch parsing.
  • conf/ - Contains all configuration files for the Raptor MUA.
    • conf/attribute-association.xml - configures how the MUA pulls in extra information from a data source (e.g. dept/affiliation) to enrich the stats data
    • conf/batch-event-parse-formats-custom.xml - custom configurations can be added here, for parsing arbitrary log files.
    • conf/batch-event-parse-formats-system.xml - configures how the MUA parses log files.
    • conf/batch-event-parse.xml - configures which batchimport directories the MUA is monitoring.
    • conf/database.xml - configures how the MUA connects to a database to store events.
    • conf/event-release.xml - configures the event release policies for the MUA.
    • conf/logging.xml - configures logging for the MUA. Change level within to DEBUG to generate more detailed logging.
    • conf/metadata.xml - configures the MUA instance's information such as name. Used in the UI and stored in the database.
    • conf/mua-core.xml - the core MUA springbean configuration file.
    • conf/server.properties - configures Jetty - which port the MUA's webserver should run on''
    • conf/statistical-processors.xml - the statistical processing options that this MUA supports.
    • conf/statistical-unit-custom.xml - custom configurations can be added here, for custom graph options on Web's Graph builder page.
    • conf/statistical-unit-system.xml - the statistical units options that this MUA supports - mainly the dashboard stats.
    • conf/users.xml - not currently used.
    • conf/web.xml - the servlet's configuration.
  • data/ - contains the HSQLDB used by the Raptor MUA.
  • lib/ - contains all libraries used by the Raptor MUA.
    • lib/*.jar - many java library files.
  • keys/ - contains the Raptor MUA's keystore and truststore.
    • keys/raptor-mua.jks - contains the Raptor MUA's public and private keys used for secure communication.
    • keys/raptor-mua-public.crt - the PEM encoded version of the MUA's public key extracted from raptor-mua.jks
    • keys/authorised-keys.jks - contains the public keys of every MUA the MUA is authorised to communicate with.
  • logs/ - contains the Raptor MUA's log files
    • logs/raptor-mua-process.log - the main log file for the MUA.

Raptor Web

Within the Raptor Web's home directory (/opt/raptor/web on linux, C:\Program Files\Raptor\Web on Windows) are the following files:

  • raptor-web.jar - The main Raptor Web classfile.
  • conf/ - Contains all configuration files for Raptor Web.
    • conf/dashboard-statistics.xml - Contains the list of stats to compute on the dashboard.
    • conf/logging.xml - configures logging for RaptorWeb. Change level within to DEBUG to generate more detailed logging.
    • conf/metadata.xml - configures this RaptorWeb instance's information such as name. Used in the UI and stored in the database.
    • conf/mua-endpoints.xml - configures the MUA that RaptorWeb should connect to.
    • conf/server.properties - configures Jetty - which port RaptorWeb's webserver should run on''
    • conf/users.xml - where usernames and passwords for RaptorWeb users are configured.
    • conf/web-core.xml - the core Web springbean configuration file.
  • lib/ - contains all libraries used by Raptor Web.
    • lib/*.jar - many java library files.
  • keys/ - contains the Raptor ICA's keystore and truststore.
    • keys/raptor-webjks - contains RaptorWeb's public and private keys used for secure communication.
    • keys/raptor-web-public.crt - the PEM encoded version of RaptorWeb's public key extracted from raptor-web.jks
    • keys/authorised-keys.jks - contains the public keys of every MUA that this RaptorWeb is authorised to communicate with.
  • logs/ - contains RaptorWeb's log files
    • logs/raptor-web-process.log - the main log file for RaptorWeb.