comparison doc/installation.txt @ 8487:b09ef85f0da6

feat: add nanoid pkg trace_id gen and decorator for setting processName nanoid is a shorter unique id generator and faster than uuid. I truncate nanoid id's to 12 chars to make it more readable. Also added decorator to allow setting the default processName definition in the logging module. admin.py and wsgi_handler now set processName. configuration.py knows how to overide the processName if set to the default MainProcess. Updated install docs to add nanoid as optional, how to switch to different trace_id output. pydoc generated docs include logcontext module and are referenced from admin.py.
author John Rouillard <rouilj@ieee.org>
date Mon, 08 Dec 2025 00:23:14 -0500
parents 1522e0e15903
children 7142740e6547
comparison
equal deleted inserted replaced
8478:ed4ef394d5d6 8487:b09ef85f0da6
251 before roundup will allow it to make modifications to issues. (Note 251 before roundup will allow it to make modifications to issues. (Note
252 with python 3.13 or newer on some platforms, you may need to install 252 with python 3.13 or newer on some platforms, you may need to install
253 version 2.0 of gpg from test.pypi.org. See the `gpg install 253 version 2.0 of gpg from test.pypi.org. See the `gpg install
254 directions in the upgrading document`_. 254 directions in the upgrading document`_.
255 255
256 256 nanoid
257 If nanoid_ is installed, it is used to generate short unique
258 ids to link all logging to a single request. If not installed,
259 uuid4's from the standard library are used.
260
257 jinja2 261 jinja2
258 To use the jinja2 template (may still be experimental, check out 262 To use the jinja2 template (may still be experimental, check out
259 its TEMPLATE-INFO.txt file) you need 263 its TEMPLATE-INFO.txt file) you need
260 to have the jinja2_ template engine installed. 264 to have the jinja2_ template engine installed.
261 265
2430 .. _markdown2: https://github.com/trentm/python-markdown2 2434 .. _markdown2: https://github.com/trentm/python-markdown2
2431 .. _mistune: https://pypi.org/project/mistune/ 2435 .. _mistune: https://pypi.org/project/mistune/
2432 .. _mod_python: https://github.com/grisha/mod_python 2436 .. _mod_python: https://github.com/grisha/mod_python
2433 .. _mod_wsgi: https://pypi.org/project/mod-wsgi/ 2437 .. _mod_wsgi: https://pypi.org/project/mod-wsgi/
2434 .. _MySQLdb: https://pypi.org/project/mysqlclient/ 2438 .. _MySQLdb: https://pypi.org/project/mysqlclient/
2439 .. _nanoid: https://pypi.org/project/nanoid/
2435 .. _Olson tz database: https://www.iana.org/time-zones 2440 .. _Olson tz database: https://www.iana.org/time-zones
2436 .. _polib: https://polib.readthedocs.io 2441 .. _polib: https://polib.readthedocs.io
2437 .. _Psycopg2: https://www.psycopg.org/ 2442 .. _Psycopg2: https://www.psycopg.org/
2438 .. _pyjwt: https://pypi.org/project/PyJWT/ 2443 .. _pyjwt: https://pypi.org/project/PyJWT/
2439 .. _pyopenssl: https://pypi.org/project/pyOpenSSL/ 2444 .. _pyopenssl: https://pypi.org/project/pyOpenSSL/

Roundup Issue Tracker: http://roundup-tracker.org/