Export Log Stream

Contents


1   Description

This instruction describes how to export a registered log stream to an external storage system.

Export is used to store the important Managed Element (ME) logs in a location outside of the node where they are generated, which can be useful for network or system administrators. It therefore limits the impact of log entry loss because of log rotation and storage constraints on the node.

An export action for a registered log stream causes all the ME log files for that log stream to be collected in a single tarball file for export.

The syntax of the exported log filename is the following:

2   Procedure

2.1   Export Log Stream

Prerequisites

Steps

  1. Navigate to the Log managed object, for example:

    >dn ManagedElement=NODE06ST,SystemFunctions=1,LogM=1,Log=saLogSystem

  2. Start the export operation, for example:

    (Log=saLogSystem)>export --uri "sftp://hostuser1@host1/home/hostuser1/" --password "hostuser1pw"

    Where:

    • hostuser1@host1 is the <user_id>@<hostname_or_IP_address> of the remote server.
    • /home/hostuser1/ is the remote destination directory of the remote server.
    • hostuser1pw is the password of the remote server. This password is optional. If a password is not required to access the URI, leave out the --password parameter.

    The system returns output true when the process starts.

  3. Verify that the log stream is exported:

    (Log=saLogSystem)>show reportProgress

    Note:  
    As this is a long-running operation, it can be necessary to enter the command several times until the final operation result is shown in the progress report.

    After a log stream is successfully exported, the following shows an example of the progress report:

    [...]
    actionName="EXPORT"
    additionalInfo="saLogSystem_20170404_111404.gz is exported successfully to destination."
    progressInfo=""
    progressPercentage=100
    result=SUCCESS
    resultInfo="Export action is successful."
    state=FINISHED
    [...]

    If an error occurs during the execution of the operation, the progress report shows result=FAILURE and additionalInfo shows the cause of the failure. The cause can be an invalid URI, a password error, a cancelled operation, or disk storage or communication issues with the remote server.

    To cancel the ongoing log export, use action cancel.

    For more information on the progress report, refer to View Export Log Stream Progress Report.