The LogicMonitor Portal monitoring package leverages the LogicMonitor API to monitor the status of your LogicMonitor portal.
As of November 2020, the LogicMonitorPortal package is known to be compatible with:
As LogicMonitor releases newer versions of the API, LogicMonitor will test and extend coverage as necessary.
Add Resources Into Monitoring
Add a LogicMonitor Portal host into monitoring. As cloud-based software, there is no physical resource to add into monitoring so simply create a new resource with “.logicmonitor.com” included in the IP Address/DNS name field, as well as the Name display name field. You may use a generic name here such as “portal.logicmonitor.com” or your full account name. For more information on manually adding resources into monitoring, see Adding Devices.
LogicMonitor must provide the appropriate credentials in order to successfully retrieve data from LogicMonitor’s API. For more information on creating an API token in LogicMonitor, see API Tokens.
Assign Properties to Resources
The following custom properties must be set on the LogicMonitor Portal resource within LogicMonitor. For more information on setting properties, see Resource and Instance Properties.
|lmaccess.id or logicmonitor.access.id||REST API token ID. Minimum required role permissions assigned to the API user are read only.|
|lmaccess.key or logicmonitor.access.key||REST API token key. Minimum required role permissions assigned to the API user are read only.|
|lmaccount||(optional) Name of your LogicMonitor account. This will default to the current account.|
|system.category||“LogicMonitorPortal” (this value will be added automatically by the addCategory_LogicMonitorPortal PropertySource)|
From the LogicMonitor public repository, import all LogicMonitor Portal LogicModules, which are listed in the LogicModules in Package section of this support article. If these LogicModules are already present, ensure you have the most recent versions.
Once the LogicModules are imported (assuming all previous setup requirements have been met), data collection will automatically commence.
- This suite should only be applied to a single dedicated device as instructed in the Add Resources Into Monitoring section of this support article. Applying these LogicModules to multiple resources will result in duplicate data and unnecessary API calls.
- Deviating from the default collection intervals put into place for the DataSources in this suite may impact your API quotas resulting in rate limiting for other applications using LogicMonitor’s API.
- The data provided by these DataSources is summative for historical analysis. Realtime data should be drawn from your portal directly.
Migration from Legacy LogicModule
In November of 2020, LogicMonitor released a new suite of LogicMonitor Portal LogicModules (see LogicModules in Package for full list of modules). The new DataSources provide upwards of 40 new datapoints and group related metrics into separate DataSources, making it easier to hone in on specific aspects of the portal. The new PropertySource ensures this suite is applied more discreetly to limit the impact on API rate limiting. Gathering metrics with the new suite offers many advantages, including:
- Access to more data
- Easy setup and configuration
- Better organization of data
- Less API usage, which decreases the impact on your API quotas
The release of these new DataSources serves to deprecate the following legacy DataSource:
If you are currently monitoring your LogicMonitor portal using this legacy DataSource, you will not experience data loss upon importing the new DataSources. However, you will collect duplicate data as long as the legacy DataSource remains active alongside the new set of DataSources. For this reason, we recommend that you disable the legacy DataSource after importing the new set of DataSources and confirming that they are working as intended in your environment.
When a DataSource is disabled, it stops querying the host and generating alerts, but maintains all historical data. At some point in time, you may want to delete the legacy DataSource altogether, but consider this move carefully as all historical data will be lost upon deletion. For more information on disabling DataSources, see Disabling Monitoring for a DataSource or Instance.
LogicModules in Package
LogicMonitor’s package for LogicMonitor Portal consists of the following LogicModules. For full coverage, please ensure that all of these LogicModules are imported into your LogicMonitor platform.
|addCategory_LogicMonitorPortal||PropertySource||Verifies LogicMonitor API credentials and adds “LogicMonitorPortal” and “NoPing” to the system.categories property for portal metrics monitoring.|
|LogicMonitor Alerts||DataSource||Monitors alerts on a LogicMonitor account.|
|LogicMonitor API Utilization||DataSource||Monitors utilization of API endpoints on a LogicMonitor account.|
|LogicMonitor Collectors||DataSource||Monitors Collectors on a LogicMonitor account.|
|LogicMonitor DataSources||DataSource||Monitors instance counts across devices on individual DataSources within a LogicMonitor account, as well as monitors active alerts, datapoints, and alerts defined.|
|LogicMonitor Overview||DataSource||Monitors overview metrics on a LogicMonitor account.|
|LogicMonitor Resources||DataSource||Monitors resources on a LogicMonitor account.|
|LogicMonitor Users||DataSource||Monitors user counts on a LogicMonitor account.|
|LogicMonitor Websites||DataSource||Monitors websites on a LogicMonitor account.|
The majority of the DataSources in this package do not include predefined datapoint thresholds (that is, no alerts will trigger based on collected data). This is because thresholds will vary greatly depending on which metrics matter most to each user. For example, some users may want to add an instance level threshold on the AWS Resources instance generated by the LogicMonitor_Portal_Resources DataSource to notify if the resource count exceeds a certain value. Similarly, administrators that wish to have all users use two-factor authentication may want to set a threshold > 0 for the twoFAEnabled datapoint in LogicMonitor_Portal_Users. For additional information on manually setting custom thresholds, see Tuning Static Thresholds for Datapoints.