Skip to main content

Configuring Logging

To help troubleshoot issues, you can enable logging in the connector.

Important:

Only enable logging long enough to capture an issue. Logging decreases performance and can consume a large quantity of disk space.

The settings for logging apply to every connection that uses the Product, so make sure to disable the feature after you are done using it.

In the connection URL, set the LogLevel key to enable logging at the desired level of detail. The following table lists the logging levels provided by the Product, in order from least verbose to most verbose.

LogLevel Value Description

0

Disable all logging.

1

Log severe error events that lead the connector to abort.

2

Log error events that might allow the connector to continue running.

3

Log events that might result in an error if action is not taken.

4

Log general information that describes the progress of the connector.

5

Log detailed information that is useful for debugging the connector.

6

Log all connector activity.

Note:

If UseAwsLogger is set to 1, the connector also logs information from AWS API calls.

To enable logging:

  1. Set the LogLevel property to the desired level of information to include in log files.
  2. Set the LogPath property to the full path to the folder where you want to save log files. To make sure that the connection URL is compatible with all JDBC applications, escape the backslashes (\) in your file path by typing another backslash.

    3. For example, the following connection URL enables logging level 3 and saves the log files in the C:\temp folder:

    jdbc:database://localhost:11000;LogLevel=3;LogPath=C:\\temp

    jdbc:://localhost:11000;LogLevel=3;LogPath=C:\\temp

    jdbc:database://localhost;LogLevel=3;LogPath=C:\\temp

    jdbc:database://redshift.company.us-west-1.redshift.amazonaws.com:9000/Default;LogLevel=3;LogPath=C:\temp

    jdbc:database:drillbit=localhost;LogLevel=3;LogPath=C:\\temp

    jdbc:database://localhost/TeamRoster?LogLevel=3&
    LogPath=C:\\temp

    jdbc:database://archimedes:5480?LogLevel=3&LogPath=C:\\temp

    jdbc:database://archimedes:5480/TeamRoster?UID=skroob&PWD=12345&LogLevel=3&LogPath=C:\\temp

    jdbc:database:Region=us-west-1;LocalMetadataFile=C:\\database\\schema.json;CredentialFilePath=C:\\database\\credentials.txt;ProfileName=simba;LogLevel=3;LogPath=C:\\temp

    jdbc:database://localhost;LogLevel=3;LogPath=C:\\temp

    jdbc:awsdatabase://AwsRegion=us-east-1;User=ABCABCABC123ABCABC45;Password=bCD+E1f2Gxhi3J4klmN/OP5QrSTuvwXYzabcdEF;S3OutputLocation=s3://test-athena-results/;LogLevel=3;LogPath=C:\\temp

    jdbc:database://FilePath=C:\\Projects\\ExcelJDBC\\sampleworkbook.xlsx;LogLevel=3;LogPath=C:\\temp

  3. Optionally, to include information about AWS API calls in the log, set UseAwsLogger to 1.
  4. Optionally, to include information from the Database Java connector in the log, set EnableJavaDriverLogging to true.
  5. Optionally, to create trace-level connection logs from the Database web server connector, set EnableWSCTraceLogging to 1.
    6. Important:

    Important:

    Enabling the EnableWSCTraceLogging property captures the authentication credentials in plain text. Use this feature at your own risk.

  6. To make sure that the new settings take effect, restart your JDBC application and reconnect to the serverworkbook.

The Product produces a log file named DriverLog.log in the location specified in the LogPath property.

The Product produces the following log files in the location specified in the LogPath property:

  • A simbadatabasejdbcdriver.log file that logs connector activity that is not specific to a connection.
  • A simbadatabasejdbcdriver_connection_[Number].log file for each connection made to the database, where [Number] is a number that identifies each log file. This file logs connector activity that is specific to the connection.
  • An MDBJDriver_driver.log file that logs connector activity that is not specific to a connection.
  • AnJDBC_driver.log file that logs connector activity that is not specific to a connection.
  • AnJDBC_connection_[Number].log file for each connection made to the database, where [Number] is a number that identifies each log file. This file logs connector activity that is specific to the connection.
  • A DatabaseJDBC_connection_[Number].log and DatabaseJDBC_connection_ext_[Number].log file for each connection made to the database, where [Number] is a number that identifies each log file. These files log connector activity that is specific to the connection.
  • When EnableWSCTraceLogging is set to 1, the connector also produces a Database_connection_[Number]_traceLogs.txt file for each connection made to the database, where [Number] is a number that identifies each log file. The file contains additional trace information.

If the LogPath value is invalid, then the connector sends the logged information to the standard output stream (System.out).

To disable logging:

  1. Set the LogLevel property to 0.
  2. To make sure that the new setting takes effect, restart your JDBC application and reconnect to the server.

Related topics

  • Additional Logging
  • Configuring the Product on page 1
  • Building the Connection URL
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • Building the Connection URL on page 1
  • LogLevel
  • LogPath

Was this article helpful?

We're sorry to hear that.