diff doc/admin_guide.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 ed4ef394d5d6
children 7142740e6547
line wrap: on
line diff
--- a/doc/admin_guide.txt	Sat Nov 15 16:59:24 2025 -0500
+++ b/doc/admin_guide.txt	Mon Dec 08 00:23:14 2025 -0500
@@ -239,8 +239,8 @@
 ~~~~~~~~~~~~~~~~
 
 The trace_id provides a unique token (a UUID4 encoded to make it
-shorter) for each transaction in the database. It is unique to
-each thread or transaction. A transaction:
+shorter or a nanoid) for each transaction in the database. It is
+unique to each thread or transaction. A transaction:
 
   for the web interface is
       each web, rest or xmlrpc request
@@ -282,7 +282,11 @@
        for thing in things:
 	   process_one(thing)
       
-
+You can change the format of the trace_id if required using the
+tracker's interfaces.py file. See the :ref:`module docs for the
+logcontext module <logcontext_pydoc>` for details.
+
+	   
 Advanced Logging Setup
 ----------------------
 

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