The Admin Console

The admin console can be started running


This is the main administration console for the LeanXcale. The console allows the user to check and manage the configuration of a LeanXcale instance. The console can be run through full command names or by the short numbers that appear between brackets.

These are the main functions you can do through the console:

Common functions

  • [0] quit: quits the current lxConsole

  • [1] help: prints the list of available commands

  • [2] components: Shows a list of all the components and its acronyms

  • [3] running [component]: Shows a table with the current running instances for each component. If the argument component is given, it prints the instnaces running for that component

  • [4] deads [component]: It is not common to have dead components, but in case of a failure or machine crash, this option can show components that were already up, running and registered and then are lost. If the argument component is provided, then the command will give the dead instances for that specific kind of component.

  • [6] halt [component [instanceId]]: halts LeanXcale, a set of components or a specific component. This command accepts component, to kill all the running instances of a given component. In addition to the first argument, another argument can be added to halt only an instance of a component.

  • [8] trace [nLines]: prints the nLast traces of LeanXcale. This trace contains the registered, failed, recovered and stopped instances.

  • [15] listServers: List all Datastore available servers.

  • [16] listRegions [table]: List all data regions (different partitions) of a table.

  • [38] getAlerts: Show alerts stored at LeanXcale Alert Manager

Data Distribution & Replication Functions

  • [17] moveRegion [table regionId DSsource DStarget]: Move a data region of a table from one Datastore server to another.

  • [18] splitTable [table splitKey DStarget]: Split a table by the split key and move the new region to another Datastore server.

  • [19] splitTableUniform [table splitKeyMin splitKeyMax NumOfSplits]: Split a table in NumOfSplits points between a min and max key range, and distribute (round robin) the partitions among all the available Datastore servers.

  • [25] replicateRegion [table minKey DStarget]: Replicate a data region into another Datastore server, starting from the suplied minKey.

  • [26] removeReplica [table minKey DStarget]: Remove a replicated data region from a Datastore server.

  • [27] joinRegion [table joinKey]: Join two different data regions, by the specified joinKey.

  • [28] increaseTable [table DStarget stategy min max]: Add a new data region to a table. Defining the strategy for just add or re-size all the existing data regions.

  • [29] decreaseTable [table DStarget stretegy]: Delete a data region of a table. Defining the strategy for just remove it, or re-size all the left partitions.

  • [30] listServer [DStarget]: List all the data regions available on a given Datastore server.

  • [31] cloneKVDS [DSsource DStarget]: Replicate all the data regions of a Datastore server into another.

Advanced Functions

  • [5] buckets: The concept of bucket is related with the way table keys are distributed among conflict managers to scale conflict management. The command gives the current assignation of buckets.

  • [7] loggers: Shows how transaction logs are assigned to Query Engine and local transaction managers.

  • [9] zkTree [path]: this is a tool to recursively print the Apache ZooKeeper tree from the path provided. If path is not provided, the default value is /leanxcale

  • [10] zksts: Prints the current persisted snapshot. This command also return the current snapshot of the system.

  • [12] markAsRecovered [component [instanceId]]: Marks a dead instance as recovered.

  • [13] csDiscardLtm [instanceId]: Discard the selected LTM for the commit sequencer. Disable a client.

  • [14] setLogger [component [instanceId]]: Manually assign a transaction logger for a LTM.

  • [20] startGraph: Show the dependencies between components at start time.

  • [21] kiviSts: Show the latest STS persisted at the Datastore.

  • [22] cgmState: Show the Configuration Manager component operative state.

  • [23] persistKiviSts: Persist STS manually to the Datastore.

  • [24] getEpoch: Show the different system configurations through the time

  • [32] setKvconPath [path]: Set the path for the kvcon (direct datastore console) command.

  • [33] kvcon [command]: Sent a command to the kvcon console.

  • [34] kiviRecoveryStats: Show the stats for the recovery process over each Datastore.

  • [35] syncDS [DStarget]: Force sync data to disc for the specified Datastore servers.

  • [36] getProperty: Show LeanXcale startup properties

  • [37] getOsts: Show the oldest STS of the actual transaction ongoing in the LeanXcale.

  • [39] kvmsEndpoint: Show the actual Datastore metadata server connection endpoint.