Logging and Diagnostics Leave feedback
On this page
To enable logging, wire the built-in ConsoleLogger class through ConverterSettings when constructing the Converter. The logger emits three types of messages:
- Error: for critical exceptions that prevent execution.
- Warning: for recoverable or expected issues.
- Trace: for general informational messages.
To stream log messages to standard output, instantiate ConsoleLogger, assign it to ConverterSettings.logger, and pass the settings to the Converter constructor:
from groupdocs.conversion import Converter, ConverterSettings
from groupdocs.conversion.logging import ConsoleLogger
from groupdocs.conversion.options.convert import PdfConvertOptions
def write_logs_to_console():
# Create a console logger
console_logger = ConsoleLogger()
# Create converter settings and pass logger
converter_settings = ConverterSettings()
converter_settings.logger = console_logger
# Load DOCX document and convert it to PDF
with Converter("./business-plan.docx", converter_settings) as converter:
pdf_convert_options = PdfConvertOptions()
converter.convert("./business-plan.pdf", pdf_convert_options)
if __name__ == "__main__":
write_logs_to_console()
business-plan.docx is the sample file used in this example. Click here to download it.
Binary file (PDF, 283 KB)
console_loggeris created to facilitate logging. This logger sends log messages to the console.converter_settingsis instantiated, with itsloggerattribute set to the previously createdconsole_logger.- A
Converterobject is instantiated with the configuredconverter_settings. - The
convertmethod is called and the conversion occurs, log messages are generated and displayed in the console.
The Python binding ships a single ConsoleLogger that writes to standard output. To persist the log stream to a text file, redirect sys.stdout for the duration of the conversion — the logger will then write its messages into the file handle:
import sys
from groupdocs.conversion import Converter, ConverterSettings
from groupdocs.conversion.logging import ConsoleLogger
from groupdocs.conversion.options.convert import PdfConvertOptions
def write_logs_to_file():
log_file_path = "./log.txt"
# Redirect standard output to a file so ConsoleLogger writes into it
original_stdout = sys.stdout
with open(log_file_path, "w", encoding="utf-8") as log_file:
sys.stdout = log_file
try:
# Create converter settings and attach the console logger
converter_settings = ConverterSettings()
converter_settings.logger = ConsoleLogger()
# Load DOCX document and convert it to PDF
with Converter("./business-plan.docx", converter_settings) as converter:
pdf_convert_options = PdfConvertOptions()
converter.convert("./business-plan.pdf", pdf_convert_options)
finally:
sys.stdout = original_stdout
if __name__ == "__main__":
write_logs_to_file()
[TRACE] Attempting to read the 'GROUPDOCS_LIC_PATH' environment variable for license file location.
[TRACE] GroupDocs license has been set successfully.
[TRACE] Determine loader for source document business-plan.docx ...
[TRACE] ... loader selected.
[TRACE] Loading source document business-plan.docx ...
[TRACE] ... document loaded.
[TRACE] Main document will be converted.
[TRACE] Starting conversion of business-plan.docx...
[TRACE] ... converter selected ...
[TRACE] ... conversion completed.
business-plan.docx is the sample file used in this example. Click here to download it.
Binary file (PDF, 283 KB)
sys.stdoutis redirected to alog.txtfile so anyprint-style writes (including the ones emitted byConsoleLogger) land in the file.ConverterSettingsis instantiated withloggerset to a freshConsoleLoggerinstance.- A
Converterobject is created with the configured settings and performs the conversion — trace messages are captured in the file instead of the terminal. sys.stdoutis restored in thefinallyblock so subsequentprintcalls continue to go to the terminal.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
