Use reports and alerts to monitor your environment
Who is this article for?
Instructor, no.
Incydr Professional, Enterprise, Gov F2, and Horizon, no.
Incydr Basic, Advanced, and Gov F1, no.
CrashPlan Cloud, no.
Retired product plans, yes.
CrashPlan for Small Business, no.
Overview
Code42 for Enterprise reports and alerts can be configured to show the information you need about your Code42 environment. Choosing the right report and alert settings for your environment informs administrators and users about the health and status of their storage servers, devices, archives, and accounts.
This article provides:
- Descriptions of available reports
- A case study of common configurations
- Reference material for creating custom reports with the API
View reports and alerts
Dashboard
The Code42 for Enterprise Dashboard provides administrators with general statistics related to license status and storage usage. For a detailed explanation of the information available on this screen, see the Dashboard reference guide.
Reporting web app
The Reporting web app compiles detailed information about the users and storage in your Code42 environment. Use the Reporting web app to view and customize these reports:
Alerts
Alerts are communicated via the Code42 console's Active Alerts view, the history log, and email notifications sent to a configurable list of recipients.
- Active Alerts: The Active Alerts screen lists actionable alerts. Administrators can dismiss active alerts and so prevent them from appearing in the Active Alerts view.
In Code42 servers versions before 6.5, see the Alerts Overview. - Logs: Additional informational and non-urgent alerts are available in the history log (history.log.0) found under Settings > Server > System Logs.
- Email notices: Specific alerts are emailed to recipients as configured in Settings > Notifications.
Alert recipient settings
Create and edit the list of email recipients for server alerts in Settings > Notifications.
Alert descriptions
Email alerts are triggered by the events listed in Settings > Notifications.
The following table describes each alert and notes where thresholds are configured, if applicable.
| Alert | Email description | Where to set threshold |
|---|---|---|
| Database export failure |
A database dump or export fails. The affected server's current configuration may be at risk. |
N/A |
| Server offline | Server cannot be reached. | N/A |
| Store point space critical | A store point is critically low on free space, as specified by the configured threshold. | Settings > Server > Alerts |
| LDAP connection problem | The authority server is unable to communicate with the LDAP server. | N/A |
| RADIUS connection problem | The authority server is unable to communicate with the RADIUS server. | N/A |
| Corrupt archive | Archive corruption is detected. | N/A |
| Directory sync deactivate | Directory sync deactivation not executed. Too many users were identified for deactivation. Check LDAP configuration. | N/A |
| Server version conflict | Server versions do not match. | N/A |
| Store point offline | A store point is offline. | N/A |
| Store point space warning | A store point is low on free space, as specified by the configured threshold. | Settings > Server > Alerts |
Configure backup reports
Administrator backup reports
To configure a routine backup report, go to Settings > Organization > Reporting. The report includes:
- Username
- Source (device) and Target (destination)
- Amount of data selected
- Number of files backed up
- Percentage of selected data that has been backed up
- Date of last complete backup (the last time 100% of selected data was backed up)
- Date of last activity
- Restore period
- Total number of restores
- Total number of users that executed a restore
- Total size of the restores
- Total number of files restored
For information on the backup status reports that are emailed to recipients, see Backup status report reference.
End user backup reports
A backup alert email is sent to the device owner when the device hasn't backed up to any destination for more than the configured number of days. A single email is sent when each threshold (warning and critical) is reached. You may set the thresholds under Settings > Server or Settings > Organization > Reporting.
If you would like end users to receive backup reports and/or alerts, you can configure device-specific reports under Settings > Device Backup > Reporting. End-user reports are turned off by default. Configuration options for end-user reports include:
- Delivery time
- Delivery frequency
- Enable/disable two types of backup alert emails:
- Warning
- Critical
Case study
The following case study presents common reporting and alert requirements and provides the steps needed to configure Code42 for Enterprise to meet those requirements.
Company characteristics
- Mid-sized software company
- Managed Private Cloud deployment with one authority server and one storage server
Goals
The Code42 for Enterprise administrator wants to configure alerts and reports such that:
- Administrators receive alerts for Code42 for Enterprise server issues and administrative concerns
- Administrators and the Finance department receive a backup report every Thursday to execute charge-backs to various departments
- End users receive emails about their backups only when the situation is “critical” (no backup for 30 days or more)
- Administrators can closely monitor the space utilization of on-site storage servers
- Legal department can view a history of restores
Steps
To accomplish the objectives outlined above:
Administrators receive alerts
Add the administrators' email addresses to Settings > Notifications.
Administrators and the finance department receive a backup report
Navigate to Settings > Organization > Reporting.
- In the row labeled Send backup report, select every and Th.
- In the Additional recipients field, click + to add the distribution list email for the Finance department.
- Verify that all organizations are set to inherit the default reporting settings:
- Select an organization and view its details.
- Go to action menu > Edit > Reporting.
- Confirm Inherit reporting settings from parent is enabled.
For information on the backup status reports that are emailed to recipients, see Backup status report reference.
If you disable inheritance for an organization, that organization is not affected by changes to its parent organization.
End users receive only critical emails
- Navigate to Settings > Device Backup > Reporting.
- If necessary, disable Send backup alerts > Warning. Click the Push icon to push the setting to all devices.
- Enable Send backup alerts > Critical. Click the Push icon to push the setting to all devices.
Administrators can monitor storage space
Administrators perform the following steps to closely monitor space utilization:
- Monitor the Dashboard storage utilization info.
- Export reports in CSV format for destination, storage servers, or store points as needed, paying particular attention to the usedPercentage column.
- Destinations: navigate to Storage > Destinations and select action menu > Export All to download a report of detailed usage statistics for all destinations.
- Storage servers: navigate to Storage > Servers and select action menu > Export All to download a report of detailed usage statistics for all storage servers associated with the authority server.
- Store points: navigate to Storage > Store Points and select action menu > Export All to download a report of detailed usage statistics for all store points.
These reports are also available via the Code42 for Enterprise API.
Legal department can view restore history
- Open the Details for a particular organization.
- Locate the column listing the number of restores.
- Click on the numerical value to open the Restore History.
Starting in version 8.2, these details are restricted by role: the history displays only the restore details and archives you can perform or access based on your role permissions. - Select action menu > Export All to export a report of the restore history.
This report can also be accessed via the Code42 for Enterprise API.
Create custom reports via the API
If you'd like custom reports and alerts, you can create them with the Code42 API. The API documentation guide provides detailed information and examples.
You may also view the API documentation on your server at this link (where <your_server> is the hostname or IP address of your authority server):
{{consoleaddress}}/apidocviewer/
We recommend creating a custom script using Perl, Python, or another scripting language to perform the queries, retrieve the data, and assemble the reports.
More information
Contact your Customer Success Manager (CSM) for information on our consulting options.
External resources
These languages are commonly used to work with the Code42 for Enterprise API.