Log CkPython Reference Documentation

CkLog

Current Version: 11.5.0

Chilkat.Log

Build readable structured diagnostic logs with nested context and tagged values.

Chilkat.Log is a lightweight structured logging helper for creating readable diagnostic logs from application code. It can record nested operation contexts, informational messages, error messages, timestamps, integers, 64-bit integers, tagged values, binary data, Base64 data, hex data, shortened data previews, and computed hashes. It is useful when code needs a clear step-by-step record of operations, inputs, outputs, and diagnostic values for troubleshooting.

Nested operation context

Use EnterContext and LeaveContext to group log entries under readable operation names.

Messages and errors

Add informational messages, error messages, and tagged text values to explain what the application is doing.

Numbers and timestamps

Log integers, 64-bit integers, timestamps, and date/time values when tracing state changes or timing-sensitive workflows.

Binary diagnostics

Record binary data as Base64, hex, or shortened previews so byte-level values can be inspected safely in text logs.

Hash logging

Compute and log hashes of data when comparing content, verifying transformations, or avoiding full data dumps.

Clear and reuse

Clear the log and continue building new diagnostic output during repeated operations or test runs.

Common pattern: Create a Log object, enter a named context for the operation, log the important values and decisions as the code runs, leave the context, and inspect the resulting text if troubleshooting is needed. Use Chilkat.Log for application-level diagnostic output; use LastErrorText on Chilkat objects for detailed diagnostics from Chilkat method calls.

For an extended overview, see Log Class Overview.

Object Creation

obj = chilkat.CkLog()

Properties

DebugLogFilePath
# strVal is a string
# ckStr is a CkString
log.get_DebugLogFilePath(ckStr);
strVal = log.debugLogFilePath();
log.put_DebugLogFilePath(strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
log.get_LastErrorHtml(ckStr);
strVal = log.lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
# strVal is a string
# ckStr is a CkString
log.get_LastErrorText(ckStr);
strVal = log.lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
# strVal is a string
# ckStr is a CkString
log.get_LastErrorXml(ckStr);
strVal = log.lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
# boolVal is a boolean
boolVal = log.get_LastMethodSuccess();
log.put_LastMethodSuccess(boolVal);

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
Utf8
# boolVal is a boolean
boolVal = log.get_Utf8();
log.put_Utf8(boolVal);

When set to True, all string arguments and return values are interpreted as UTF-8 strings. When set to False, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is True. Before v11.0.0, it was False.

More Information and Examples
Strings in Python: Encoding, UTF-8, and Source File Format Considerations
top
VerboseLogging
# boolVal is a boolean
boolVal = log.get_VerboseLogging();
log.put_VerboseLogging(boolVal);

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
# strVal is a string
# ckStr is a CkString
log.get_Version(ckStr);
strVal = log.version();

Version of the component/library, such as "10.1.0"

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

Clear
# initialTag is a string
log.Clear(initialTag);
Introduced in version 9.5.0.44

Clears all existing log entries and starts a new log whose top-level context is named initialTag.

Typical use: Call this at the beginning of an operation or test run, then add entries with the other Log* methods. The completed structured log can be inspected through the Log object's diagnostic text, such as LastErrorText.
top
EnterContext
# tag is a string
log.EnterContext(tag);
Introduced in version 9.5.0.44

Begins a nested logging context named tag. Entries written after this call are grouped inside the new context until a matching LeaveContext is called.

Balanced contexts: Pair each EnterContext with LeaveContext. Contexts may be nested to reflect operation hierarchy.
More Information and Examples
Enter/Leave Context in Logging
top
LeaveContext
log.LeaveContext();
Introduced in version 9.5.0.44

Ends the current nested logging context and returns logging to its parent context.

Empty contexts are omitted: If nothing was logged after entering the current context, Chilkat automatically removes that empty context when it is left.
top
LogData
# tag is a string
# message is a string
log.LogData(tag, message);
Introduced in version 9.5.0.44

Adds a tagged text value to the current context. The output associates tag with message, making this useful for named values such as filenames, paths, IDs, states, or protocol fields.

Sensitive data: Avoid logging passwords, private keys, access tokens, session secrets, or other sensitive values unless disclosure is intentional.
top
LogDataMax
# tag is a string
# message is a string
# maxNumChars is an integer
log.LogDataMax(tag, message, maxNumChars);
Introduced in version 9.5.0.44

Adds a tagged text value to the current context, but limits the logged value to at most the first maxNumChars characters of message.

Diagnostic previews: Use this when a value may be very large and only a leading preview is needed. The original input string is not modified.
top
LogDateTime
# tag is a string
# gmt is a boolean
log.LogDateTime(tag, gmt);
Introduced in version 9.5.0.44

Logs the current date and time under tag using an RFC 822-style date/time representation. If gmt is True, the logged time is GMT/UTC; otherwise local system time is used.

Date/time vs. timestamp: Use LogDateTime for a calendar date with timezone context. Use LogTimestamp for a time-of-day marker.
top
LogError
# message is a string
log.LogError(message);
Introduced in version 9.5.0.44

Adds message as an error entry in the current logging context.

Application diagnostics: This is application-defined logging. It is separate from LastErrorText produced by other Chilkat objects when their operations fail.
top
LogInfo
# message is a string
log.LogInfo(message);
Introduced in version 9.5.0.44

Adds message as an informational entry in the current logging context.

Structured tracing: Use informational entries for significant steps and decisions. Use LogData when the entry is better represented as a named value.
top
LogInt
# tag is a string
# value is an integer
log.LogInt(tag, value);
Introduced in version 9.5.0.44

Adds the integer value to the current log under tag.

top
LogInt64
# tag is a string
# value is a 64-bit integer
log.LogInt64(tag, value);
Introduced in version 9.5.0.44

Adds the signed 64-bit integer value to the current log under tag.

64-bit values: Useful for values such as large byte counts, file sizes, sequence numbers, or timestamps that can exceed ordinary integer ranges.
top
LogTimestamp
# tag is a string
log.LogTimestamp(tag);
Introduced in version 9.5.0.44

Logs the current time-of-day under tag in HH:MM:SS:mmm form, where mmm represents milliseconds.

Timing note: This is a time-of-day marker, not a monotonic elapsed-time measurement.
top

Deprecated

LogDataBase64 Deprecated
# tag is a string
# data is a CkByteData
log.LogDataBase64(tag, data);
Introduced in version 9.5.0.44

Encodes the supplied binary data as Base64 and adds the encoded value to the current log under tag.

Base64: Base64 makes arbitrary bytes printable in a text log. It is an encoding, not encryption.
top
LogDataHex Deprecated
# tag is a string
# data is a CkByteData
log.LogDataHex(tag, data);
Introduced in version 9.5.0.44

Encodes the supplied binary data as hexadecimal text and adds the encoded value to the current log under tag.

Hex output: Hex is convenient for short protocol fields, identifiers, digests, and byte-level troubleshooting because each byte is represented by two hex digits.
top