Understanding Migration App Logs

Audience

Any User of Migration App, as well as anyone supporting or troubleshooting Migration Jobs.

Context

Every time a command is executed using Migration App, logs and a report are generated. Some are saved to the Egnyte domain and some are saved to the local machine where the Agent is installed. This article is designed to help users understand and use these assets effectively.

Logs Saved to the Egnyte Domain

If the user has utilised the Migration App to create at least one migration job, they will find a folder on their domain named Migrations under the /Shared folder. Every migration job will be assigned its own folder, labelled Migration-[JOB ID]. Use the Job ID to find the folder that needs to be investigated, and click to expand the folder. It will contain:

• The Migration Report in xlsx format labelled migration_report_[JOB ID]. Open in Excel to view all activity for the job.

• A zip file labelled cmmagent_reports_[JOB ID]. Download this file and unzip it to find:

  • The Migration Report in XLSX format

  • A folder labelled status within which there will be two types of CSV files.

    • success_[JOB ID] – This includes the following information for every item: 

      • Source Path

      • Destination Path

      • Operation

      • Request ID

      • Timestamp for the Operation

      • Source Checksum

      • Destination Checksum

    • on_the_fly_rename_[JOB ID] – This is only generated if Sanitize on-the-Fly is selected when running a command. For files renamed on the fly, the original source name and the new destination name will be displayed. It also provides the same supporting information as included in the success file. 

Logs Saved to the Local Machine Where the Agent Is Installed

The location of the logs depends on how the Agent is logged in and can be found in one of two places.

If logged in as the Local System, go to:

C:\Windows\System32\config\systemprofile\AppData\Local\egnyte-agent\

If logged in as the Local User, go to:

C:\Users\[username]\AppData\Local\egnyte-agent\

Within this folder, there is a folder for each migration job, labeled with the Migration ID. Each folder contains a variety of files and subfolders.

Migration Report

The Migration Report is the same XLSX file available on the Egnyte domain. It is updated each time a migration job completes a command.

Scan Folder

Click to open the scan folder. For every command executed for this job, multiple CSV files are generated. Every file is appended with “_[JOB ID]_[time/date stamp]_[Agent version].”

• cmmagent file – Created whenever a scan is run. May be eliminated in the future as it does not provide any additional information.

• scan file – Also generated for every command. It provides a complete list of all files and folders, including their path name. If IsDir is TRUE, the object is a folder. Each line item includes file size and last modified time.

• empty_folder file – The file is generated only if empty folders are included in the migration command. It lists all empty folders identified on the source.

• diff- file – This file is only generated as part of a True-Up. It provides a list of all files to be deleted, and why.

• diff+ file – Also only generated as part of a True-Up. It provides a list of all files to be added.

Status Folder

The status folder is created only after Data Migration or True-Up. The users can check the CSV files in this folder to get the list of all the successful transfers. Within it will be two types of CSV files.

• success_[JOB ID] – This includes the following information for every item: 

  • Source Path

  • Destination Path

  • Operation

  • Request ID

  • Timestamp for the Operation

  • Source Checksum

  • Destination Checksum

• on_the_fly_rename_[JOB ID] – This is only generated if the user selected Sanitize on-the-Fly. For files renamed on the fly, the original source name and the new destination name will be displayed. It also provides the same supporting information as included in the success file. 

Diskhash Folder

This is only created if a True-Up is run, and contains several files that are only used by the back-end system.

Logs Folder

This folder contains only 1 file.

• cmmagent-log-[JOB ID].log – This is a text file that can be opened in Console, Shell or Terminal. This file can be used to drill down into the job behavior, as it includes all Agent logs.

PFFL Folder

This is only created when the True-Up is run AND Sync Deletes is enabled. If Sync Deletes is disabled, this will not appear. One file will be enclosed:

• pffl_egnytecontrolplane_[JOB ID]_[time/date stamp]_[Agent version].csv 

Perms Folder

If a Permissions Simulation or Migration is run, the perms folder will contain the following:

• eg_perms_[JOB ID]_[time/date stamp]_[Agent version].json – Includes a list of all permissions from the destination.

• fail_eg_perms_[time/date stamp]_[Agent version].json – Lists any permissions that failed to migrate

• folder_list.json – Provides a list of folders on the source.

• permission-report-success_[JOB ID]_[time/date stamp]_[Agent version].csv – This is a list of successful permission migrations.

• raw_perms_ fail_eg_perms_[time/date stamp]_[Agent version].json – List of any permissions that failed to migrate.

Logs Saved to Egnyte’s Support Domain

In addition to logs saved to the Customer Domain and the Local Host where the Agent is installed, the same logs are saved to Egnyte’s internal support domain. This helps the Egnyte Support Team provide educated, intelligent support for any issues or questions regarding Migration App performance.

Questions? Feature Requests? Other Feedback?

Feature suggestions or requests can be submitted here. Please mention Migration App in the text.

For more complex requests that may benefit from screenshots or other attachments, submissions can be sent to support@egnyte.com. Include Migration App in the email title. The Egnyte Support Team will forward the comments to the Product Team for consideration.