Private Metrics Reporting - Frequently Asked Questions (FAQ)
- Why doesn't the App Size in the Chargeback Report match all other reports?
- Why don't the numbers match in the Chargeback and License Summary Reports?
- Why don't the numbers match in the Capacity Growth and License Summary Reports?
- How can I create the CommCell Computers Not Reachable Alert?
- Can I use regular expressions with masking?
- Can I associate more than one Private Metrics Reporting Server to a single CommServe computer?
- How can I control the data that appears in reports?
- Are the data upload and results secure?
- Where are the data collection scripts saved?
- Where can I see a log of the script activity?
- What happens if the upload fails?
- How much data is collected?
- How much memory is used?
- Is collected data removed from the Metrics Reporting Server?
- When does uploaded data appear in reports?
- How do I configure Web Console and Private Metrics Reporting Server on separate computers?
- Can I choose the Web Console used for scheduled reports?
- How can a CommServe computer send data to multiple Private Metrics Reporting Servers?
- Can I use Private Metrics Reporting with an offline CommCell?
The Chargeback Report includes pruned data in its App Size calculation. All other reports do not include pruned data.
Activity-disabled subclients are included in the calculation for the Chargeback Report, while activity-disabled subclients are excluded from the calculation for the License Summary Report. Also, the Capacity License calculation used in the License Summary Report counts the latest full backup jobs per subclient, while the Chargeback Report includes the largest full backup jobs.
The Capacity Growth Report displays the highest full backup size, while the License Summary Report displays the last successful full backup size.
You can create an alert to send an email with a list of CommCell computers that do not report for more than a certain number of hours.
- Log into Web Console or the Cloud Services website, and then click Reports.
- From the navigation pane, click CommCells.
- Click the Configure an Alert button.
The Configure Alert - Reports dialog box appears.
- Under Send notification email when, select Hours Since Last Update.
- Next to value, select More Than, and then in the box, type a number of hours.
- In the Alert Name box, type a name for the alert.
For example, type CommCells Not Reachable.
- In the To the email id(s) box, type the email address where the notification should be sent.
- Click Save.
You will receive an email when one or more CommCell computers do not send data to the Reporting Server within the time period you specified.
Yes. You can use regular expressions to identify specific entities and file paths where data should be masked by using an additional setting. For instructions on how to add additional settings from the CommCell Console, see Add or Modify an Additional Setting.
- On each CommServe computer where you want to configure masking for specific entities and file paths, add the appropriate additional setting:
To mask specific paths when forwarding data to a Private Metrics Reporting Server, on the CommServe computer, add the CommservSurveyPrivateScrubRegex additional setting and configure the following values:
Property Value Name CommservSurveyPrivateScrubRegex Category CommServDB.GxGlobalParam Type String Value Type the regex that masks specific file paths. For example, (\B/[\w./$-]+(?: [\w./$-]+)*)|(((\\\\[a-zA-Z0-9-_.:\\$]+)(\\([a-zA-Z0-9_.-\\$]+ ?)+)?\\?))|(([a-zA-Z]:\\)+(([a-z-A-Z0-9_.-\\$]+ ?)+)*\\?).
To mask specific paths when forwarding data to the Cloud Metrics Reporting Server, on the CommServe computer, add the CommservSurveyScrubRegex additional setting and configure the following values:
Property Value Name CommservSurveyScrubRegex Category CommServDB.GxGlobalParam Type String Value Type the regex that masks specific file paths. For example, (\B/[\w./$-]+(?: [\w./$-]+)*)|(((\\\\[a-zA-Z0-9-_.:\\$]+)(\\([a-zA-Z0-9_.-\\$]+ ?)+)?\\?))|(([a-zA-Z]:\\)+(([a-z-A-Z0-9_.-\\$]+ ?)+)*\\?).
Note: Verify that your regex conforms to the proper format, and then add the proper regex in the Value box. If your regex is not properly formed, the regex causes a data processing failure in the Cloud Metrics Reporting server.
No. We recommend that you associate only one Private Metrics Reporting Server with a single CommServe computer.
You can control the data that appears in reports by selecting which data collection scripts run on the CommServe computers. Use an Exclude file to specify the data collection scripts that should not run. All other scripts run automatically.
To ensure that a script runs, even if it is accidentally added to the Exclude file, we recommend that you add it to the Include file. When both the Include and Exclude files are used, the Include file takes precedence. That is, if a script appears on both the Exclude and Include files, the script will run.
New scripts are not automatically added to either list. You must manually add them to the appropriate list.
Exclude Data Collection Scripts
- On each CommServe computer where data is collected for reports, under <Software>\Reports\CommservSurvey, create a text file named PrivateMetricsExclude.txt.
- In PrivateMetricsExclude.txt, type the name of each data collection script that you want to exclude. Each data collection script should appear on a single line.
Save and close PrivateMetricsExclude.txt.
Include Data Collection Scripts
- On each CommServe computer where data is collected for reports, under <Software>\Reports\CommservSurvey, create a text file named PrivateMetricsInclude.txt.
- In PrivateMetricsInclude.txt, type the name of each data collection script that you want to use. Each data collection script should appear on a single line.
- Save and close PrivateMetricsInclude.txt.
Security for your organization's Private Metrics Reporting Server is managed by the organization.
Information about which scripts ran and when the information is uploaded appears in the CommServeSurveyUtility.log and CVD.log files.
To see a log of script activity:
- In the Process Manager, set the debug level for CommServeSurveyUtility and CVD to 10. For instructions, see Setting Logging Parameters in the Process Manager.
- On the CommServe, open the CommServeSurveyUtility.log and the CVD.log files.
- In each log file, perform a search for Survey.
If the data upload fails, then the service will try to upload again after 60 minutes. Upload failures are reported in the CVD.log file.
The XML files are small, usually less than a few megabytes (MB).
The amount of memory that is used is subject to other environmental variables, but generally it is less than the amount used to run reports on a CommCell Console.
Yes. Collected data is scheduled to be automatically removed from the Metrics Reporting Server every Saturday at 11:00 p.m. Based on a default set of retention rules, data is retained for the specified number days, and then deleted. The number of retention days is different for each query.
New data will appear in reports within five minutes after you click the Upload Now button.
The Web Console must be able to reach the CVCloud database. It does this by contacting the Private Metrics Reporting Server, where the CVCloud database resides. If there is a firewall between the Web Console and the Private Metrics Reporting Server, you must configure the ports used for this communication on both the Private Metrics Reporting Server and the firewall between them, as follows:
- Set static listener ports on the named SQL Server instance that hosts the CVCloud database. Microsoft's TechNet article, Configure a Server to Listen on a Specific TCP Port (SQL Server Configuration Manager), tells how to do this.
- Configure the firewall to allow traffic between the Web Console and the SQL Server through the static ports you configured, or add application exceptions for the affected applications. The steps for doing this depend on your firewall:
- If it is a Windows Firewall, see Microsoft's TechNet article entitled Configure the Windows Firewall to Allow SQL Server Access.
- If it is a hardware-based firewall device, consult its manufacturer's documentation.
- In addition to configuring your firewall to allow traffic for the static ports you configured on each SQL Server named instance, allow ports 1433 and 1434 also.
Although it is possible to query the SQL Server and set the firewall to allow the ports it is currently using, restarting the SQL Server instance can result in it using different (dynamic) ports, and therefore lost communication. Therefore, we recommend setting static ports.
Yes. If you have multiple Web Consoles in your network, then by default, scheduled reports generate on the first available Web Console. To specify a particular Web Console where scheduled reports generate, you must configure an Additional Setting.
- On the CommServe computer that hosts the Private Metrics Reporting Server, open the CommCell Console.
- In the CommCell Browser, right-click the CommServe computer, and then click Properties.
The CommCell Properties dialog box appears.
- On the Additional Settings tab, click Add.
The Add Additional Settings dialog box appears.
- In the Name box, type sDefaultWebReportWebConsoleURL.
- In the Category Box, type or select Reports.
- In the Type box, type or select STRING.
- In the Value box, type the URL for the Web Console where you want scheduled reports to generate.
For example: http://yourwebserver/webconsole
- Click OK.
The Additional Setting appears in the list on the Additional Setting Settings tab.
- Click OK.
Use the Tiered Architecture for Private Metrics Reporting. In this configuration, the CommServe computer sends data to an Private Metrics Reporting Server. That Private Metrics Reporting Server can then send the data to another Private Metrics Reporting Server. For more information, see Tiered Architecture for Private Metrics Reporting.
Yes. To participate in Private Metrics Reporting with an offline CommCell, you must select a proxy client for download/upload in the control panel. For instructions, see Using an Internet Gateway Computer for Metrics Reporting.