NuoDB Manager Properties

NuoDB Manager lets you set properties that apply to multiple commands. To set properties, use the NuoDB Manager command Set Property. Descriptions of NuoDB Manager properties are organized as follows:

Timeout Properties

Property Description Default
connectTimeout Number of seconds to wait for the specified broker to provide the latest domain status. The specified broker is the broker that the nuodbmger client is trying to connect to. This property applies only when a nuodbmgr client is starting. If a broker is running on the specified host then the nuodbmgr client connects immediately.

After the connection is made, the broker must provide the nuodbmgr client with the latest domain information, including the status of each broker, database and process. If the nuodbmgr client does not obtain the latest status before connectTimeout seconds elapses, then the nuodbmgr client connection fails with a message such as the following:

Domain entry failed: Timed out (10 s) waiting to join domain

If you receive a message like this then increasing the value of the connectTimeout property might allow a nuodbmgr client to connect. Alternatively, when you start nuodbmgr, specify the ‑‑connect-timeout option with a value greater than 10 seconds. Specification of ‑‑connect-timeout overrides the setting of the connectTimeout property.

10
createTimeout Number of milliseconds to wait for the create command to complete. A value of 0 means wait forever, that is, there is no timeout. 10000
diagnoseTimeout Number of milliseconds to wait for the diagnose command to complete. A value of 0 means wait forever, that is, there is no timeout. 60000
hotcopyTimeout Number of milliseconds to wait for the hotcopy command to complete. A value of 0 means wait forever, that is, there is no timeout. 3600000
pruneSnapshotsTimeout Number of milliseconds to wait for the prune snapshots command to complete. A value of 0 means NuoDB Manager does not wait. 60000
restartTimeout Number of milliseconds to wait for the restart command to complete. A value of 0 means NuoDB Manager does not wait. 10000
shutdownTimeout Number of milliseconds to wait for the shutdown database command to complete. A value of 0 means NuoDB Manager does not wait. This property applies to shut down of a database. When shutting down a domain, the shutdownTimeout property applies to each database being shut down. There is no overall timeout for the domain. 10000
softShutdownTimeout Number of milliseconds to wait for active client connections to close on their own. After this timeout expires connections are forcefully closed. A value of 0 means NuoDB Manager does not wait. The connections are shut down immediately. 0
startTimeout Number of milliseconds to wait for the start command to complete. This timeout property is observed only when the NuoDB Manager waitForActive property is set to true.
This property is passed to the broker and the broker will wait startTimeout milliseconds for the process barrier to go down. If startTimeout milliseconds elapses before the process barrier goes down, that is, before the database status is ACTIVE or MET , then NuoDB Manager stops waiting for a response from the broker. The broker continues to try to start the database or process. A startTimeout value of 0 means that the broker keeps trying to start the database or process.
10000
waitForRunning The waitForRunning property works in concert with the restartTimeout property. The restartTimeout property is always observed no matter what. If waitForRunning is true, then nuodbmgr waits for the restart to complete and also waits for the database process or processes to be in the RUNNING state. If waitForRunning is false (default), nuodbmgr stops waiting as soon as the process joins the database or fails to start, which is very quick. false
waitForActive When starting a database, wait until the database status is ACTIVE. That is, wait until the database is able to process SQL connections. A database can be active when one TE is up and running, even if the status of the database requirements is UNMET. false
waitForMet When starting a database, wait until the status of the database requirements is MET. That is, wait until the minimum number of processes required by the database are running. false

Miscellaneous Properties

Property Description Default
cpuResourceThresholds Lets you set one or more thresholds for use of CPU capacity. When you execute the NuoDB Manager show domain health command, NuoDB Manager uses any thresholds you set to flag processes that are using a percentage of CPU capacity that is higher than a threshold. The format for specifying this property is as follows:

cpuResourceThresholds decimalvalue1, decimalvalue2,...

For example:

set property cpuResourceThresholds 10.0, 50.0, 20.0

Given this property setting, output from show domain health would indicate:

  • Any processes that are using more than 10% of CPU capacity.
  • Any processes that are using more than 20% of CPU capacity.
  • Any processes that are using more than 50% of CPU capacity.

This property defines threshold levels for reporting purposes. Specify one or more decimal numbers separated by commas. Each value you specify represents a percentage of host CPU capacity. For each value you specify, the show domain health output indicates how many, if any, processes are using more than that percentage of CPU capacity. Specification of two or three threshold values is likely to be most helpful. You can, however, specify more than three. The threshold values do not need to be in any particular order.
Not set.
enablePrompt When set to true, nuodbmgr prompts you for all required and optional parameters for a given nuodbmgr command. When set to false, you are not prompted for any parameters and you receive an error if you do not specify a required parameter. true
memoryResourceThresholds Lets you set one or more thresholds for host memory use. When you execute the NuoDB Manager show domain health command, NuoDB Manager uses any thresholds you set to flag processes that are using a percentage of host memory that is higher than a threshold. The format for specifying this property is as follows:

memoryResourceThresholds decimalvalue1, decimalvalue2,...

For example:

set property memoryResourceThresholds 10.0, 20.0

Given this property setting, output from show domain health would indicate:

  • Any processes that are using more than 10% of host memory
  • Any processes that are using more than 20% of host memory

This property defines threshold levels for reporting purposes. Specify one or more decimal numbers separated by commas. Each value you specify represents a percentage of use of host memory. For each value you specify, the show domain health output indicates how many, if any, processes are using more than that percentage of host memory. Specification of two or three threshold values is likely to be most helpful. You can, however, specify more than three. The threshold values do not need to be in any particular order.

NuoDB calculates the percentage of process memory in use by dividing the Memory database metric (current residential memory in bytes)by the the mem database option (advisory target for the total memory in use by a single NuoDB process).

Not set.
showConnectedBroker When set to false, the nuodbmgrshow command will not display an asterisk (*) next to the broker to which it is connected. false
showDomainState This relates to the command show domain summary | hosts. If set to true (default), information about database processes that are connected and reachable but not included in the durable domain configurationThe durable domain configuration provides domain configuration information that is stored consistently on each broker in the domain by means of a Raft log.. These processes will be annotated with the message "(Not recorded durably)". true
showHostStableId This property applies to the commands show domain summary and show domain hosts. When set to false (the default), output does not display the stable ID of each broker's or agent's host. Set this property to true to include each host's stable ID in command output. The setting of the showHostStableId property does not affect the output for unreachable brokers. Output from these commands always displays the stable ID of unreachable brokers. false
showServerConfig This relates to the command show domain summary | hosts and tells it to include information about Raft roles, that is, Leader, Follower, etc. This also will show connectivity between agents and brokers. When showServerConfig is set to true, show domain summary will show an agent's connected broker. false
showUnreachable For some show domain commands, this property determines whether or not to display that a host or process is CONNECTED versus UNREACHABLE or whether a database process is UNTRACKED. true

Monitor Properties

These properties affect the output of the NuoDB Manager monitor command.

Property Description Default
alarmPretty If true, turn on alarm formatting. true, if monitorDomainNew is true.
monitorDatabaseProcessStats Show each database process (TE and SM) in monitor output. Set to false if you want to just watch aggregates per database. true, if monitorDomainNew is true.
monitorDomainAggregates Show aggregates in monitor output. true, if monitorDomainNew is true.
monitorDomainAlarm Show alarms in monitor output. true, if monitorDomainNew is true.
monitorDomainNew Use the new domain monitoring tool. false
monitorHostStats Shows each host in monitor output. Set to false if you want to just watch domain aggregate statistics. true, if monitorDomainNew is true.