kallithea Files · docs/usage/debugging.rst

Files @ e85f5bf7ad74

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Mads Kiilerich

middleware: drop sentry support

Our sentry support didn't seem to work with py3. It doesn't seem to ever have
been tested on py3 - it failed already when installing.

It seems like we used the 'legacy client':
https://docs.sentry.io/clients/python/
and nowadays one is expected to use:
https://docs.sentry.io/platforms/python/
which has integrations for Pyramid and other frameworks (but not TG2). There
are Celery and SQLAlchemy integrations too. See also the migration guide:
https://docs.sentry.io/platforms/python/migration/ .

Also, there is not much essential code in the old sentry support, and it seems
like it would be easier to reimplement from scratch. There is thus not much
lost by dropping it.

.. _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.