Cato SD-WAN Monitoring
Last updated on 05 August, 2024LogicMonitor offers out-of-the-box monitoring for Cato SD-WAN Sockets. It is designed to monitor tunnels, interfaces, and device health metrics. The Cato SD-WAN monitoring suite uses the Cato GraphQL API to retrieve Cato stats and data. For more information, see the Cato Networks GraphQL API Reference from Cato.
Compatibility Requirements
- Collector version 32.400 or higher
- A Cato Account ID and a Cato API Key.
For more information, see View General Account Info and Generating API Keys for the Cato API from Cato.
Add Resources into Monitoring
Cato SD-WAN devices need to be manually added to your portal.
Manual Setup
Cato SD-WAN monitoring modules are applied to Cato Edges and every single device you create must correspond to a single Cato socket. A Cato site can have up to two sockets, a primary socket and a secondary socket.
If you added a single device, or a single Cato socket, to your Resource Tree, set the following properties on that device:
| Property | Value | Required |
|---|---|---|
| **cato.account.id** | Cato Account ID | Yes |
| **cato.api.key** | Cato API Key | Yes |
| **cato.api.device.serial** | Cato Socket Serial Number | Yes |
To find the serial number of your Cato socket, see Sockets Inventory from Cato.
After properties have been assigned to your Cato socket device, the **Cato_SDWAN_API** DataSource and **addCategory_Cato_SDWAN** PropertySource modules will automatically apply to the device if they have been imported into your portal.
Note: The **Cato_SDWAN_API** DataSource must successfully run at least one data collection cycle so that the **addCategory_Cato_SDWAN** PropertySource has the data it needs to assign properties to the Cato socket device. The properties assigned by the **addCategory_Cato_SDWAN** PropertySource are required by the Cato SD-WAN monitoring modules to function.
Manually Adding Resources
- Create a Cato SD-WAN device group and assign the following properties to it:
| Property | Value |
| cato.account.id | Cato Account ID |
| cato.api.key | Cato API Key |
For more information, see Adding Device Groups and Resource and Instance Properties-Manually Assigning or Editing Properties.
- Inside the “Cato SDWAN” parent device group, add a device group for each of your sites:
| Property | Value |
|---|---|
* Cato SDWAN _(device group)_ | cato.account.id OR cato.api.key |
| * Site 1 _(device group)_ | – |
| * Site 2 _(device group)_ | – |
| * Site 3 _(device group)_ | – |
- For each site, add a Cato Socket that belongs to that site as a device:
| Property | Value |
|---|---|
* Cato SDWAN _(device group)_ | cato.account.id OR cato.api.key |
| * Site 1 _(device group)_ | – |
| * Socket 1 _(device)_ | cato.api.device.serial |
| * Socket 2 _(device)_ | cato.api.device.serial |
| * Site 2_(device group)_ | – |
| * Socket 1 _(device)_ | cato.api.device.serial |
| * Site 3 _(device group)_ | – |
| * Socket 1 _(device)_ | cato.api.device.serial |
* Socket 2 _(device)_ | cato.api.device.serial |
Recommendation: Using this recommended pattern allows you to navigate your Cato Socket devices by site and minimizes the work required for setting custom properties on your Cato Socket devices due to property inheritance.
- For each Cato socket device that you add, add the
**cato.api.device.serial**property to it with a value of that Cato socket’s Serial Number.
Recommendation: Ensure the required properties have been set on your Cato socket devices so that the Cato_SDWAN_API DataSource and the addCategory_Cato_SDWAN PropertySource modules can successfully apply to them.
Importing LogicModules
From the LogicMonitor public repository, import all Cato SD-WAN LogicModules. If the LogicModules are already present, ensure you have the most recent version.
After the LogicModules are imported (assuming all previous setup requirements have been met), data collection will automatically commence. For more information on importing modules, see LM Exchange.
Note: The **Cato_SDWAN_API** DataSource must apply to at least one Cato Socket device and successfully perform an initial data collection cycle. Once the **Cato_SDWAN_API** module has successfully performed at least one data collection cycle, the **addCategory_Cato_SDWAN** PropertySource will have enough information to set the required properties on your Cato Socket devices to begin monitoring.
Troubleshooting
- This package relies on collector script cache to continuously retrieve and store data from the Cato SDWAN GraphQL API to minimize rate limiting constraints. For more information, see Collector Script Caching.
Continuous data collection is maintained on an elected Cato device through theCato_SDWAN_APIDataSource, which writes API responses to the collector script cache. TheaddCategory_Cato_SDWANPropertySource must run first to set the proper category on this device. TheCato_SDWAN_APIDataSource must run successfully for all other modules in this package to be successful. - If data gaps are seen, verify if the
Cato_SDWAN_APIis functioning successfully and check script cache health in theLogicMonitor_Collector_ScriptCacheDataSource.
Note: The API used to pull data has rate limits. Check the Cato_SDWAN_API module on any Cato socket device to check if the API is unreachable or monitoring has hit the API rate limit. For more information, see Understanding Cato API Rate Limiting from Cato.
LogicModules in Package
LogicMonitor’s package for Cato SD-WAN consists of the following LogicModules. For full coverage, ensure that all of these LogicModules are imported into your LogicMonitor platform.
| Display Name | Type | Description |
|---|---|---|
| Cato SDWAN API | DataSource | Gathers data about Cato Socket devices by querying Cato’s GraphQL API. |
| Cato SDWAN Tunnels | DataSource | Monitors various Cato SDWAN tunnel metrics. |
| Cato SDWAN Interfaces | DataSource | Monitors Cato SDWAN device interfaces. |
| Cato SDWAN Health | DataSource | Monitors Cato SDWAN Devices Health data. |
| addERI_Cato_SDWAN | PropertySource | Discovers and adds Cato SDWAN specific ERI’s for Cato SDWAN resources. |
| addCategory_Cato_SDWAN | PropertySource | Adds numerous required properties to your Cato Socket devices. |
When setting static datapoint thresholds on the various metrics tracked by this package’s DataSources, LogicMonitor follows the technology owner’s best practice KPI recommendations.
Recommendation: If necessary, adjust these predefined thresholds to meet the unique needs of your environment. For more information, see Tuning Static Thresholds for Datapoints.