kallithea Files · docs/usage/debugging.rst

Files @ 92b4b392b0df

Branch filter:

Location: kallithea/docs/usage/debugging.rst

92b4b392b0df 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Søren Løvborg

db: remove redundant unique constraints from primary keys

Primary keys are always unique, both in the SQL standard and in SQLite,
MySQL and PostgreSQL.

Setting unique=True cases SQLAlchemy to explicitly add additional,
redundant UNIQUE indexes to the columns, which is at best needless
metadata overhead, and at worst causes the database engine to waste
time maintaining an extra index that serves no purpose.

.. _debugging:

===================
Debugging Kallithea
===================

If you encounter problems with Kallithea, here are some instructions
on how to debug them.

.. note:: First make sure you're using the latest version available.


Enable detailed debug
---------------------

Kallithea uses the standard Python ``logging`` module to log its output.
By default only loggers with ``INFO`` level are displayed. To enable full output
change ``level = DEBUG`` for all logging handlers in the currently used .ini file.
This change will allow you to see much more detailed output in the log file or
console. This generally helps a lot to track issues.


Enable interactive debug mode
-----------------------------

To enable interactive debug mode simply comment out ``set debug = false`` in
the .ini file. This will trigger an interactive debugger each time
there is an error in the browser, or send a http link if an error occurred in the backend. This
is a great tool for fast debugging as you get a handy Python console right
in the web view.

.. warning:: NEVER ENABLE THIS ON PRODUCTION! The interactive console
             can be a serious security threat to your system.