print_event_repository_loader_status.py

The print_event_repository_loader_status.py script displays the statuses of the Event Repository Event Loader services running on the publishing server in a MATRIXX Engine.

Note: In multi-tenant MATRIXX installations, run this script on the base Event Repository only.

Syntax

print_event_repository_loader_status.py --host serverName|ipAddress --port portNumber [-u username] [[interval] [count]] [--version] [-s sub-domain] [-v] [--uri=full_MongoDB_uri] [--srv] [--eventDatabase TenantDatabaseName] [--authDatabase AuthenticationDatabaseName] [-h]

Options

The print_event_repository_loader_status.py script has the following options:

interval
The interval to wait before running the script (repeating the command) again. The interval is a number in seconds. The full interval is the number in seconds (specified) plus the command runtime.
count
The number of times to run the script (repeat the command) in succession. If you specify an interval without specifying a count, the script repeats the command indefinitely.
-u username, --user=username
Specify the MongoDB user to log in as.
-v, --verbose
Runs the script in verbose mode and returns more details as standard output.
--uri
The full URI for the MongoDB or MongoDB Atlas database. If the username or password has any special characters, they must be URI-encoded, for example, if the password has an @ character, it must be in the URI as %40. If the URI has an ampersand (&), the & must be escaped (preceded by a backslash (\&)) or the full URI must be inside quotes, for example:
uri=mongodb+srv://cluster0.8n9ep.mongodb.net/MtxEventDatabase?retryWrites=true\&option=value

uri="http://host/path?var1=val1&var2=val2"
Note: When entering the URI in create_config.py, if the URI has an &, it must be escaped (\&) to prevent the configuration file from becoming invalid. This option is needed only if there are other MongoDB driver parameters (like LDAP) that are not handled by the other options. If you specify a URI, and the event database is not MtxEventDatabase, you must also specify the --eventDatabase option.
--srv
If this parameter is specified, an SRV-based URI is generated for a MongoDB Atlas database. If this parameter is not specified, a regular MongoDB database URI is generated.
--version
Show the program version number.
--host=serverName|ipAddress
The MongoDB server to connect to. This option specifies the host name or IP address of a machine on which one of the mongod servers in your replica set is running. Connecting to a machine on which your primary mongod server is running is recommended.
--port
The MongoDB server port to connect to. Specify this option only if the port is not the default (27017).
-s, --sub-domain
Specifies the sub-domain where the Event Loader is (or was). Specify this option only if the sub-domain is not the default (SubDomainID).
--eventDatabase
(Optional) The name of the tenant database. Specify this option as needed for tenant repository queries. The default value is MtxEventDatabase. If you specify a URI, and the event database is not MtxEventDatabase, you must specify the --eventDatabase option.
--authDatabase
(Optional) The name of the database to be used for the authentication in the MongoDB URI. The default value is admin.
-h, --help
Show help about the script options.

Display Event Loader Service Status

This example displays the status of the Event Loader service (running on the publishing server) that loads events into the Event Repository. The example shows that the script is connected to machine with host name my-hostname-123 on which one of the mongod servers in the Event Repository replica set is running:

print_event_repository_loader_status.py --user MtxAdmin --host my-hostname-123
=======================================================================
print_event_repository_loader_status.py started on 2016-03-17 16:39:42
=======================================================================
 - Event Loader 0 (sub-domain 1, pid 21647, version 5000.41322): started 2016-03-17T22:02:58+00:00 on "my-hostname-123", backlog 1, last connected 2016-03-17T22:04:26+00:00,