log_directory Property
The path to a directory for logging.
Syntax
def get_log_directory() -> str: ... def set_log_directory(value: str) -> None: ...
log_directory = property(get_log_directory, set_log_directory)
Default Value
""
Remarks
Setting log_directory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the class will log the complete text of the outgoing request and the incoming response.
The class will write multiple log file for each transmission, with separate extensions for each type of data:
| Status (.log) | Contains information on applied security options and pass/fail status of transmission |
| Request (.req) | Contains the outgoing request, after security options have been applied |
| Payload (.dat) | Contains log of unsecured payload prior to transmission |
| MDN Receipt (.mdn) | For synchronous requests or asynchronous receipts verified with verify_receipt, contains MDN receipt. |
| Error (.err) | This is only written in an error is encountered, containing the error. |
One or more of these logs may be disabled by setting the LogOptions configuration setting.
log_directory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the class will attempt to create the directory. The following macros are supported:
| %MessageID% | The MessageID of the AS2 transmission, after it is generated. |
| %AS2From% | The AS2-From field in the transmission |
| %OriginalMessageID% | In MDN Receipts, the MessageID of the transmission that the receipt is for. You can use this to pair asynchronous MDN receipt logs with their transmissions |
| %date:format% | %Format% is a platform-specific date/time formatting string. For example: |
The filenames will be chosen automatically by the class. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed log_file will contain the name of the files just written, minus the extension.
If logs cannot be written an exception will be thrown.