Skip to main content
Code42 Support

Using Reports & Alerts To Monitor Your Environment

Applies to:
  • CrashPlan PROe
CrashPlan PROe's reports and alerts are highly configurable. Choosing the right report and alert settings for your deployment enables administrators and users to obtain the information needed to know 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 via the API

Considerations

CrashPlan PROe version 3.5.4 and later
The information in this article applies to CrashPlan PROe version 3.5.4 and later.

Version 3.5.4 to 3.6.1

The administration console uses the term Reporting to address reports and alerts in CrashPlan PROe versions 3.5.4 through 3.6.1.

Version 3.6.2.1 and later

The administration console uses the term Notifications to address reports and alerts in CrashPlan PROe versions 3.6.2.1 and later.

Viewing reports and alerts

Dashboard

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
  • Licensing

A detailed explanation of the information available on this screen can be found in the Dashboard reference guide.

Alerts

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 a list of recipients. This list can be configured in Settings > Reporting (version 3.5.4 through 3.6.1) or Settings > Notifications (version 3.6.2.1 and later).

Configuring alert recipients

Create and edit the list of email recipients for server alerts in Settings > Reporting (version 3.5.4 through 3.6.1) or Settings > Notifications (version 3.6.2.1 and later).

Email alert descriptions

Alerts are triggered by slightly different events in CrashPlan PROe versions 3.5.4 through 3.6.1 than in versions 3.6.2 and later.

Version 3.5.4 through 3.6.1

Email alerts are triggered by the events listed in Settings > Reporting.

The following table describes each alert and notes where thresholds are configured, if applicable.

Alert Email Description Where To Set Threshold
Store point offline A store point is offline. N/A
Store point free space A store point is low on free space, as specified by the configured threshold. Settings > Server > Alerts
License limit The number of available licenses is below the configured thresholds. Settings > Server > Alerts
Archive healing or tampering Archive corruption is detected. The email alert includes computer name, GUID of affected archive, destination name, destination GUID, and action taken. N/A
Directory synchronization Directory sync deactivation not executed. Too many users were identified for deactivation. Check LDAP configuration. N/A
Directory communication The master server is unable to communicate with the LDAP server. N/A
Storage server offline A storage server is offline. N/A
Database export A database dump or export fails. The affected server's current configuration may be at risk. N/A
Version 3.6.2 and later

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 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

Configure a routine Backup Report under 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 (i.e. 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

If you would like end-users to receive backup reports and/or alerts, you can configure device-specific reports under Settings > Device > 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
  • Note: 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.

Case study

The following case study takes common reporting and alert requirements and provides the steps needed to configure CrashPlan PROe to meet those requirements.

Company characteristics

  • Mid-sized software company
  • Approximate number of users: 350
  • Managed Private Cloud deployment with one master server and one storage server

The CrashPlan PROe administrator wants to configure alerts and reports such that:

  1. Administrator receives alerts for CrashPlan PROe server issues and administrative concerns
  2. Administrator and the Finance department receive a backup report every Thursday to execute charge-backs to various departments
  3. End users don't receive emails about their backups unless the situation is “critical” (i.e. no backup for 30 days or more)
  4. Administrator can closely monitor the space utilization of on-site storage servers
  5. Legal department has a history of restores

Steps

To accomplish the objectives outlined above:

  1. Add the administrator's email address to Settings > Reporting (version 3.5.4 through 3.6.1) or Settings > Notifications (version 3.6.2.1 and later).
  2. 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:
      1. Open an organization's Details pane.
      2. Go to Action Menu > Edit > Reporting.
      3. Confirm Inherit reporting settings from parent is enabled.
        Disabling inheritance
        If inheritance is disabled for an organization, that organization is not affected by changes to its parent organization.
  3. Navigate to Settings > Device > Reporting.
    • If necessary, disable Send backup alerts > Warning. Click the Push icon to push the the setting to all devices.
    • Enable Send backup alerts > Critical. Click the Push icon to push the the setting to all devices.
  4. Administrator performs the following steps to closely monitor space utilization:
  5. Open the Details for a particular organization. In the Organization highlights section, find the column listing the number of restores, then click on the numerical value to open the Restore History. Export the restore data from Action Menu > Export All.
    • This report can also be accessed via the 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 IP address or FQDN of your master server):
https://master-server.example.com:4285/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.

Still unsure?

Please contact Sales for information on our consulting options.