Skip to content

Commit 17e9cf3

Browse files
committed
docs: remove log args from connection parameter, explain logging usage
1 parent 0674a55 commit 17e9cf3

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,7 @@ Connection Parameters
131131
+-------------------------+--------------------------------------------------------------------------------------------+---------------+----------+
132132
| idp_response_timeout | Int. The timeout for retrieving SAML assertion from IdP | 120 | No |
133133
+-------------------------+--------------------------------------------------------------------------------------------+---------------+----------+
134-
| listen_port | Int. The listen port IdP will send the SAML assertion to | 7890 | No |
135-
+-------------------------+--------------------------------------------------------------------------------------------+---------------+----------+
136-
| log_level | Int. The level of logging enabled, increasing in granularity (values [0,4] are valid) | 0 | No |
137-
+-------------------------+--------------------------------------------------------------------------------------------+---------------+----------+
138-
| log_path | String. The file path to the log file | 'driver.log' | No |
134+
| listen_port | Int. The listen port IdP will send the SAML assertion to | 7890 | No |
139135
+-------------------------+--------------------------------------------------------------------------------------------+---------------+----------+
140136
| max_prepared_statements | Int. The maximum number of prepared statements that can be open at once | 1000 | No |
141137
+-------------------------+--------------------------------------------------------------------------------------------+---------------+----------+
@@ -171,6 +167,12 @@ Connection Parameters
171167
| app_name | String. The name of the IdP application used for authentication | None | No |
172168
+-------------------------+--------------------------------------------------------------------------------------------+---------------+----------+
173169

170+
Logging
171+
~~~~~~~~~~~~
172+
``redshift_connector`` uses logging for providing detailed error messages regarding IdP authentication. A do-nothing handler is enabled by default as to prevent logs from being output to ``sys.stderr``.
173+
174+
Enable logging in your application to view logs output by ``redshift_connector`` as described in
175+
the `documentation for Python logging module <https://docs.python.org/3/library/logging.html#/>`_.
174176

175177
Getting Help
176178
~~~~~~~~~~~~

0 commit comments

Comments
 (0)