Overview
This document describes how to add ConnectWise RMM as a datasource in BrightGauge.
Create an API Key in RMM
The integration with RMM requires an API key. If you have already created a Reporting API Key in RMM, please retrieve your key and proceed to Connect to RMM. Otherwise, you must generate a new API key.
To create your API key:
- Log in to your RMM account.
- Select the Admin tab.
- Select Integration > Reporting API.
- Generate the API key.
- Copy and save the key.
Note:
- Store your key in a safe place.
- If you previously created a key, a masked key displays. Try to locate your existing key. If you create a new key, it deactivates the old one and breaks whatever was using it.
- If you must create a new key, store it in a safe space and be sure to apply it to whatever was previously using the old key.
Connect to RMM
Important: After generating the API key in RMM, it may take up to two hours for that key to sync all RMM information within the API.
For this reason, we ask that you wait two hours before inputting your newly generated API key within your BrightGauge datasource. If you enter the API key in your RMM datasource in BrightGauge immediately after generating it, the initial sync after you save the datasource will not pull in any data into BrightGauge.
To connect to RMM:
- Log in to your BrightGauge account.
- Navigate to DATA > Datasources.
- Click Add a New Datasource.
- Click the RMM tab.
- Select ConnectWise RMM.
- Enter a Name for the datasource.
- Enter your RMM API Key.
Note: Be sure you have a waited at least two hours after generating the API key before completing this step.
- Click Test Connection. If successful, a green banner displays stating the test succeeded.
- After a successful connection, click Save. Dashboards, reports, datasets, and gauges are added to your account after saving the datasource. The sync usually takes 20 to 30 minutes to complete.
If data has not populated after 30 minutes, see the Dataset Syncing documentation to manually initiate syncs for each RMM dataset.
If you have any questions, please contact support by clicking the Help in the top menu bar and selecting Open a ticket.
Client Mapping
Important: As of March 2024, the ConnectWise Asio™ platform allows you to group multiple sites under one company in the Company Management > Company Details Page. When grouping multiple sites together, the sites are renamed in the format Company – Site Name.
In BrightGauge, you set up client mappings by searching the client site name. With the above change, searching for the site name may not result in all the sites. BrightGauge client mappings do not update dynamically, so when you begin using the Company Management feature, your BrightGauge client mappings may stop working as their names no longer match the new company-site names. Currently, you must manually update your Client Mappings by searching one site at a time. For more information on how to map/manage your clients in BrightGauge, please review our 101 - Client Reporting documentation.
Default Resources
BrightGauge provides the following dashboards, reports, and datasets for the ConnectWise RMM datasource.
For a list of default gauges, select Gauges from the top menu bar in BrightGauge.
Default Dashboards
To locate your reports, select Dashboards from the top menu bar.
- BGS Machine Monitoring
- Executive Dashboard 1
- Executive Dashboard 2
- Executive Dashboard - 3 v2.0
Default Reports
To locate your reports, select Reports from the top menu bar.
- Agent Report
- Agent Uninstall Report v2.0
- ConnectWise Asio (ITSupport247) Executive Report v2.0
- Installed Software Support
- Installed Updates Report v2.0
- Missing Updates Report v2.0
- OS Patching
- Recover SaaS Report
- Remote Access Report
- System Information Report
- Warranty Report
Default Datasets
To locate your datasets, navigate to DATA > Datasets.
| Agent Uninstall | The dataset contains details about the Agent Uninstall information of each endpoint. It contains a brief summary of Agent uninstall reason and feedback as part of the Agent uninstall. All the data is available at a daily level. Data is collected every 8 hours from the source and reported on a daily basis. |
| Application Data | This dataset contains data and information about which software is installed on the devices. This can only report on what exists, not what is missing. Data is collected every 8 hours from the source and reported on a daily basis. |
| Application Patch Deployment |
This dataset contains details about the third-party patches that attempted to get installed on the endpoint by the RMM Agent. The dataset provides an audit of all third-party patching actions taken by the RMM agent and reasons why actions may have failed. Data is collected/refreshed near real-time from the RMM system. |
| Automation Details | This dataset contains details about the RMM automation tasks (executions) performed on an endpoint. Data is available for the last three months at a daily level. Subsequently, data is collected every 24 hours from the source, but only the last two days of data is considered and synchronized into the BrightGauge dataset. |
| Automation Summary | This dataset contains a summarized view about the automation executions performed on an endpoint, grouped by execution status. Data is available for the last three months at a daily level. Subsequently, data is collected every 24 hours from the source, but only the last two days of data is considered and synchronized into the BrightGauge dataset. |
| Current AV Status | The dataset contains details about the Current AV status on the machine. It contains the status (such as Up to date, Missing AV) of anti-virus for machines where the supported AV is detected and status is available. Data is collected every four hours from the endpoint, and data is synchronized once every day into BrightGauge with the latest data. |
| Devices Availability | This dataset contains devices availability information for all the endpoints that are under monitoring. Data is collected/refreshed near real time from the RMM system. |
| Disk Space Utilization Summary | This dataset contains summarized details for disk space utilization per drive/volume of all the machines. Details of each machine are recorded for each day for the last four months. Data is collected every 8 hours from the source, but only the latest data for each day is considered and synchronized into the BrightGauge dataset. |
| Endpoint Performance | This dataset contains performance indicators for all the machines. Performance metrics (CPU Utilization, Availability, Disk Space Utilization, Memory Utilization) data is collected every 8 hours from the source and Daily measures for these metrics are calculated as an average for all data collected during the day for each machine. Monthly measures are calculated as an average based on daily data. Data is available for the last four months at a daily level. Data is synchronized once every day into BrightGauge dataset. |
| Endpoint Protection | This dataset shows which machines are protected or out of date and also if machines have no endpoint protection software installed or if machine has no available information regarding Endpoint Protection software installed on any given day during the given time period. Data is available for the last four months at a daily level. Data is collected every 8 hours from the source but only latest data for each day is considered and synchronized into the BrightGauge dataset. |
| Endpoint Summary | This dataset contains summarized details of all the machines. Details of each machine are recorded for each day for the last four months. Data is available for the last four months at a daily level. Data is collected every 8 hours from the source but only latest data for each day is considered and synchronized into the BrightGauge dataset. |
| Executive Reporting Warranty Details | This dataset contains summarized warranty details of all the machines. Details of each machine are recorded for each day for the last four months. Data is available for the last four months at a daily level. Data is collected every 8 hours from the source but only the latest data for each day is considered and synchronized into the BrightGauge dataset. |
| HD Chat Logs | The HD Chat Logs dataset contains data from the Chat interactions that the Help Desk Service handles. It contains information like the number, time, and SLA-related data from each interaction. The data is updated every 24 hours from the source, but only the latest data for each day is considered and synchronized into the BrightGauge dataset. |
| HD Phone Logs | This dataset contains data from the Phone interactions that the Help Desk Service handles. It contains information like the number, time, and SLA related data from each interaction. The data is updated every 24 hours from the source, but only the latest data for each day is considered and synchronized into the BrightGauge dataset. |
| Help Desk Incidents | This dataset contains detailed data of all the Help Desk service requests/incidents. Details like when was a request created, when it got resolved, how much time for resolution, who requested, if it was escalated, escalation reason, source of origin, etc. Data is available for the last four months at a daily level. Data is collected at the end of each day and reported on daily basis. |
| Monthly Site Scores | This dataset contains summarized data for all the sites in the form of scores. The relevant parameters of all the devices on the site are considered and used for arriving at the scores. Scores are calculated on a daily basis and averaged for the month. Data is available for the last four months at a daily level. Data is collected every 8 hours from the source and reported on a daily basis. |
| Network Devices |
This dataset contains details about which network devices have been identified via the ConnectWise RMM probe devices. All the data is available at a daily level. Subsequently, data is collected every eight hours from the source and synchronized into the BrightGauge dataset. |
| Network Probe | This dataset contains details about the endpoints that have been configured as probe devices. All data is available at a daily level. Subsequently, data is collected every 24 hours from the source and synchronized into the BrightGauge dataset. |
| OS Patch Assessment - Windows | This dataset contains detailed results of the OS Patch Assessment which we run on endpoints. It contains crucial information like the patch release date, KB ID, Latest patch status, patch title, NOC recommendation, etc. Data is collected every 8 hours from the source and reported on a daily basis. |
| OS Patch Compliance | This dataset contains summarized details about the compliance score of each endpoint. Compliance displays a scoring percentage based off of patches installed or missing per the policy. This dataset contains additional details like compliance percentage, compliance percentage by policy, last assessed date OS name, etc. Data is available for the last four months at a daily level. Data is collected every 24 hours from the source but only the latest data for each day is considered and synchronized into the BrightGauge dataset. |
| OS Patch Status | This dataset contains summarized details about the patch installation and failure status of an individual patch that attempted to get installed on the endpoint by the RMM Agent. The dataset also contains additional details like Failure reason, failure date, installation date, classification of the patch, etc. Data is available for the last four months at a daily level. Data is collected every 8 hours from the source but only the latest data for each day is considered and synchronized into the BrightGauge dataset. |
| Recover Appliance Summary | This dataset contains details of the appliances, number of protected servers and workstations, details of appliance including space used. Data is available for the last four months at a daily level. |
| Recover Local Backup | This dataset contains data about the status of all the local backups on a daily basis. Details like space utilized, appliance name, protected server name and IP address is available. Data is available for the last four months at a daily level. Data is collected at the end of each day and reported on daily basis. |
| Recover Offsite Backup | This dataset contains data about the status of all the offsite backups on a daily basis. Details like space utilized, appliance name, protected server name and IP address is available. Data is available for the last four months at a daily level. Data is collected at the end of each day and reported on daily basis. |
| Recover Pooled Cloud | This dataset contains data about how much cloud storage is used on a daily basis. Data is available for the last four months at a daily level. Data is collected at the end of each day and reported on daily basis. |
| Recover Truverify Backup | This dataset contains data about the Truverify status of all the backups on a daily basis. Details like space utilized, appliance name, protected server name and IP address is available. Data is available for the last four months at a daily level. Data is collected at the end of each day and reported on daily basis. |
| Remote Access | This dataset contains details about which endpoints were accessed remotely via ScreenConnect®. The dataset provides details about who accessed the endpoint along with the reason and session details. Data is available for the last four months at a daily level. Subsequently, data is collected every 24 hours from the source, but only the latest two days of data is considered and synchronized into the BrightGauge dataset. |
| SAAS Appsite Backup Details | This dataset contains data about the status of all SaaS Backup Connectors like Microsoft 365, Google Workspace, Salesforce, MS Dynamics 365 (CRM), Azure AD, etc. Based on the connectors provisioned at the site level, details like connector name, connector type, retention period, protected user account, backup status, last backup data/time are available. Data is available for the last four months at a daily level. Data is collected at the end of each day and reported on a daily basis. |
| Warranty Details | The dataset contains details about the warranty information of the machine. It contains the manufacturer, warranty description, warranty end date etc., for each machine (physical desktop or server). Data is collected once per week from the endpoint. Data is synchronized once every day into BrightGauge™ with the latest data. |
|
This dataset contains Webroot threats data. How many threats were neutralized and how many threats are active for each machine that is protected by Webroot Endpoint Protection software. Webroot threats data is collected every 8 hours. Data is available for last 4 months at a daily level. Only the latest status for each machine is considered for each day. Data is synchronized once every day into BrightGauge dataset. |
Comments
0 comments