Syncrify » Knowledge base

Document information

Document ID:2009
Subject:Creating custom reports in Syncrify
Creation date:3/29/12 4:41 PM
Last modified on:1/19/16 3:44 PM


Creating custom reports

Often companies, particularly ISPs providing backup service, want to create custom reports containing backup summary. This article discusses a few methods that can be used to create custom reports.

Summary Reports

There are two types of files on Syncrify server that can be used to create custom reports.
Report by users
Syncrify stores a file called access.log in every user's repository folder. For example, if the user's email address is john.doe@xyz.com and the repository path is C:\Backup, look for a file called access.log in C:\Backup\john.doe@xyz.com folder.

This file contains one line for every backup job that ran for this user. Fields in this file are pipe-delimited and the following table define their meaning

Field position Field description
1 Time backup started. This field is defined in milliseconds since Jan 01, 1970
2 Time backup ended. To get duration, subtract start time from this value.
3 Instance number. This is internally used by Syncrify.
4 Job number. This is internally used to identify each job
5 Total files transferred in this backup job
6 Total bytes transferred in this job
7 Profile name
8 Client's build number
9 Client's IP address
10 Number of errors
11 Name of the CSV file as explained in the Detailed Report section below.
12 Next run time - contains milliseconds since Jan 01, 1970 when next scheduled backup will run.
Report by date
To create a report by date, look for files located in $INSTALL_DIR/Reports folder. The value for $INSTALL_DIR on Windows is usually C:\Syncrify and /opt/Syncrify on Linux, Mac and UNIX. Files in the Reports folder are in plain text using the following naming convention:

YYYYMMDD.srep

where YYYYMMDD represents a date value.

This file is also pipe-delimited and uses a similar format described above for access.log. The only difference is that the first token contains user's email address. The following table show define each field.

Field position Field description
1 User's email address
2 Time backup started. This field is defined in milliseconds since Jan 01, 1970
3 Time backup ended. To get duration, subtract start time from this value.
4 Instance number. This is internally used by Syncrify.
5 Job number. This is internally used to identify each job
6 Total files transferred in this backup job
7 Total bytes transferred in this job
8 Profile name
9 Client's build number
10 Client's IP address
11 Total Errors
12 CSV File name for logs
13 Next run time - contains milliseconds since Jan 01, 1970 when next scheduled backup will run

Detailed Reports

Besides the two files described above, you can optionally create another set of files containing backup logs. These logs are stored in CSV format and can be easily imported into a relational database for reporting purposes. Watch this video if you need help importing a CSV file in a database.

This option is disabled by default. Follow the steps below to turn it on.
  • Login as admin to the web interface
  • Click Configuration and then Advanced Configuration
  • Check Save client log
  • Click Save button

When this option is turned on, Syncrify client will send the backup log to the server, which then converts that into a CSV file and saves it to a local folder. These files are located off of $INSTALLDIR/ClientBackupLogs folder.

Files names use the following format:

DATE_SIZE.csv

The first token contains a date value represented in milliseconds since January 01, 1970. The second token holds total bytes transferred.

File format

Every CSV file contain 3 columns:
  1. Action -Contains an integer from 1 to 7 signifying the state of the file.
    1. Entire file
    2. No change
    3. Partial file
    4. Deleted
    5. Restored - (Partial file)
    6. Error
    7. Warning
    8. Restored - (Entire file)
  2. File size -
  3. File path -


User comments

Posted by Nelson Butterworth on 6/8/13 2:10 AM

The field list for access.log is incomplete. 2 new fields should be added: field 10, which appears to be the exit status of the backup job (0 for successful, 2 for errors occurred); and field 11, which is the client log filename if those are configured to be sent to the server.


Add a comment to this document

Do you have a helpful tip related to this document that you'd like to share with other users? Please add it below. Your name and tip will appear at the end of the document text.
Your name:
Your email:
Hide my email address
Verification code:
Enter the verification code you see above more submitting your tip
Tip:Please limit tips to 1000 characters

Navigation

Social Media

Powered by 10MinutesWeb.com