Who is this article for?
CrashPlan for Small Business, no.
Code42 for Enterprise, yes.
Link: Product plans and features.
CrashPlan PROe's reports and alerts are highly configurable. 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
Viewing reports and alerts
The CrashPlan PROe Dashboard provides administrators and users with a live stream of useful information and statistics related to system performance and usage:
- Online devices and bandwidth usage
- Destination storage statistics
- Storage utilization
- Backup statistics
- Restore statistics
A detailed explanation of the information available on this screen can be found in the Dashboard reference guide.
Alerts are communicated via the Alerts menu, the history log, and email notifications sent to a configurable list of recipients.
- Alerts menu: The Alerts area is reserved for actionable alerts that require immediate attention. Administrators must acknowledge these alerts to prevent them from appearing in the Alerts overview. Informational and non-urgent alerts are not displayed here.
- Logs: 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.
Configuring alert recipients
Create and edit the list of email recipients for server alerts in Settings > Notifications.
Email 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.
|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 master server is unable to communicate with the LDAP server.||N/A|
|RADIUS connection problem||The master 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|
Configuring backup reports
Administrator backup reports
To configure a routine Backup Report, go to Settings > Organization > Reporting. The report includes:
- 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
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:
The following case study takes common reporting and alert requirements and provides the steps needed to configure CrashPlan PROe to meet those requirements.
- Mid-sized software company
- Managed Private Cloud deployment with one master server and one storage server
The CrashPlan PROe administrator wants to configure alerts and reports such that:
- Administrators receive alerts for CrashPlan PROe 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” (i.e. 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
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.
If inheritance is disabled 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 Destinations > Action Menu > Export All to download a report of detailed usage statistics for all destinations.
- Storage servers: navigate to Destinations > Servers > Action Menu > Export All to download a report of detailed usage statistics for all storage servers associated with the master server.
- Store points: navigate to Destinations > Store Points > Action Menu > Export All to download a report of detailed usage statistics for all store points.
These reports are also available via the CrashPlan PROe 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
- Select Action Menu > Export All to export a report of the restore history
This report can also be accessed via the CrashPlan PROe API.
Creating custom reports via the API
If you'd like custom reports and alerts, you can create them with the CrashPlan PROe REST-based 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 master server):
We recommend creating a custom script using Perl, Python, or another scripting language to perform the queries, retrieve the data, and assemble the reports.
Contact Sales for information on our consulting options.
These languages are commonly used to work with the CrashPlan PROe API.