Python Logging Best Practice Download - Python Logging Best Practice Source Code Download

Python Logging Best Practice

Código-Fonte de IA

v0.2.11

Baixar

Cromatrace

O Chromatrace é um pacote Python projetado para recursos avançados de registro, incluindo gerenciamento de identificação de rastreamento e solicitação, juntamente com o ID do processo. Ele fornece uma configuração flexível de registro e suporta o log colorido para uma melhor visibilidade.

Acredito que o registro é uma parte essencial de qualquer aplicativo e é crucial ter um sistema de log bem organizado e estruturado. O Chromatrace tem como objetivo fornecer um sistema de log simples e fácil de usar que possa ser integrado a qualquer aplicativo Python. Em termos simples, o Chromatrace é uma prática recomendada para registrar o Python.

Características

Configurações de log configuráveis usando pydantic.
Níveis de log personalizáveis e madeireiros para diferentes serviços.
Suporte para IDs de rastreamento e IDs de solicitação.
Suporte para IDs de processo.
Formatos de log e manipuladores personalizáveis.
Rastreamento de função assíncrona e síncrona.
Integração do Uvicorn para configuração de registro para personalizar as configurações de log.
Integração do FASTAPI para gerenciamento de ID de solicitação.
Integração do Socketio para Gerenciamento de ID de solicitação.
Exemplos práticos para diferentes estruturas e casos de uso.

Instalação

Você pode instalar o Chromatrace via PIP:

pip install chromatrace

Uso

Para usar o Chromatrace em seu aplicativo, você pode importar os componentes necessários:

 from chromatrace import LoggingSettings , LoggingConfig , tracer

Definir suas configurações de log:

 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 o decorador tracer para rastrear suas funções:

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

Injeção de dependência 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 ])

Em seguida, adicione o LoggingConfig ao seu serviço:

 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

O primeiro log estava fora de rastreamento e o ID do rastreio não foi adicionado à mensagem de log. O restante dos troncos estava dentro do rastreamento e o Trace ID - T-dc1be4de foi adicionado à mensagem de log.

Nota : o importante é que cada classe ou serviço pode ter seu próprio nível de log. Isso é útil quando você deseja ter diferentes níveis de log para diferentes serviços.

Integração do 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 você pode ver, o ID da solicitação - R-ffe0a9a2 é adicionado automaticamente às mensagens de log do thread que lida com a solicitação.

Integração do Socketio

 from chromatrace import SocketRequestIdMiddleware

socket_application = SocketRequestIdMiddleware ( socket_application )

O exemplo completo pode ser encontrado no arquivo Socket_App.py. Eu recomendo que você confira antes de tomar qualquer decisão. O código do lado do cliente pode ser encontrado no arquivo 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

Sim, os logs do soquete também estão dentro do rastreamento. O Trace ID- S-4e2b7c5e e S-aaf46528 foi adicionado às mensagens de log. Para melhor experiência, o prefixo S foi adicionado ao ID do rastreio para diferenciá -lo do ID da solicitação.

Integração 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]

Os logs estão dentro do ID do processo - PID:3710345 foi adicionado às mensagens de log. As mensagens de log também são coloridas para uma melhor visibilidade. As mensagens de log também são gravadas no arquivo se o enable_file_logging for definido como True . Para obter mais informações, consulte o arquivo config.py, UvicornLoggingSettings Class.

Exemplos

Você não confia em mim, não é? Eu entendo. Você quer ver isso em ação, certo? Eu tenho você coberto. :)

Você pode encontrar exemplos de como usar o Chromatrace no diretório exemplos. Execute os exemplos usando o seguinte comando:

python main.py

Então, corra:

curl 0.0.0.0:8000

Agora, verifique os logs no terminal.

Além disso, o servidor de soquete começará e aguardará o cliente se conectar no http://localhost:8001 . Para o soquete, o lado do cliente execute o seguinte comando em outro terminal: