Logging & Traces

CxLink Backup Settings will log all the information related with a backup or restore execution in its own log file.

Topics


Agent logs

You can find agent logs to help you troubleshoot errors and failures in the following locations:

FilePathDescription
Local log/var/log/emory/SID.logStores all information related with the emory agent execution and the backup/retore process. (SAP HANA backup/restore process will be stored in the global log)
Global log (HANA only)/usr/sap/SID/SYS/global/hdb/opt/log/emory.logStores all information about the backup/restore execution in a single or multihost environment

Set up logging options

You can configure the following parameters in the agent for your log lifecycle:

ParameterDescription
Log Rotation PeriodSpecify the number of day after which the log files will be deleted from the system
Log File Max AgeSpecify the number of days after which a log file will be saved in a new file and the main log will be emptied

Configuration File

You can find these values in the configuration file emory.cfg.

Logging:
  max_age: 30
  rotation_time: 1

You can set the logging options by:

  • Executing the following as SAP Database Administrator user:

    /opt/emory/emory logging <retention_in_days> <rotation_in_days>
    

OR

  • Using the interactive menu by following these guidelines:

    1. Start emory-settings tool by executing /opt/emory/emory as SAP Database Administrator user.

    2. Select Logging file settings from Main Menu to initiate the license specific setup.

      ? CxLink Backup:  [Use arrows to move, enter to select, type to filter]
        --------------------------------------------------------------------------------
        Storage Providers profiles
        Set storage providers for backup/restore, disaster recovery and system copy
        Backups Lifecycle settings
        Monitoring
        --------------------------------------------------------------------------------
        License
        --------------------------------------------------------------------------------
      > Logging file settings
        Debug traces
        Show relevant information of this CxLink Backup
        --------------------------------------------------------------------------------
        Catalog & Backups management
        --------------------------------------------------------------------------------
        Generate troubleshooting package to be sent to Syntax Support
        --------------------------------------------------------------------------------
        Exit
      
    3. Specify the Log File Max Age.

      ? CxLink Backup: Logging file settings
      ? Sets the max age in days of a log file before it gets purged from the file system:  (0)
      
    4. Specify the Log Rotation Period:

      ? CxLink Backup: Logging file settings
      ? Sets the max age in days of a log file before it gets purged from the file system:  1
      ? Sets the time, in days, between rotation:  (0)
      
    5. You can now select Return and Exit to save the configuration if no other action should be taken.

Debug and traces

In case of an issue with the CxLink Backup agent, you can activate the Trace level for emory logging. This will give you a more detailed information on what is happening during a backup or restore execution in the CxLink Backup side. This information is stored in the standard emory.log file.

DANGER

CxLink Backup traces, when active, can increase considerably the CxLink Backup log file. Ensure that you always deactivate them after an incident or performance resolution.

In case of an issue with the CxLink Backup agent, you can activate the Trace level for emory logging. This will give you a more detailed information on what is happening during a

Enable debug traces

Execute the following command as SAP Database Administrator user to activate the traces:

/opt/emory/emory debug true

You can also perform this action through the interactive menu by executing /opt/emory/emory as SAP Database Administrator user and selection the Debug Traces section.

Disable debug traces

Execute the following command as SAP Database Administrator user to disable debug traces:

/opt/emory/emory debug false

You can also perform this action through the interactive menu by executing /opt/emory/emory as SAP Database Administrator user and selection the Debug Traces section.

Generate a troubleshooting package

You can generate automatically a troubleshooting package to be sent to us if required.

You can do that by:

  • Executing the following as SAP Database Administrator user:

    /opt/emory/emory troubleshooting
    

OR

  • Using the interactive menu by following these guidelines:

    1. Start emory-settings tool by executing /opt/emory/emory as SAP Database Administrator user.

    2. Select Generate troubleshooting package to be sent to Syntax Support from Main Menu to generate the package.

      ? CxLink Backup:  [Use arrows to move, enter to select, type to filter]
        --------------------------------------------------------------------------------
        Storage Providers profiles
        Set storage providers for backup/restore, disaster recovery and system copy
        Backups Lifecycle settings
        Monitoring
        --------------------------------------------------------------------------------
        License
        --------------------------------------------------------------------------------
        Logging file settings
        Debug traces
        Show relevant information of this CxLink Backup
        --------------------------------------------------------------------------------
        Catalog & Backups management
        --------------------------------------------------------------------------------
      > Generate troubleshooting package to be sent to Syntax Support
        --------------------------------------------------------------------------------
        Exit
      

In both cases, you will find a .zip file in the same directory where you executed the command.