Skip to content

Using the maintenance console

This page describes the KXS maintenance console, its capabilities, and how to launch and alias it using kxsctl mc.

The maintenance console loads Sensors libraries related to HA maintenance, database management, SAPI invocation, DB verification, DBC (Database Copy) and general system diagnostics. It allows you to issue administrative commands such as `.maint.ha`state`, `.maint.ha`feeds`, and `.maint.dbc[`copy …]`.

You can run multiple instances of the maintenance console at the same time if required.

Syntax kxsctl mc [name]* [flags]
Flags -p (port) — sets the desired port. *Mandatory.

Set up a Maintenance Console alias

The mc (Maintenance Console) script requires a name or alias before you can use it. Your alias can consist of a name (your_name), your initials (ab) or the name of the process that you wish to look at (dbw).

For example:

alias abc="kxsctl mc"

Start a Maintenance Console session

  1. Run the following command:

    kxsctl mc <your alias>

  2. When the system logs generated by process startup finish displaying, press Enter to access the q prompt.

    2023.05.18 17:07:51.453 INFO  [lg] LOG Loading config/logWatch.yaml
2023.05.18 17:07:51.454 INFO  [lg] LOG lg initialization complete
2023.05.18 17:07:51.454 INFO  [lg] DISC Subscribing to key `/config/processVersion
2023.05.18 17:07:51.454 INFO  [lg] LOG Framework initialization complete
q)2023.05.18 17:07:51.454 DEBUG [lg] MON Performing daily reset of monitoring statistics
2023.05.18 17:07:51.454 INFO  [lg] LOG Deleting QR client request records older than 2023.05.18 05:07:51.454727386
2023.05.18 17:07:51.454 INFO  [lg] DISC Received update for /config/nodeState
2023.05.18 17:07:51.454 INFO  [lg] HA New registry node state:
2023.05.18 17:07:51.454 INFO  [lg] HA  node| host                       user  baseport  ts                            state auto
2023.05.18 17:07:51.454 INFO  [lg] HA  ----|-----------------------------------------------------------------------
2023.05.18 17:07:51.455 INFO  [lg] HA  A    | kxsa.firstderivatives.com  root  20000     2023.05.17D17:02:26.741805777 03 1
2023.05.18 17:07:51.455 INFO  [lg] HA  B    | kxsb.firstderivatives.com  root  20000     2023.05.17D17:02:26.759721355 03 1
2023.05.18 17:07:51.456 INFO  [lg] DISC Discovery changes, scs=`maint`rt deleted=`rt/sub1`rt/sub2
q)

Stop a Maintenance Console session

Run the following command to exit the q prompt:

\\

Start/stop a Maintenance Console from the IDE

You can start/stop maintenance consoles directly from Analyst/IDE in KXS 3.0. To do so, connect to Analyst/IDE in a web browser of your choice. You can then run the following commands to start/stop maintenance consoles:

.ide.startMaint`example // Starts a MAINT with the name example (local node)
.ide.stopMaint`example // Stops MAINT with the name example (local node)

.ide.startMaint_[`example;`B] // Starts a MAINT with the name example (remote node)
.ide.stopMaint`example // Stops MAINT with the name example (remote node)

Once the maintenance console has started, you can remotely connect to the process by opening a "Remote Scratchpad" (same procedure as connecting to any other process).

Note

If the IDE from which the maintenance console was started is stopped, the maintenance console will also be stopped. The same restrictions as imposed by kxsctl also apply, such as not permitting two maintenance consoles with the same name to be started.

Next steps