Configuring Workload Manager Components
You can use the Greenplum Workload Manager config
command to view, override, and describe certain Workload Manager configuration settings. The config
command may be run interactively in a gp-wlm
session or in batch mode at the command line. The command must be run on the Greenplum master host.
See Using the Greenplum Workload Manager Command Line for gp-wlm
command-line syntax and usage.
config
command works only with settings that can be changed by users.When viewing, describing, or setting the value of a configuration setting, you must specify its Workload Manager component. A component can be an individual service, plugin, or command-line tool that is a part of the Workload Manager system.
In interactive mode, you can double-tap the tab character to see which components and settings are available for the show, describe, and modify commands.
Viewing Configuration Values
To view the current value of a configuration setting while in a gp-wlm
session, use the following syntax:
> config show <component> <setting>
For example, the following command shows the logging level of the rulesengine service:
> config show rulesengine logging:log_level
From the command line, use the --config-show
option:
$ gp-wlm --config-show='<component> <setting>'
For example:
$ gp-wlm --config-show='rulesengine logging:log_level'
Describing Configuration Values
Use the describe
command to see a description of a setting and constraints for the setting’s values.
In a gp-wlm
session, the syntax is:
> config describe <component> <setting>
On the gp-wlm
command line, use the config-describe
command-line option:
$ gp-wlm --config-describe='<component> <setting>'
For example, to describe the logging level of the rulesengine in an interactive gp-wlm
session, use this command:
> config describe rulesengine logging:log_level
The output of the command looks like the following:
component: rulesengine
setting: logging:log_level
description: The log verbosity of the rulesengine daemon
valid values: err, warn, info, debug, trace
Here is the same command in batch mode at the command line:
$ gp-wlm --config-describe='rulesengine logging:log_level'
Modifying Configuration Values
Use the config modify
command to change the value of a Workload Manager configuration setting. Changing a configuration setting automatically changes the setting on all hosts in the cluster.
In an interactive gp-wlm
session, use this syntax:
> config modify <component> <setting> = <value>
At the command line, use the gp-wlm
--config-modify
option, with the following syntax:
$ gp-wlm --config-modify='<component> <setting> = <value>'
The new setting is persisted, and will be preserved during future Workload Manager software upgrades.
When a setting for a service is modified, the affected service is automatically restarted on every host in the cluster. However, this can only occur automatically if the cfgmon service is running on the Greenplum master at the time the setting is changed. If the cfgmon service is not running, the setting is still updated persistently, but the new value is not broadcast to the rest of the cluster until the cfgmon service is started. The cfgmon service is always running, by default.
Configurable Workload Manager Settings
The following table lists settings that can be viewed, described, and configured using the config
command.
Component | Setting | Description | Type | Constraints | Default |
---|---|---|---|---|---|
agent | logging:log_level | Log verbosity of agent | String | Valid Values: err, warn, info, debug, trace | info |
cfgmon | logging:log_level | Log verbosity of cfgmon | String | Valid Values: err, warn, info, debug, trace | info |
gpdb_stats | collect_frequency | How often to collect GPDB statistics information | Float | Valid range: 0.1 - 60.0 seconds | 1.0 |
publish_frequency | How often to publish GPDB statistics information | Float | Valid range: 0.1 - 60.0 seconds | 4.0 | publish_idle_sessions | Publish information about idle Greenplum Database sessions | Boolean | ‘true’ or 'false’ | 'true’ |
rulesengine | engine:rule_frequency | Frequency of rule evaluation in seconds | Float | Valid range: 0.1 - 60.0 seconds | 2.0 |
logging:log_level | Log verbosity of rulesengine | String | Valid Values: err, warn, info, debug, trace | info | |
systemdata | logging:log_level | Log verbosity of systemdata plugin | String | Valid Values: err, warn, info, debug, trace | info |
publish_idle_processes | Publish information about idle Greenplum Database sessions | Boolean | 'true’ or 'false’ | 'true’ |