LogModules
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Data Type
string
Default Value
""
Remarks
The driver writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual driver operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the driver to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The following table lists the available logging modules and submodules, along with a security classification that indicates the risk that their logs may expose sensitive data. These classifications reflect the driver's intended logging behavior and can help you determine which modules to include when sharing logs. Always review log contents before sharing them outside your organization, as provider-specific code may log additional information under a module:
- Safe: Internal events, lifecycle, protocol status, schema, and metadata. No customer data.
- Caution: SQL with literal values, request filters, or argument values that may indirectly expose customer data.
- Unsafe: Result sets, response bodies, payloads, raw TCP data, bulk uploads, or other customer data.
| Module | Submodule | Classification | Notes |
| INFO | (module-level) | Safe | Connection string is logged. Passwords, secrets, and tokens are redacted; hostnames, usernames, and connection options remain. |
| INFO | Connec | Safe | Connection lifecycle. |
| INFO | Messag | Safe | Driver-internal info. |
| EXEC | Messag | Safe | Driver-internal execution events. |
| EXEC | Normlz | Caution | Rewritten/normalized queries that retain literal values (i.e., WHERE Email = '[email protected]'). |
| EXEC | Origin | Caution | Verbatim user SQL; literals in query may include PII. |
| EXEC | Page | Safe | Paging metadata. |
| EXEC | Parsed | Caution | Parsed SQL with literals. |
| HTTP | KERB | Caution | Kerberos-related HTTP; auth tokens possible. |
| HTTP | Messag | Safe | Driver-internal HTTP. |
| HTTP | Unpack | Unsafe | Unpacked API responses are source data. |
| HTTP | Res | Unsafe | Response bodies are source data. |
| HTTP | Req | Caution | Request bodies may include query filters or POST values. |
| WSDL | — | Safe | WSDL/XSD generation only. |
| SSL | Certif | Safe | Cert metadata. |
| AUTH | Messag | Safe | Messages pertaining to authentication. |
| AUTH | OAuth | Safe | Messages pertaining to OAuth flow. |
| AUTH | Krbros | Safe | Messages pertaining to Kerberos. |
| SQL | Bulk | Safe | Status updates on bulk query execution. |
| SQL | Cache | Safe | Status of cache data being read/written. |
| SQL | Messag | Safe | Driver-internal SQL transaction events. |
| SQL | ResSet | Safe | Metadata about result sets. |
| SQL | Transc | Safe | Transaction metadata. |
| META | Cache | Safe | Messages about retrieving/writing column and table metadata. |
| META | Schema | Safe | Messages about schema metadata. |
| META | MemSto | Safe | In-memory metadata cache events. |
| META | Storag | Safe | Metadata persistence events. |
| FUNC | Errmsg | Safe | Error messages from the driver. |
| TCP | Send | Caution | Raw outbound TCP bytes. Would log data being written by the customer. Safe for reads. |
| TCP | Receiv | Unsafe | Raw inbound TCP bytes; source payloads. |
| FTP | Info | Safe | Protocol status. |
| FTP | Client | Caution | Client actions may include filenames or credentials. |
| FTP | Server | Unsafe | Server responses may include file contents. |
| SFTP | Info | Safe | Protocol status. |
| SFTP | To_Server | Caution | Client actions may include filenames or credentials. |
| SFTP | From_Server | Unsafe | Server responses may include file contents. |
| POP | Client | Caution | Client actions; mailbox or credential references. |
| POP | Server | Unsafe | Server responses may include message bodies. |
| POP | Status | Safe | Protocol status. |
| SMTP | Client | Caution | Client actions; message metadata. |
| SMTP | Server | Caution | Server responses; status-oriented. |
| SMTP | Status | Safe | Protocol status. |
| CORE | — | Safe | Internal product operations. |
| DEMN | — | Safe | SQL remoting internals. |
| CLJB | Commit | Safe | Only logs status updates for bulk jobs. |
| SRCE | — | Caution | Usage varies by driver. |
| TPJE | Trace | Safe | Advanced messages concerning low-level product operations. |
| ODBC | — | Unsafe | Logs resultset values. |
| ODBC | Debug | Caution | May log the user's arguments. Includes detailed diagnostic messages for troubleshooting ODBC driver behavior and API interactions. |