Inicio>Relacionado con la programación>Código Fuente de IA
Descargar

Cromatracia




Chromatrace es un paquete de Python diseñado para capacidades avanzadas de registro, incluida la gestión de ID de rastreo e ID de solicitud junto con el ID de proceso. Proporciona una configuración de registro flexible y admite registro de color para una mejor visibilidad.

Creo que el registro es una parte esencial de cualquier aplicación, y es crucial tener un sistema de registro bien organizado y estructurado. Chromatrace tiene como objetivo proporcionar un sistema de registro simple y fácil de usar que pueda integrarse en cualquier aplicación de Python. En términos simples, Chromatrace es una mejor práctica de iniciar sesión en Python.

Características

  • Configuración de registro configurable con Pydantic.
  • Niveles de registro personalizables y registradores para diferentes servicios.
  • Soporte para identificaciones de rastreo e ID de solicitud.
  • Soporte para ID de proceso.
  • Formatos de registro y manejadores personalizables.
  • Rastreo de función asincrónica y sincrónica.
  • Integración UVICORN para la configuración de registro para personalizar la configuración de registro.
  • Integración de Fastapi para la gestión de ID de solicitud.
  • Integración de Socketio para la gestión de ID de solicitud.
  • Ejemplos prácticos para diferentes marcos y casos de uso.

Instalación

Puede instalar Chromatrace a través de PIP: 

pip install chromatrace

Uso

Para usar Chromatrace en su aplicación, puede importar los componentes necesarios: 

 from chromatrace import LoggingSettings , LoggingConfig , tracer

Configure su configuración de registro: 

 logging_config = LoggingConfig (
    settings = LoggingSettings (
        application_level = "Development" ,
        enable_tracing = True ,
        ignore_nan_trace = False ,
        enable_file_logging = True ,
    )
)
logger = logging_config . get_logger ( __name__ )

Use el decorador tracer para rastrear sus funciones: 

 @ tracer
async def my_async_function ():
   logger . debug ( "Check something" )
   logger . info ( "Doing something" )
   logger . warning ( "Doing something" )
   logger . error ( "Something went wrong" )

Inyección de dependencia usando Lagom 

 from lagom import Container

container = Container ()

from chromatrace import LoggingConfig , LoggingSettings

container [ LoggingSettings ] = LoggingSettings (
        application_level = "Development" ,
        enable_tracing = True ,
        ignore_nan_trace = False ,
        enable_file_logging = True ,
    )
container [ LoggingConfig ] = LoggingConfig ( container [ LoggingSettings ])

Luego, agregue LoggingConfig a su servicio: 

 import logging

from chromatrace import LoggingConfig


class SomeService :
    def __init__ ( self , logging_config : LoggingConfig ):
        self . logger = logging_config . get_logger ( self . __class__ . __name__ )
        self . logger . setLevel ( logging . ERROR )
    
    async def do_something ( self ):
        self . logger . debug ( "Check something in second service" )
        self . logger . info ( "Doing something in second service" )
        self . logger . error ( "Something went wrong in second service" )

Resultados: 

 [Development]-(2024-11-21 23:43:26)-[INFO]-[APIService]-FILENAME:api_app.py-FUNC:do_something-THREAD:MainThread-LINE:27 :: 
Doing something in API service

[Development]-(2024-11-21 23:43:26)-[ERROR]-[APIService]-FILENAME:api_app.py-FUNC:do_something-THREAD:MainThread-LINE:28 :: 
Something went wrong in API service

[T-dc1be4de]-[Development]-(2024-11-21 23:43:26)-[INFO]-[Main]-FILENAME:main.py-FUNC:main-THREAD:MainThread-LINE:21 :: 
Starting main

[T-dc1be4de]-[Development]-(2024-11-21 23:43:26)-[ERROR]-[ExampleService]-FILENAME:example_service.py-FUNC:do_something-THREAD:MainThread-LINE:26 :: 
Something went wrong

[T-dc1be4de]-[Development]-(2024-11-21 23:43:26)-[INFO]-[InnerService]-FILENAME:example_service.py-FUNC:do_something-THREAD:MainThread-LINE:13 :: 
Doing something in second service

[T-dc1be4de]-[Development]-(2024-11-21 23:43:26)-[ERROR]-[InnerService]-FILENAME:example_service.py-FUNC:do_something-THREAD:MainThread-LINE:14 :: 
Something went wrong in second service

[T-dc1be4de]-[Development]-(2024-11-21 23:43:26)-[DEBUG]-[AnotherSample]-FILENAME:sample.py-FUNC:do_something-THREAD:MainThread-LINE:12 :: 
Check something

[T-dc1be4de]-[Development]-(2024-11-21 23:43:26)-[INFO]-[AnotherSample]-FILENAME:sample.py-FUNC:do_something-THREAD:MainThread-LINE:13 :: 
Doing something

[T-dc1be4de]-[Development]-(2024-11-21 23:43:26)-[WARNING]-[AnotherSample]-FILENAME:sample.py-FUNC:do_something-THREAD:MainThread-LINE:14 :: 
Doing something

[T-dc1be4de]-[Development]-(2024-11-21 23:43:26)-[ERROR]-[AnotherSample]-FILENAME:sample.py-FUNC:do_something-THREAD:MainThread-LINE:15 :: 
Something went wrong

Los dos primeros registros estaban fuera de traza y el ID de rastreo no se agregó al mensaje de registro. El resto de los registros estaban dentro de la traza y el ID de rastreo - T-dc1be4de , se agregó al mensaje de registro.

Nota : Lo importante es que cada clase o servicio puede tener su propio nivel de registro. Esto es útil cuando desea tener diferentes niveles de registro para diferentes servicios.

Integración de Fastapi 

 from chromatrace import RequestIdMiddleware

app = FastAPI ()
app . add_middleware ( RequestIdMiddleware )

Resultado: 

 [R-ffe0a9a2]-[Development]-(2024-11-22 00:13:53)-[INFO]-[APIService]-FILENAME:api_app.py-FUNC:read_root-THREAD:MainThread-LINE:38 :: 
Hello World

[R-ffe0a9a2]-[Development]-(2024-11-22 00:13:53)-[ERROR]-[ExampleService]-FILENAME:example_service.py-FUNC:do_something-THREAD:MainThread-LINE:26 :: 
Something went wrong

[R-ffe0a9a2]-[Development]-(2024-11-22 00:13:53)-[INFO]-[InnerService]-FILENAME:example_service.py-FUNC:do_something-THREAD:MainThread-LINE:13 :: 
Doing something in second service

[R-ffe0a9a2]-[Development]-(2024-11-22 00:13:53)-[ERROR]-[InnerService]-FILENAME:example_service.py-FUNC:do_something-THREAD:MainThread-LINE:14 :: 
Something went wrong in second service

Como puede ver, la ID de solicitud - R-ffe0a9a2 se agrega automáticamente a los mensajes de registro del hilo que maneja la solicitud.

Integración de Socketio 

 from chromatrace import SocketRequestIdMiddleware

socket_application = SocketRequestIdMiddleware ( socket_application )

El ejemplo completo se puede encontrar en el archivo Socket_app.py. Le recomiendo que lo revise antes de tomar cualquier decisión. El código del lado del cliente se puede encontrar en el archivo Socket_client.py.

Resultado: 

 [S-4e2b7c5e]-[Development]-(2024-12-06 01:15:18)-[INFO]-[Socket]-FILENAME:socket_app.py-FUNC:connect-THREAD:MainThread-LINE:86 :: 
Socket connected on main namespace. SID: wB-srwnv9Xa2w_8bAAAB

[S-4e2b7c5e]-[Development]-(2024-12-06 01:15:20)-[INFO]-[Socket]-FILENAME:socket_app.py-FUNC:message-THREAD:MainThread-LINE:90 :: 
Received message on main namespace. SID: wB-srwnv9Xa2w_8bAAAB, Message: Hello from the client

[S-aaf46528]-[Development]-(2024-12-06 01:15:47)-[INFO]-[Socket]-FILENAME:socket_app.py-FUNC:connect-THREAD:MainThread-LINE:86 :: 
Socket connected on main namespace. SID: FI3E_S_A-KsTi4RLAAAD

[S-aaf46528]-[Development]-(2024-12-06 01:15:49)-[INFO]-[Socket]-FILENAME:socket_app.py-FUNC:message-THREAD:MainThread-LINE:90 :: 
Received message on main namespace. SID: FI3E_S_A-KsTi4RLAAAD, Message: Hello from the client

Sí, los registros de socket también están dentro del rastro. Se añadió a los mensajes de registro S-4e2b7c5e y S-aaf46528 a los mensajes de registro. Para una mejor experiencia, el prefijo S se agregó al ID de rastreo para diferenciarla de la ID de solicitud.

Integración de Uvicorn 

 from chromatrace . uvicorn import GetLoggingConfig , UvicornLoggingSettings

rest_application = FastAPI ()

uvicorn . run (
    rest_application ,
    host = "0.0.0.0" ,
    port = 8000 ,
    log_level = "debug" ,
    log_config = GetLoggingConfig (
        UvicornLoggingSettings (
            enable_file_logging = True ,
            show_process_id = True ,
        )
    ),
)

Resultado: 

 (2024-12-12 20:54:54)-[PID:3710345]-[INFO]: Started server process [3710345]
(2024-12-12 20:54:54)-[PID:3710345]-[INFO]: Waiting for application startup.
(2024-12-12 20:54:54)-[PID:3710345]-[INFO]: Application startup complete.
(2024-12-12 20:54:54)-[PID:3710345]-[INFO]: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
(2024-12-12 20:54:57)-[PID:3710345]-[INFO]: ADDRESS:(127.0.0.1:46166) - REQUEST:"GET /consume HTTP/1.1" - STATUS:200 OK
(2024-12-12 20:55:45)-[PID:3710345]-[INFO]: ADDRESS:(127.0.0.1:54018) - REQUEST:"GET /consume HTTP/1.1" - STATUS:200 OK
(2024-12-12 20:56:51)-[PID:3710345]-[INFO]: ADDRESS:(127.0.0.1:58240) - REQUEST:"GET / HTTP/1.1" - STATUS:200 OK
(2024-12-12 20:56:51)-[PID:3710345]-[INFO]: ADDRESS:(127.0.0.1:58254) - REQUEST:"GET / HTTP/1.1" - STATUS:200 OK
(2024-12-12 20:56:52)-[PID:3710345]-[INFO]: ADDRESS:(127.0.0.1:58260) - REQUEST:"GET / HTTP/1.1" - STATUS:200 OK
(2024-12-12 20:56:52)-[PID:3710345]-[INFO]: ADDRESS:(127.0.0.1:58270) - REQUEST:"GET / HTTP/1.1" - STATUS:200 OK
(2024-12-12 21:16:45)-[PID:3710345]-[INFO]: Shutting down
(2024-12-12 21:16:45)-[PID:3710345]-[INFO]: Waiting for application shutdown.
(2024-12-12 21:16:45)-[PID:3710345]-[INFO]: Application shutdown complete.
(2024-12-12 21:16:45)-[PID:3710345]-[INFO]: Finished server process [3710345]

Los registros están dentro del ID de proceso - PID:3710345 se agregó a los mensajes de registro. Los mensajes de registro también están coloreados para una mejor visibilidad. Los mensajes de registro también se escriben en el archivo si el enable_file_logging se establece en True . Para obtener más información, consulte el archivo config.py, la clase UvicornLoggingSettings .

Ejemplos

No confías en mí, ¿verdad? Entiendo. Quieres verlo en acción, ¿verdad? Te tengo cubierto. :)

Puede encontrar ejemplos de cómo usar la cromatracia en el directorio de ejemplos. Ejecute los ejemplos usando el siguiente comando: 

python main.py

Entonces, corre: 

curl 0.0.0.0:8000

Ahora, verifique los registros en la terminal.

Además, el servidor Socket se iniciará y esperará a que el cliente se conecte en http://localhost:8001 . Para Socket, el lado del cliente ejecuta el siguiente comando en otro terminal: 

python adaptors/socket_client.py

Ahora, verifique los registros en ambos terminales.

Licencia

Este proyecto tiene licencia bajo la Licencia Pública General de GNU Affero; consulte el archivo de licencia para obtener más detalles.

Ideas y fuentes

  • Consejos de mejores prácticas de registro de Python
  • 12 Las mejores prácticas de registro de Python para depurar aplicaciones más rápido
  • 10 mejores prácticas para iniciar sesión en Python
Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo