Changeset - 4869a8bb1237
Parent rev.
Child rev.
[Not reviewed]
default
0 3 0
Mads Kiilerich - 6 years ago 2020-04-22 20:47:02
mads@kiilerich.com
Grafted from: fddfd8c4b84e
ini: tweak template configuration for TG's handling of application errors

Mention what was learned while debugging request processing at WSGI/TG level
and the complexity of the TG stack gets in the way.
3 files changed with 45 insertions and 19 deletions:
development.ini
16
10
docs/contributing.rst
14
kallithea/lib/paster_commands/template.ini.mako
15
9
0 comments (0 inline, 0 general)
development.ini
➞
Show inline comments
 
@@ -315,33 +315,39 @@ session.secret = development-not-secret
 

			




	
	
	
		
 
## Database storage of session data.

			




	
	
	
		
 
#session.type = ext:database

			




	
	
	
		
 
#session.sa.url = postgresql://postgres:qwe@localhost/kallithea

			




	
	
	
		
 
#session.table_name = db_session

			




	
	
	
		
 

			




	
	
	
		
 
############################

			




	
	
	
		
 
## ERROR HANDLING SYSTEMS ##

			




	
	
	
		
 
############################

			




	
	
	
		
 
####################################

			




	
	
	
		
 
###       ERROR HANDLING        ####

			




	
	
	
		
 
####################################

			




	
	
	
		
 

			




	
	
	
		
 
## Show a nice error page for application HTTP errors and exceptions (default true)

			




	
	
	
		
 
#errorpage.enabled = true

			




	
	
	
		
 

			




	
	
	
		
 
## Enable Backlash client-side interactive debugger (default false)

			




	
	
	
		
 
## WARNING: *THIS MUST BE false IN PRODUCTION ENVIRONMENTS!!!*

			




	
	
	
		
 
## This debug mode will allow all visitors to execute malicious code.

			




	
	
	
		
 
#debug = false

			




	
	
	
		
 
debug = true

			




	
	
	
		
 

			




	
	
	
		
 
## Enable Backlash server-side error reporting (unless debug mode handles it client-side) (default true)

			




	
	
	
		
 
#trace_errors.enable = true

			




	
	
	
		
 
## Errors will be reported by mail if trace_errors.error_email is set.

			




	
	
	
		
 

			




	
	
	
		
 
## Propagate email settings to ErrorReporter of TurboGears2

			




	
	
	
		
 
## You do not normally need to change these lines

			




	
	
	
		
 
get trace_errors.smtp_server = smtp_server

			




	
	
	
		
 
get trace_errors.smtp_port = smtp_port

			




	
	
	
		
 
get trace_errors.from_address = error_email_from

			




	
	
	
		
 
get trace_errors.error_email = email_to

			




	
	
	
		
 
get trace_errors.smtp_username = smtp_username

			




	
	
	
		
 
get trace_errors.smtp_password = smtp_password

			




	
	
	
		
 
get trace_errors.smtp_use_tls = smtp_use_tls

			




	
	
	
		
 

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
## WARNING: *DEBUG MODE MUST BE OFF IN A PRODUCTION ENVIRONMENT*              ##

			




	
	
	
		
 
## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##

			




	
	
	
		
 
## execute malicious code after an exception is raised.                       ##

			




	
	
	
		
 
################################################################################

			




	
	
	
		
 
#debug = false

			




	
	
	
		
 
debug = true

			




	
	
	
		
 

			




	
	
	
		
 
##################################

			




	
	
	
		
 
###       LOGVIEW CONFIG       ###

			




	
	
	
		
 
##################################

			




	
	
	
		
 

			




	
	
	
		
 
logview.sqlalchemy = #faa

			




        

    


    
    

    

        

                

                    docs/contributing.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -263,12 +263,26 @@ rarely needed:

			




	
	
	
		
 
SQLAlchemy also flushes changes to the database automatically; manually

			




	
	
	
		
 
calling ``Session().flush`` is usually only necessary when the Python

			




	
	
	
		
 
code needs the database to assign an "auto-increment" primary key ID to

			




	
	
	
		
 
a freshly created model object (before flushing, the ID attribute will

			




	
	
	
		
 
be ``None``).

			




	
	
	
		
 

			




	
	
	
		
 
Debugging

			




	
	
	
		
 
^^^^^^^^^

			




	
	
	
		
 

			




	
	
	
		
 
A good way to trace what Kallithea is doing is to keep an eye on the output of

			




	
	
	
		
 
stdout/stderr from the server process. Perhaps change ``my.ini`` to log at

			




	
	
	
		
 
``DEBUG`` or ``INFO`` level, especially ``[logger_kallithea]``, but perhaps

			




	
	
	
		
 
also other loggers. It is often easier to add additional ``log`` or ``print``

			




	
	
	
		
 
statements than to use a Python debugger.

			




	
	
	
		
 

			




	
	
	
		
 
Sometimes it is simpler to disable ``errorpage.enabled`` and perhaps also

			




	
	
	
		
 
``trace_errors.enable`` to expose raw errors instead of adding extra

			




	
	
	
		
 
processing. Enabling ``debug`` can be helpful for showing and exploring

			




	
	
	
		
 
tracebacks in the browser, but is also insecure and will add extra processing.

			




	
	
	
		
 

			




	
	
	
		
 
TurboGears2 DebugBar

			




	
	
	
		
 
^^^^^^^^^^^^^^^^^^^^

			




	
	
	
		
 

			




	
	
	
		
 
It is possible to enable the TurboGears2-provided DebugBar_, a toolbar overlayed

			




	
	
	
		
 
over the Kallithea web interface, allowing you to see:

			




	
	
	
		
 

			




        

    


    
    

    

        

                

                    kallithea/lib/paster_commands/template.ini.mako
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -388,15 +388,27 @@ session.secret = ${uuid()}

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Database storage of session data.</%text>

			




	
	
	
		
 
#session.type = ext:database

			




	
	
	
		
 
#session.sa.url = postgresql://postgres:qwe@localhost/kallithea

			




	
	
	
		
 
#session.table_name = db_session

			




	
	
	
		
 

			




	
	
	
		
 
<%text>############################</%text>

			




	
	
	
		
 
<%text>## ERROR HANDLING SYSTEMS ##</%text>

			




	
	
	
		
 
<%text>############################</%text>

			




	
	
	
		
 
<%text>####################################</%text>

			




	
	
	
		
 
<%text>###       ERROR HANDLING        ####</%text>

			




	
	
	
		
 
<%text>####################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Show a nice error page for application HTTP errors and exceptions (default true)</%text>

			




	
	
	
		
 
#errorpage.enabled = true

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Enable Backlash client-side interactive debugger (default false)</%text>

			




	
	
	
		
 
<%text>## WARNING: *THIS MUST BE false IN PRODUCTION ENVIRONMENTS!!!*</%text>

			




	
	
	
		
 
<%text>## This debug mode will allow all visitors to execute malicious code.</%text>

			




	
	
	
		
 
#debug = false

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Enable Backlash server-side error reporting (unless debug mode handles it client-side) (default true)</%text>

			




	
	
	
		
 
#trace_errors.enable = true

			




	
	
	
		
 
<%text>## Errors will be reported by mail if trace_errors.error_email is set.</%text>

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Propagate email settings to ErrorReporter of TurboGears2</%text>

			




	
	
	
		
 
<%text>## You do not normally need to change these lines</%text>

			




	
	
	
		
 
get trace_errors.smtp_server = smtp_server

			




	
	
	
		
 
get trace_errors.smtp_port = smtp_port

			




	
	
	
		
 
get trace_errors.from_address = error_email_from

			




	
	
		
 
@@ -478,18 +490,12 @@ sentry.secret_key =

			




	
	
	
		
 
sentry.project =

			




	
	
	
		
 
sentry.site =

			




	
	
	
		
 
sentry.include_paths =

			




	
	
	
		
 
sentry.exclude_paths =

			




	
	
	
		
 

			




	
	
	
		
 
%endif

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
<%text>## WARNING: *DEBUG MODE MUST BE OFF IN A PRODUCTION ENVIRONMENT*              ##</%text>

			




	
	
	
		
 
<%text>## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##</%text>

			




	
	
	
		
 
<%text>## execute malicious code after an exception is raised.                       ##</%text>

			




	
	
	
		
 
<%text>################################################################################</%text>

			




	
	
	
		
 
debug = false

			




	
	
	
		
 

			




	
	
	
		
 
<%text>##################################</%text>

			




	
	
	
		
 
<%text>###       LOGVIEW CONFIG       ###</%text>

			




	
	
	
		
 
<%text>##################################</%text>

			




	
	
	
		
 

			




	
	
	
		
 
logview.sqlalchemy = #faa

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2025 by various authors & licensed under GPLv3.