Event Repository Quick Start (Non-Sharded)

The topics in this section serve as a quick start guide for setting up Event Repository on a MongoDB deployment that does not use sharding (non-sharded). If you plan to have a sharded cluster, refer to the quick start guide for setting up Event Repository on a sharded MongoDB deployment.

The following is a summary of tasks for setting up the Event Repository on a non-sharded MongoDB deployment. The summary can be used as a task checklist during setup. Refer to a task-related topic for details about performing each task.

Important: While these instructions have quick start guidelines for installing and configuring MongoDB for your Event Repository, refer to your MongoDB product documentation as the primary source of information about installing, provisioning, and managing your MongoDB system. To plan your MongoDB system, be familiar with MongoDB operations, networking, and security best practices.
  1. Install MongoDB on every host server where database processes/tools run.

    You must purchase and install MongoDB individually.

  2. Install the PyMongo driver on every host server where database processes/tools run.
  3. (Recommended) Perform pre-requisite tasks on mongod host servers so that you can put indexes on SSDs (create a soft link index and create target index directory so that the index files MongoDB creates are stored there).
  4. Create a key file and distribute a copy to all host servers where any MongoDB process runs.
  5. Edit configuration options for each MongoDB instance. Set the MongoDB configuration file options for each member of your replica set (set values for base settings and instance-specific settings in the instance .conf file).
  6. Start all mongod instances on each of the host servers in your deployment.
  7. Initiate the replica set of your deployment.
  8. Create users for the replica set of your deployment.

    You must be connected to a primary to create the users. Minimum users needed are the MtxAdmin and MtxEventLoader users.

    If you plan to use MATRIXX GL utilities to process GL information from your Event Repository, you must create MongoDB users to be used by the utilities.

  9. Download the MATRIXX Engine to obtain Event Store administration scripts (which are included in the MATRIXX Engine RPM).
  10. Perform required setup for running the Event Repository administration scripts such as creating script user credentials.
  11. Run the Event Repository administration script that saves a partition-method configuration and index definitions to your database (MtxEventDatabase).

    (GL Processing Only) Manually add GL index definitions before running this script. If you plan to use MATRIXX GL utilities to process GL information from your Event Repository, you must add additional indexes.

  12. Run the Event Repository administration script that checks the partition-method configuration and index definitions to ensure they are correct.
  13. Manually add any custom indexes. For example, you can add indexes for TTL (if you plan to add TTL to the statuses and trace collections, you must add additional indexes).
  14. Run the Event Repository administration script that adds the indexes and collections (based on the saved partition and index configurations) to MongoDB (MtxEventDatabase).
  15. Install MATRIXX Engine software (if you have not already done so).
  16. Configure MATRIXX Engine.
  17. As part of configuring MATRIXX Engine, answer the create_config.info configuration questions that pertain to the Event Repository. For details about each configuration question, see the discussion about MATRIXX Event Repository configuration in MATRIXX Configuration. You must configure the Event Loader connection string for connecting to MongoDB.
  18. (GL utilities Only) Verify that the GL utilities are configured to connect to your MongoDB system. Set the GL utilities connection string for connecting to MongoDB. See the related task about setting the MongoDB connection string for GL utilities.
  19. Start the MATRIXX Engine.

    When you start the engine, the publishing server starts and the Event Loader service that is part of the software stack on the publishing server is started.

  20. Run a workload.
  21. Verify that events are being loaded into MongoDB by the Event Loader.

Event Repository setup is complete.

When MEFs are generated, the Event Loader service loads event objects into the Event Repository. You can verify event objects are loaded by running a workload and querying the document count in the EventCollection. Three scripts can be used to monitor the MATRIXX Event Store and verify events are being loaded: print_event_repository_loader_stats.py, print_event_repository_loader_status.py, and print_event_repository_loader_trace.py. You can view configuration information and statistics about the event store by running Event Repository administration scripts.