Changeset - 609d52bbf917
Parent rev.
Child rev.
[Not reviewed]
default
0 3 0
Mads Kiilerich - 6 years ago 2019-07-31 02:55:22
mads@kiilerich.com
ini: create separate log handlers for color and null, and add comments hinting how they can be used

Let development.ini use color for the root logger as before. The special effect
of color_sql was not visible with the default sqlalchemy log level of WARN, so
just use color there as well.
3 files changed with 45 insertions and 17 deletions:
development.ini
22
7
kallithea/lib/paster_commands/template.ini.mako
21
5
scripts/generate-ini.py
2
5
0 comments (0 inline, 0 general)
development.ini
➞
Show inline comments
 
@@ -167,297 +167,312 @@ hgencoding = utf-8
 
## Refer to the documentation ("Integration with issue trackers") for more details.
 

			




	
	
	
		
 
## regular expression to match issue references

			




	
	
	
		
 
## This pattern may/should contain parenthesized groups, that can

			




	
	
	
		
 
## be referred to in issue_server_link or issue_sub using Python backreferences

			




	
	
	
		
 
## (e.g. \1, \2, ...). You can also create named groups with '(?P<groupname>)'.

			




	
	
	
		
 
## To require mandatory whitespace before the issue pattern, use:

			




	
	
	
		
 
## (?:^|(?<=\s)) before the actual pattern, and for mandatory whitespace

			




	
	
	
		
 
## behind the issue pattern, use (?:$|(?=\s)) after the actual pattern.

			




	
	
	
		
 

			




	
	
	
		
 
issue_pat = #(\d+)

			




	
	
	
		
 

			




	
	
	
		
 
## server url to the issue

			




	
	
	
		
 
## This pattern may/should contain backreferences to parenthesized groups in issue_pat.

			




	
	
	
		
 
## A backreference can be \1, \2, ... or \g<groupname> if you specified a named group

			




	
	
	
		
 
## called 'groupname' in issue_pat.

			




	
	
	
		
 
## The special token {repo} is replaced with the full repository name

			




	
	
	
		
 
## including repository groups, while {repo_name} is replaced with just

			




	
	
	
		
 
## the name of the repository.

			




	
	
	
		
 

			




	
	
	
		
 
issue_server_link = https://issues.example.com/{repo}/issue/\1

			




	
	
	
		
 

			




	
	
	
		
 
## substitution pattern to use as the link text

			




	
	
	
		
 
## If issue_sub is empty, the text matched by issue_pat is retained verbatim

			




	
	
	
		
 
## for the link text. Otherwise, the link text is that of issue_sub, with any

			




	
	
	
		
 
## backreferences to groups in issue_pat replaced.

			




	
	
	
		
 

			




	
	
	
		
 
issue_sub =

			




	
	
	
		
 

			




	
	
	
		
 
## issue_pat, issue_server_link and issue_sub can have suffixes to specify

			




	
	
	
		
 
## multiple patterns, to other issues server, wiki or others

			




	
	
	
		
 
## below an example how to create a wiki pattern

			




	
	
	
		
 
# wiki-some-id -> https://wiki.example.com/some-id

			




	
	
	
		
 

			




	
	
	
		
 
#issue_pat_wiki = wiki-(\S+)

			




	
	
	
		
 
#issue_server_link_wiki = https://wiki.example.com/\1

			




	
	
	
		
 
#issue_sub_wiki = WIKI-\1

			




	
	
	
		
 

			




	
	
	
		
 
## alternative return HTTP header for failed authentication. Default HTTP

			




	
	
	
		
 
## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with

			




	
	
	
		
 
## handling that. Set this variable to 403 to return HTTPForbidden

			




	
	
	
		
 
auth_ret_code =

			




	
	
	
		
 

			




	
	
	
		
 
## allows to change the repository location in settings page

			




	
	
	
		
 
allow_repo_location_change = True

			




	
	
	
		
 

			




	
	
	
		
 
## allows to setup custom hooks in settings page

			




	
	
	
		
 
allow_custom_hooks_settings = True

			




	
	
	
		
 

			




	
	
	
		
 
## extra extensions for indexing, space separated and without the leading '.'.

			




	
	
	
		
 
# index.extensions =

			




	
	
	
		
 
#    gemfile

			




	
	
	
		
 
#    lock

			




	
	
	
		
 

			




	
	
	
		
 
## extra filenames for indexing, space separated

			




	
	
	
		
 
# index.filenames =

			




	
	
	
		
 
#    .dockerignore

			




	
	
	
		
 
#    .editorconfig

			




	
	
	
		
 
#    INSTALL

			




	
	
	
		
 
#    CHANGELOG

			




	
	
	
		
 

			




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

			




	
	
	
		
 
###        CELERY CONFIG        ####

			




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

			




	
	
	
		
 

			




	
	
	
		
 
use_celery = false

			




	
	
	
		
 

			




	
	
	
		
 
## Example: connect to the virtual host 'rabbitmqhost' on localhost as rabbitmq:

			




	
	
	
		
 
broker.url = amqp://rabbitmq:qewqew@localhost:5672/rabbitmqhost

			




	
	
	
		
 

			




	
	
	
		
 
celery.imports = kallithea.lib.celerylib.tasks

			




	
	
	
		
 
celery.accept.content = pickle

			




	
	
	
		
 
celery.result.backend = amqp

			




	
	
	
		
 
celery.result.dburi = amqp://

			




	
	
	
		
 
celery.result.serialier = json

			




	
	
	
		
 

			




	
	
	
		
 
#celery.send.task.error.emails = true

			




	
	
	
		
 
#celery.amqp.task.result.expires = 18000

			




	
	
	
		
 

			




	
	
	
		
 
celeryd.concurrency = 2

			




	
	
	
		
 
celeryd.max.tasks.per.child = 1

			




	
	
	
		
 

			




	
	
	
		
 
## If true, tasks will never be sent to the queue, but executed locally instead.

			




	
	
	
		
 
celery.always.eager = false

			




	
	
	
		
 

			




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

			




	
	
	
		
 
###         BEAKER CACHE        ####

			




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

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.data_dir = %(here)s/data/cache/data

			




	
	
	
		
 
beaker.cache.lock_dir = %(here)s/data/cache/lock

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.regions = short_term,long_term,sql_cache_short

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.short_term.type = memory

			




	
	
	
		
 
beaker.cache.short_term.expire = 60

			




	
	
	
		
 
beaker.cache.short_term.key_length = 256

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.long_term.type = memory

			




	
	
	
		
 
beaker.cache.long_term.expire = 36000

			




	
	
	
		
 
beaker.cache.long_term.key_length = 256

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.sql_cache_short.type = memory

			




	
	
	
		
 
beaker.cache.sql_cache_short.expire = 10

			




	
	
	
		
 
beaker.cache.sql_cache_short.key_length = 256

			




	
	
	
		
 

			




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

			




	
	
	
		
 
###       BEAKER SESSION        ####

			




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

			




	
	
	
		
 

			




	
	
	
		
 
## Name of session cookie. Should be unique for a given host and path, even when running

			




	
	
	
		
 
## on different ports. Otherwise, cookie sessions will be shared and messed up.

			




	
	
	
		
 
session.key = kallithea

			




	
	
	
		
 
## Sessions should always only be accessible by the browser, not directly by JavaScript.

			




	
	
	
		
 
session.httponly = true

			




	
	
	
		
 
## Session lifetime. 2592000 seconds is 30 days.

			




	
	
	
		
 
session.timeout = 2592000

			




	
	
	
		
 

			




	
	
	
		
 
## Server secret used with HMAC to ensure integrity of cookies.

			




	
	
	
		
 
#session.secret = VERY-SECRET

			




	
	
	
		
 
session.secret = development-not-secret

			




	
	
	
		
 
## Further, encrypt the data with AES.

			




	
	
	
		
 
#session.encrypt_key = <key_for_encryption>

			




	
	
	
		
 
#session.validate_key = <validation_key>

			




	
	
	
		
 

			




	
	
	
		
 
## Type of storage used for the session, current types are

			




	
	
	
		
 
## dbm, file, memcached, database, and memory.

			




	
	
	
		
 

			




	
	
	
		
 
## File system storage of session data. (default)

			




	
	
	
		
 
#session.type = file

			




	
	
	
		
 

			




	
	
	
		
 
## Cookie only, store all session data inside the cookie. Requires secure secrets.

			




	
	
	
		
 
#session.type = cookie

			




	
	
	
		
 

			




	
	
	
		
 
## 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 ##

			




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

			




	
	
	
		
 

			




	
	
	
		
 
# Propagate email settings to ErrorReporter of TurboGears2

			




	
	
	
		
 
# You do not normally need to change these lines

			




	
	
	
		
 
get trace_errors.error_email = email_to

			




	
	
	
		
 
get trace_errors.smtp_server = smtp_server

			




	
	
	
		
 
get trace_errors.smtp_port = smtp_port

			




	
	
	
		
 
get trace_errors.from_address = error_email_from

			




	
	
	
		
 

			




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

			




	
	
	
		
 
## 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

			




	
	
	
		
 
logview.pylons.templating = #bfb

			




	
	
	
		
 
logview.pylons.util = #eee

			




	
	
	
		
 

			




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

			




	
	
	
		
 
### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###

			




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

			




	
	
	
		
 

			




	
	
	
		
 
# SQLITE [default]

			




	
	
	
		
 
sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60

			




	
	
	
		
 

			




	
	
	
		
 
# see sqlalchemy docs for others

			




	
	
	
		
 

			




	
	
	
		
 
sqlalchemy.pool_recycle = 3600

			




	
	
	
		
 

			




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

			




	
	
	
		
 
### ALEMBIC CONFIGURATION   ####

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[alembic]

			




	
	
	
		
 
script_location = kallithea:alembic

			




	
	
	
		
 

			




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

			




	
	
	
		
 
### LOGGING CONFIGURATION   ####

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[loggers]

			




	
	
	
		
 
keys = root, routes, kallithea, sqlalchemy, tg, gearbox, beaker, templates, whoosh_indexer, werkzeug, backlash

			




	
	
	
		
 

			




	
	
	
		
 
[handlers]

			




	
	
	
		
 
keys = console, console_sql

			




	
	
	
		
 
keys = console, console_color, console_color_sql, null

			




	
	
	
		
 

			




	
	
	
		
 
[formatters]

			




	
	
	
		
 
keys = generic, color_formatter, color_formatter_sql

			




	
	
	
		
 

			




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

			




	
	
	
		
 
## LOGGERS ##

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[logger_root]

			




	
	
	
		
 
level = NOTSET

			




	
	
	
		
 
handlers = console

			




	
	
	
		
 
#handlers = console

			




	
	
	
		
 
handlers = console_color

			




	
	
	
		
 
# For coloring based on log level:

			




	
	
	
		
 
# handlers = console_color

			




	
	
	
		
 

			




	
	
	
		
 
[logger_routes]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = routes.middleware

			




	
	
	
		
 
## "level = DEBUG" logs the route matched and routing variables.

			




	
	
	
		
 

			




	
	
	
		
 
[logger_beaker]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = beaker.container

			




	
	
	
		
 

			




	
	
	
		
 
[logger_templates]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = INFO

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = pylons.templating

			




	
	
	
		
 

			




	
	
	
		
 
[logger_kallithea]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = kallithea

			




	
	
	
		
 

			




	
	
	
		
 
[logger_tg]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = tg

			




	
	
	
		
 

			




	
	
	
		
 
[logger_gearbox]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = gearbox

			




	
	
	
		
 

			




	
	
	
		
 
[logger_sqlalchemy]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers = console_sql

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = sqlalchemy.engine

			




	
	
	
		
 
propagate = 0

			




	
	
	
		
 
# For coloring based on log level and pretty printing of SQL:

			




	
	
	
		
 
# level = INFO

			




	
	
	
		
 
# handlers = console_color_sql

			




	
	
	
		
 
# propagate = 0

			




	
	
	
		
 

			




	
	
	
		
 
[logger_whoosh_indexer]

			




	
	
	
		
 
#level = WARN

			




	
	
	
		
 
level = DEBUG

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = whoosh_indexer

			




	
	
	
		
 

			




	
	
	
		
 
[logger_werkzeug]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = werkzeug

			




	
	
	
		
 

			




	
	
	
		
 
[logger_backlash]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = backlash

			




	
	
	
		
 

			




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

			




	
	
	
		
 
## HANDLERS ##

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console]

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
#formatter = generic

			




	
	
	
		
 
formatter = generic

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console_color]

			




	
	
	
		
 
# ANSI color coding based on log level

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = color_formatter

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console_sql]

			




	
	
	
		
 
[handler_console_color_sql]

			




	
	
	
		
 
# ANSI color coding and pretty printing of SQL statements

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
#formatter = generic

			




	
	
	
		
 
formatter = color_formatter_sql

			




	
	
	
		
 

			




	
	
	
		
 
[handler_null]

			




	
	
	
		
 
class = NullHandler

			




	
	
	
		
 
args = ()

			




	
	
	
		
 

			




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

			




	
	
	
		
 
## FORMATTERS ##

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[formatter_generic]

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




	
	
	
		
 

			




	
	
	
		
 
[formatter_color_formatter]

			




	
	
	
		
 
class = kallithea.lib.colored_formatter.ColorFormatter

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




	
	
	
		
 

			




	
	
	
		
 
[formatter_color_formatter_sql]

			




	
	
	
		
 
class = kallithea.lib.colored_formatter.ColorFormatterSql

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




        

    


    
    

    

        

                

                    kallithea/lib/paster_commands/template.ini.mako
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -348,288 +348,304 @@ celery.always.eager = false

			




	
	
	
		
 

			




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

			




	
	
	
		
 
<%text>###         BEAKER CACHE        ####</%text>

			




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

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.data_dir = %(here)s/data/cache/data

			




	
	
	
		
 
beaker.cache.lock_dir = %(here)s/data/cache/lock

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.regions = short_term,long_term,sql_cache_short

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.short_term.type = memory

			




	
	
	
		
 
beaker.cache.short_term.expire = 60

			




	
	
	
		
 
beaker.cache.short_term.key_length = 256

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.long_term.type = memory

			




	
	
	
		
 
beaker.cache.long_term.expire = 36000

			




	
	
	
		
 
beaker.cache.long_term.key_length = 256

			




	
	
	
		
 

			




	
	
	
		
 
beaker.cache.sql_cache_short.type = memory

			




	
	
	
		
 
beaker.cache.sql_cache_short.expire = 10

			




	
	
	
		
 
beaker.cache.sql_cache_short.key_length = 256

			




	
	
	
		
 

			




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

			




	
	
	
		
 
<%text>###       BEAKER SESSION        ####</%text>

			




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

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Name of session cookie. Should be unique for a given host and path, even when running</%text>

			




	
	
	
		
 
<%text>## on different ports. Otherwise, cookie sessions will be shared and messed up.</%text>

			




	
	
	
		
 
session.key = kallithea

			




	
	
	
		
 
<%text>## Sessions should always only be accessible by the browser, not directly by JavaScript.</%text>

			




	
	
	
		
 
session.httponly = true

			




	
	
	
		
 
<%text>## Session lifetime. 2592000 seconds is 30 days.</%text>

			




	
	
	
		
 
session.timeout = 2592000

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Server secret used with HMAC to ensure integrity of cookies.</%text>

			




	
	
	
		
 
session.secret = ${uuid()}

			




	
	
	
		
 
<%text>## Further, encrypt the data with AES.</%text>

			




	
	
	
		
 
#session.encrypt_key = <key_for_encryption>

			




	
	
	
		
 
#session.validate_key = <validation_key>

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Type of storage used for the session, current types are</%text>

			




	
	
	
		
 
<%text>## dbm, file, memcached, database, and memory.</%text>

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## File system storage of session data. (default)</%text>

			




	
	
	
		
 
#session.type = file

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Cookie only, store all session data inside the cookie. Requires secure secrets.</%text>

			




	
	
	
		
 
#session.type = cookie

			




	
	
	
		
 

			




	
	
	
		
 
<%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>

			




	
	
	
		
 

			




	
	
	
		
 
# Propagate email settings to ErrorReporter of TurboGears2

			




	
	
	
		
 
# You do not normally need to change these lines

			




	
	
	
		
 
get trace_errors.error_email = email_to

			




	
	
	
		
 
get trace_errors.smtp_server = smtp_server

			




	
	
	
		
 
get trace_errors.smtp_port = smtp_port

			




	
	
	
		
 
get trace_errors.from_address = error_email_from

			




	
	
	
		
 

			




	
	
	
		
 
%if error_aggregation_service == 'appenlight':

			




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

			




	
	
	
		
 
<%text>### [appenlight] ###</%text>

			




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

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## AppEnlight is tailored to work with Kallithea, see</%text>

			




	
	
	
		
 
<%text>## http://appenlight.com for details how to obtain an account</%text>

			




	
	
	
		
 
<%text>## you must install python package `appenlight_client` to make it work</%text>

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## appenlight enabled</%text>

			




	
	
	
		
 
appenlight = false

			




	
	
	
		
 

			




	
	
	
		
 
appenlight.server_url = https://api.appenlight.com

			




	
	
	
		
 
appenlight.api_key = YOUR_API_KEY

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## TWEAK AMOUNT OF INFO SENT HERE</%text>

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## enables 404 error logging (default False)</%text>

			




	
	
	
		
 
appenlight.report_404 = false

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## time in seconds after request is considered being slow (default 1)</%text>

			




	
	
	
		
 
appenlight.slow_request_time = 1

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## record slow requests in application</%text>

			




	
	
	
		
 
<%text>## (needs to be enabled for slow datastore recording and time tracking)</%text>

			




	
	
	
		
 
appenlight.slow_requests = true

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## enable hooking to application loggers</%text>

			




	
	
	
		
 
#appenlight.logging = true

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## minimum log level for log capture</%text>

			




	
	
	
		
 
#appenlight.logging.level = WARNING

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## send logs only from erroneous/slow requests</%text>

			




	
	
	
		
 
<%text>## (saves API quota for intensive logging)</%text>

			




	
	
	
		
 
appenlight.logging_on_error = false

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## list of additional keywords that should be grabbed from environ object</%text>

			




	
	
	
		
 
<%text>## can be string with comma separated list of words in lowercase</%text>

			




	
	
	
		
 
<%text>## (by default client will always send following info:</%text>

			




	
	
	
		
 
<%text>## 'REMOTE_USER', 'REMOTE_ADDR', 'SERVER_NAME', 'CONTENT_TYPE' + all keys that</%text>

			




	
	
	
		
 
<%text>## start with HTTP* this list be extended with additional keywords here</%text>

			




	
	
	
		
 
appenlight.environ_keys_whitelist =

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## list of keywords that should be blanked from request object</%text>

			




	
	
	
		
 
<%text>## can be string with comma separated list of words in lowercase</%text>

			




	
	
	
		
 
<%text>## (by default client will always blank keys that contain following words</%text>

			




	
	
	
		
 
<%text>## 'password', 'passwd', 'pwd', 'auth_tkt', 'secret', 'csrf'</%text>

			




	
	
	
		
 
<%text>## this list be extended with additional keywords set here</%text>

			




	
	
	
		
 
appenlight.request_keys_blacklist =

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## list of namespaces that should be ignores when gathering log entries</%text>

			




	
	
	
		
 
<%text>## can be string with comma separated list of namespaces</%text>

			




	
	
	
		
 
<%text>## (by default the client ignores own entries: appenlight_client.client)</%text>

			




	
	
	
		
 
appenlight.log_namespace_blacklist =

			




	
	
	
		
 

			




	
	
	
		
 
%elif error_aggregation_service == 'sentry':

			




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

			




	
	
	
		
 
<%text>### [sentry] ###</%text>

			




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

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## sentry is a alternative open source error aggregator</%text>

			




	
	
	
		
 
<%text>## you must install python packages `sentry` and `raven` to enable</%text>

			




	
	
	
		
 

			




	
	
	
		
 
sentry.dsn = YOUR_DNS

			




	
	
	
		
 
sentry.servers =

			




	
	
	
		
 
sentry.name =

			




	
	
	
		
 
sentry.key =

			




	
	
	
		
 
sentry.public_key =

			




	
	
	
		
 
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

			




	
	
	
		
 
logview.pylons.templating = #bfb

			




	
	
	
		
 
logview.pylons.util = #eee

			




	
	
	
		
 

			




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

			




	
	
	
		
 
<%text>### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###</%text>

			




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

			




	
	
	
		
 

			




	
	
	
		
 
%if database_engine == 'sqlite':

			




	
	
	
		
 
# SQLITE [default]

			




	
	
	
		
 
sqlalchemy.url = sqlite:///%(here)s/kallithea.db?timeout=60

			




	
	
	
		
 

			




	
	
	
		
 
%elif database_engine == 'postgres':

			




	
	
	
		
 
# POSTGRESQL

			




	
	
	
		
 
sqlalchemy.url = postgresql://user:pass@localhost/kallithea

			




	
	
	
		
 

			




	
	
	
		
 
%elif database_engine == 'mysql':

			




	
	
	
		
 
# MySQL

			




	
	
	
		
 
sqlalchemy.url = mysql://user:pass@localhost/kallithea?charset=utf8

			




	
	
	
		
 

			




	
	
	
		
 
%endif

			




	
	
	
		
 
# see sqlalchemy docs for others

			




	
	
	
		
 

			




	
	
	
		
 
sqlalchemy.pool_recycle = 3600

			




	
	
	
		
 

			




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

			




	
	
	
		
 
<%text>### ALEMBIC CONFIGURATION   ####</%text>

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[alembic]

			




	
	
	
		
 
script_location = kallithea:alembic

			




	
	
	
		
 

			




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

			




	
	
	
		
 
<%text>### LOGGING CONFIGURATION   ####</%text>

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[loggers]

			




	
	
	
		
 
keys = root, routes, kallithea, sqlalchemy, tg, gearbox, beaker, templates, whoosh_indexer, werkzeug, backlash

			




	
	
	
		
 

			




	
	
	
		
 
[handlers]

			




	
	
	
		
 
keys = console, console_sql

			




	
	
	
		
 
keys = console, console_color, console_color_sql, null

			




	
	
	
		
 

			




	
	
	
		
 
[formatters]

			




	
	
	
		
 
keys = generic, color_formatter, color_formatter_sql

			




	
	
	
		
 

			




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

			




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

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[logger_root]

			




	
	
	
		
 
level = NOTSET

			




	
	
	
		
 
handlers = console

			




	
	
	
		
 
# For coloring based on log level:

			




	
	
	
		
 
# handlers = console_color

			




	
	
	
		
 

			




	
	
	
		
 
[logger_routes]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = routes.middleware

			




	
	
	
		
 
<%text>## "level = DEBUG" logs the route matched and routing variables.</%text>

			




	
	
	
		
 

			




	
	
	
		
 
[logger_beaker]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = beaker.container

			




	
	
	
		
 

			




	
	
	
		
 
[logger_templates]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = pylons.templating

			




	
	
	
		
 

			




	
	
	
		
 
[logger_kallithea]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = kallithea

			




	
	
	
		
 

			




	
	
	
		
 
[logger_tg]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = tg

			




	
	
	
		
 

			




	
	
	
		
 
[logger_gearbox]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = gearbox

			




	
	
	
		
 

			




	
	
	
		
 
[logger_sqlalchemy]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers = console_sql

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = sqlalchemy.engine

			




	
	
	
		
 
propagate = 0

			




	
	
	
		
 
# For coloring based on log level and pretty printing of SQL:

			




	
	
	
		
 
# level = INFO

			




	
	
	
		
 
# handlers = console_color_sql

			




	
	
	
		
 
# propagate = 0

			




	
	
	
		
 

			




	
	
	
		
 
[logger_whoosh_indexer]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = whoosh_indexer

			




	
	
	
		
 

			




	
	
	
		
 
[logger_werkzeug]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = werkzeug

			




	
	
	
		
 

			




	
	
	
		
 
[logger_backlash]

			




	
	
	
		
 
level = WARN

			




	
	
	
		
 
handlers =

			




	
	
	
		
 
qualname = backlash

			




	
	
	
		
 

			




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

			




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

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console]

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = generic

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console_sql]

			




	
	
	
		
 
[handler_console_color]

			




	
	
	
		
 
# ANSI color coding based on log level

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = generic

			




	
	
	
		
 
formatter = color_formatter

			




	
	
	
		
 

			




	
	
	
		
 
[handler_console_color_sql]

			




	
	
	
		
 
# ANSI color coding and pretty printing of SQL statements

			




	
	
	
		
 
class = StreamHandler

			




	
	
	
		
 
args = (sys.stderr,)

			




	
	
	
		
 
formatter = color_formatter_sql

			




	
	
	
		
 

			




	
	
	
		
 
[handler_null]

			




	
	
	
		
 
class = NullHandler

			




	
	
	
		
 
args = ()

			




	
	
	
		
 

			




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

			




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

			




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

			




	
	
	
		
 

			




	
	
	
		
 
[formatter_generic]

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




	
	
	
		
 

			




	
	
	
		
 
[formatter_color_formatter]

			




	
	
	
		
 
class = kallithea.lib.colored_formatter.ColorFormatter

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




	
	
	
		
 

			




	
	
	
		
 
[formatter_color_formatter_sql]

			




	
	
	
		
 
class = kallithea.lib.colored_formatter.ColorFormatterSql

			




	
	
	
		
 
format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s

			




	
	
	
		
 
datefmt = %Y-%m-%d %H:%M:%S

			




        

    


    
    

    

        

                

                    scripts/generate-ini.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
	
		
 
#!/usr/bin/env python2

			




	
	
	
		
 
"""

			




	
	
	
		
 
Based on kallithea/lib/paster_commands/template.ini.mako, generate development.ini

			




	
	
	
		
 
"""

			




	
	
	
		
 

			




	
	
	
		
 
import re

			




	
	
	
		
 

			




	
	
	
		
 
from kallithea.lib import inifile

			




	
	
	
		
 

			




	
	
	
		
 
# files to be generated from the mako template

			




	
	
	
		
 
ini_files = [

			




	
	
	
		
 
    ('development.ini',

			




	
	
	
		
 
        {

			




	
	
	
		
 
            '[server:main]': {

			




	
	
	
		
 
                'host': '0.0.0.0',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[app:main]': {

			




	
	
	
		
 
                'debug': 'true',

			




	
	
	
		
 
                'app_instance_uuid': 'development-not-secret',

			




	
	
	
		
 
                'session.secret': 'development-not-secret',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[handler_console]': {

			




	
	
	
		
 
                'formatter': 'color_formatter',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[handler_console_sql]': {

			




	
	
	
		
 
                'formatter': 'color_formatter_sql',

			




	
	
	
		
 
            '[logger_root]': {

			




	
	
	
		
 
                'handlers': 'console_color',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[logger_routes]': {

			




	
	
	
		
 
                'level': 'DEBUG',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[logger_beaker]': {

			




	
	
	
		
 
                'level': 'DEBUG',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[logger_templates]': {

			




	
	
	
		
 
                'level': 'INFO',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[logger_kallithea]': {

			




	
	
	
		
 
                'level': 'DEBUG',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[logger_tg]': {

			




	
	
	
		
 
                'level': 'DEBUG',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[logger_gearbox]': {

			




	
	
	
		
 
                'level': 'DEBUG',

			




	
	
	
		
 
            },

			




	
	
	
		
 
            '[logger_whoosh_indexer]': {

			




	
	
	
		
 
                'level': 'DEBUG',

			




	
	
	
		
 
            },

			




	
	
	
		
 
        },

			




	
	
	
		
 
    ),

			




	
	
	
		
 
]

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
def main():

			




	
	
	
		
 
    # make sure all mako lines starting with '#' (the '##' comments) are marked up as <text>

			




	
	
	
		
 
    makofile = inifile.template_file

			




	
	
	
		
 
    print 'reading:', makofile

			




	
	
	
		
 
    mako_org = open(makofile).read()

			




	
	
	
		
 
    mako_no_text_markup = re.sub(r'</?%text>', '', mako_org)

			




	
	
	
		
 
    mako_marked_up = re.sub(r'\n(##.*)', r'\n<%text>\1</%text>', mako_no_text_markup, flags=re.MULTILINE)

			




	
	
	
		
 
    if mako_marked_up != mako_org:

			




	
	
	
		
 
        print 'writing:', makofile

			




	
	
	
		
 
        open(makofile, 'w').write(mako_marked_up)

			




	
	
	
		
 

			




	
	
	
		
 
    # create ini files

			




	
	
	
		
 
    for fn, settings in ini_files:

			




	
	
	
		
 
        print 'updating:', fn

			




	
	
	
		
 
        inifile.create(fn, None, settings)

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
if __name__ == '__main__':

			




	
	
	
		
 
    main()

			




        

    



    


    



    



      

      





    
    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.