Adding the Watchman Monitoring Integration in Addigy – Addigy

The Watchman Monitoring integration connects your existing Watchman Monitoring account to Addigy, so Watchman alerts appear alongside your Addigy monitoring and the Watchman client is deployed and grouped through your Addigy policies. Use this article if you already subscribe to Watchman Monitoring and want Addigy to handle installation, grouping, and alert delivery.

Overview

Once the integration is enabled, Addigy handles two jobs for you:

Deploys and groups the Watchman client. A Watchman configuration attached to an Addigy policy installs the Watchman Monitoring client on the devices in that policy and can set the Watchman group name for them automatically.
Surfaces Watchman alerts in Addigy. Watchman alerts appear in Catalog > Monitoring with a Watchman badge next to the name, and can be assigned to policies the same way as any other Addigy monitoring item.

This is built for teams already running Watchman Monitoring who do not want to maintain a separate deployment and grouping process for the Watchman client.

Note: The ability to enable and disable individual Watchman Monitoring plug-ins has been removed from the Addigy interface. Watchman Monitoring is designed to enable the necessary plug-ins on devices on its own. If you still need to change a specific plug-in, see Enabling and Disabling Watchman Plug-ins.

Prerequisites

Before you begin, you need:

An existing Watchman Monitoring account that you can sign in to at app.monitoringclient.com.
Permission in Watchman Monitoring to generate an API key.
Your Watchman sub-domain. If you sign in at yourcompany.monitoringclient.com, your sub-domain is yourcompany.
An Addigy policy to attach the Watchman configuration to.

How to Get Your Watchman Monitoring API Key

Addigy authenticates to Watchman Monitoring with an API key that you generate in Watchman, so start there.

Sign in to Watchman Monitoring at https://app.monitoringclient.com/sign-in.
Navigate to Settings > API.
Click Generate a Key.

Generating an API key in Watchman Monitoring

Keep the key available. You will paste it into Addigy in the next section.

How to Enable Watchman Monitoring in Addigy

Enabling the integration at the account level lets Addigy talk to your Watchman account. It does not deploy anything to devices on its own.

Navigate to Account > Integrations > 3rd Party Integrations.
Select the Watchman Monitoring tile under Third Party Add-Ons.
Enter the API key you generated in Watchman Monitoring.
Enter your Watchman sub-domain. For example, if you sign in at yourcompany.monitoringclient.com, enter yourcompany.
Set Watchman to Enabled.

How to Deploy Watchman Monitoring to a Policy

Devices receive the Watchman client through a Watchman configuration attached to an Addigy policy. Create the configuration once, then attach it to each policy that should run Watchman.

Navigate to a Policy > Integrations & Settings > Integrated Systems > Watchman Monitoring.
Click New to create a Watchman configuration. To change an existing configuration, click Manage instead.
In the configuration, enable Install.
Enable Set Group Name so your devices appear in a group within Watchman. If this is left off, devices appear in Watchman with a blank group.
Return to the Watchman Monitoring list, select the checkbox next to the configuration you want to apply, then click Add/Remove > Add to Policy.

Where Watchman Alerts Appear

Once the integration is enabled, your Watchman alerts are available in Catalog > Monitoring, marked with a Watchman badge next to the name. You can assign them to policies from the Catalog, or from the Policies > Monitoring section.

Watchman alerts in Catalog Monitoring with the Watchman badge

Enabling and Disabling Watchman Plug-ins

This should not be necessary. Watchman Monitoring is built to control the correct plug-ins on devices itself. If you do need to change a specific plug-in, run the Watchman client commands directly on the device.

List every plug-in on a device that has Watchman installed:
/Library/MonitoringClient/RunClient --list-plugins
The output lists each plug-in with its UUID.
Enable or disable a specific plug-in by UUID:
/Library/MonitoringClient/RunClient --disable --plugin [plugin uuid]
/Library/MonitoringClient/RunClient --enable --plugin [plugin uuid]

Partial output of the RunClient list-plugins command

You can run these commands from the Devices Page using Run Command, or package them as a Maintenance item.

For the full list of Watchman client command line options, see Watchman Monitoring's terminal command line documentation.

Controlling Automatic Updates for Watchman

Watchman Monitoring installs with automatic updates enabled. We recommend leaving automatic updates on so the client stays current without any work from you.

If you need to manage updates yourself, disable automatic updates with:

defaults write /Library/MonitoringClient/ClientSettings Update_Enabled -bool false

Frequently Asked Questions

I enabled the integration but the Watchman client is not installing. Why?

Enabling the integration under Account > Integrations is not enough on its own. You also need a Watchman configuration with Install enabled, attached to the policy the devices belong to.

Why are my devices showing a blank group in Watchman?

Set Group Name is disabled in the Watchman configuration. Enable it so Addigy sets the group name for devices in that policy.

Can I turn Watchman plug-ins on and off from the Addigy interface?

No. That control was removed from the Addigy interface. Watchman Monitoring enables the plug-ins a device needs on its own. To change a plug-in manually, use the RunClient commands described above.

What do I enter for the sub-domain?

Only the first part of your Watchman address. If you sign in at yourcompany.monitoringclient.com, enter yourcompany.