Articles in this section

How Can I Use Control Groups?

Avatar
Splunk Synthetics
  • Updated
Follow

You can use Control Groups in Splunk Synthetic Monitoring to control settings for a group of checks using a single command, configured in the application or via API calls.

For example, you can programmatically both pause groups of Splunk Synthetic Monitoring checks when pushing code to production and resume groups of checks when a build is complete. With this method, any downtime associated with code pushes won’t send alerts or affect performance stats.

Note: Any user with access to the API token can mute or pause a Control Group. Only users with Manager access can create, edit, or delete a control group.

How To Create a Control Group

  1. Admin menu  > Control Groups > + New
  2. Name the Control Group
  3. From the left column, click to select checks to add to the Control Group
  4. Add Selected > to the right column
  5. Create

NewControlGroup.png

Control Checks in Groups Manually in the App

  1. Admin > Control Groups and select the name of the created group
  2. Use the Settings dropdown to apply settings to the group

Screen_Shot_2017-12-20_at_3.10.24_PM.png

In the settings dropdown, you can:

  • Mute / Unmute: Toggles the notification muting feature on and off. When the check is muted, it will continue to monitor, but will not send any alerts.
  • Pause / Resume: Toggles the pausing of the check. When the check is paused, it will not run or produce any results.
  • Delete: Deletes the control group. (Note: this does not delete the checks belonging to the Control Group.)

Control Checks in Groups via the API

To utilize the API commands for Control Groups, you will just need to send a POST request to the Control Group URL and include your post_token along with any commands you wish to send.

Basic example in cURL:

curl https://monitoring.rigor.com/control_groups/[id] -d post_token=[post_token] -d command=[command]

Basic HTTP POST with query strings:

POST https://monitoring.rigor.com/control_groups/[id]?post_token=[post_token]&command=[command]

where [command] is one of the following:

  • mute
  • unmute
  • pause
  • resume

Custom commands can perform multiple actions and we can supply any combination of mutes or pauses.

For example, this will unmute and pause all checks in the group.

curl https://monitoring.rigor.com/control_groups/[id] -d post_token=[post_token] -d command=custom -d mute=false -d pause=true

Related articles