Enable workload management
After you create your workload pools and workload rules, you must globally enable the workload management feature. When you enable workload management, a series of health checks run in the background to validate your configuration. If these health checks fail, you cannot enable workload management and a failure message appears.
For more information on Linux configuration requirements, see Set up Linux for workload management.
You can enable workload management using Splunk Web, the CLI, or REST API.
Enable workload management in Splunk Web
- In Splunk Web, click Settings > Workload Management.
- Toggle the switch to Enabled.
This applies any pending configuration changes and enables workload management.
To disable workload management, toggle the switch to Disabled.
Enable workload management using the CLI
To enable or disable workload management, run the following CLI command:
./splunk <enable|disable> workload-management
Enable workload management using REST
You can enable or disable workload management using the REST API. For endpoint details, see workloads/config/enable or workloads/config/disable in the REST API Reference Manual.
Enable individual workload rules
You can enable or disable individual workload rules. This lets you create and save multiple different workload rules and apply them as needed. Individual workload rules are enabled by default when you create them. Disabled workload rules are not evaluated and have no effect on searches.
When you enable or disable a workload rule, the setting is stored under the [workload_rule:<rule_name>]
stanza for the individual rule in workload_rules.conf
. For more information, see workload_rules.conf.
You can enable or disable individual workload rules using Splunk Web, the CLI or REST API.
Enable individual workload rules using Splunk Web
To enable or disable an individual workload rule using Splunk Web:
- In Splunk Web, click Settings > Workload Management > Workload Rules.
- In the Status column, toggle the switch to enable or disable the individual workload rule.
Enable individual workload rules using the CLI
To enable or disable an individual workload rule, run the following CLI command,
./splunk <enable|disable> workload-rule <rule_name>
Enable individual workload rules using REST
Send a POST request to the workloads/rules
endpoint, as shown:
curl -k -u <user:pass> -X POST https://localhost:8089/services/workloads/rules/<rule_name>/<enable|disable>
For endpoint details, see workloads/rules in the REST API Reference Manual.
Check workload management status
You can check the current status of workload management using the CLI or REST API. The output shows configuration details of all workload pools and rules, and whether workload management is supported and enabled on the instance. You can also view runtime information for in-progress searches in any pool.
Check workload management status using the CLI
Run the following CLI command:
./splunk show workload-management-status --verbose
Here is an example of the output from the command:
Workload Management Status: Enabled: 1 Supported: 1 Error: Workload Category: ingest CPU Group: /sys/fs/cgroup/cpu/system.slice/Splunkd.service/ingest Memory Group: /sys/fs/cgroup/memory/system.slice/Splunkd.service/ingest CPU Weight: 25 Memory Weight: 25 Default Category Pool: pool_2 pool_2: CPU Group: /sys/fs/cgroup/cpu/system.slice/Splunkd.service/ingest/pool_2 Memory Group: /sys/fs/cgroup/memory/system.slice/Splunkd.service/ingest/pool_2 CPU Weight: 100 Memory Weight: 100 Workload Category: search CPU Group: /sys/fs/cgroup/cpu/system.slice/Splunkd.service/search Memory Group: /sys/fs/cgroup/memory/system.slice/Splunkd.service/search CPU Weight: 75 Memory Weight: 75 Default Category Pool: pool_1 pool_1: CPU Group: /sys/fs/cgroup/cpu/system.slice/Splunkd.service/search/pool_1 Memory Group: /sys/fs/cgroup/memory/system.slice/Splunkd.service/search/pool_1 CPU Weight: 20 Memory Weight: 20 pool_3: CPU Group: /sys/fs/cgroup/cpu/system.slice/Splunkd.service/search/pool_3 Memory Group: /sys/fs/cgroup/memory/system.slice/Splunkd.service/search/pool_3 CPU Weight: 20 Memory Weight: 20 Workload Category: misc CPU Group: /sys/fs/cgroup/cpu/system.slice/Splunkd.service/misc Memory Group: /sys/fs/cgroup/memory/system.slice/Splunkd.service/misc CPU Weight: 12 Memory Weight: 12 Default Category Pool: misc_pool misc_pool: CPU Group: /sys/fs/cgroup/cpu/system.slice/Splunkd.service/misc/misc_pool Memory Group: /sys/fs/cgroup/memory/system.slice/Splunkd.service/misc/misc_pool CPU Weight: 100 Memory Weight: 100 Workload Rules: rule_1: Order: 1 Predicate: app="search" Workload Pool: pool_1 rule_2: Order: 2 Predicate: app="search" AND (NOT index="_internal") Workload Pool: pool_3
The command output shows only those workload rules that are currently enabled.
Check workload management status using REST
To view workload management status information, send a GET request to:
workloads/status
For endpoint details, see workloads/status in the REST API Reference Manual.
Configure workload rules | Configure admission rules to prefilter searches |
This documentation applies to the following versions of Splunk® Enterprise: 8.2.0, 8.2.1, 8.2.2, 8.2.3, 8.2.4, 8.2.5, 8.2.6, 8.2.7, 8.2.8, 8.2.9, 8.2.10, 8.2.11, 8.2.12, 9.0.0, 9.0.1, 9.0.2, 9.0.3, 9.0.4, 9.0.5, 9.0.6, 9.0.7, 9.0.8, 9.0.9, 9.0.10, 9.1.0, 9.1.1, 9.1.2, 9.1.3, 9.1.4, 9.1.5, 9.1.6, 9.2.0, 9.2.1, 9.2.2, 9.2.3, 9.3.0, 9.3.1
Feedback submitted, thanks!