Page d'accueil>Lié à la programmation>Code Source AI
Télécharger

Chromatrace




Chromatrace est un package Python conçu pour les capacités de journalisation avancées, y compris la gestion des ID de trace et de demande ainsi que l'ID de processus. Il fournit une configuration de journalisation flexible et prend en charge la journalisation colorée pour une meilleure visibilité.

Je crois que l'exploitation forestière est une partie essentielle de toute application, et il est crucial d'avoir un système de journalisation bien organisé et structuré. Chromatrace vise à fournir un système de journalisation simple et facile à utiliser qui peut être intégré dans n'importe quelle application Python. En termes simples, Chromatrace est la meilleure pratique de la journalisation à Python.

Caractéristiques

  • Paramètres de journalisation configurables à l'aide de pydontic.
  • Niveaux de journal personnalisables et journalistes pour différents services.
  • Prise en charge des ID de trace et des ID de demande.
  • Prise en charge des ID de processus.
  • Formats de journal personnalisables et gestionnaires.
  • Traçage des fonctions asynchrones et synchrones.
  • Intégration Uvicorn pour la configuration de la journalisation pour personnaliser les paramètres du journal.
  • Intégration FastAPI pour la gestion de l'identification de la demande.
  • Intégration socketio pour la gestion de l'ID de demande.
  • Exemples pratiques pour différents cadres et cas d'utilisation.

Installation

Vous pouvez installer Chromatrace via PIP: 

pip install chromatrace

Usage

Pour utiliser Chromatrace dans votre application, vous pouvez importer les composants nécessaires: 

 from chromatrace import LoggingSettings , LoggingConfig , tracer

Configurez vos paramètres de journalisation: 

 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__ )

Utilisez le décorateur tracer pour tracer vos fonctions: 

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

Injection de dépendance à l'aide de 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 ])

Ensuite, ajoutez le LoggingConfig à votre service: 

 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" )

Résultats: 

 [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

Les deux premiers journaux étaient hors trace et l'ID de trace n'a pas été ajouté au message de journal. Les autres journaux étaient dans la trace et l'ID de trace - T-dc1be4de , a été ajouté au message du journal.

Remarque : L'important est que chaque classe ou service peut avoir son propre niveau de journal. Ceci est utile lorsque vous souhaitez avoir différents niveaux de journal pour différents services.

Intégration Fastapi 

 from chromatrace import RequestIdMiddleware

app = FastAPI ()
app . add_middleware ( RequestIdMiddleware )

Résultat: 

 [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

Comme vous pouvez le voir, l'ID de demande - R-ffe0a9a2 est automatiquement ajouté aux messages de journal du thread qui gère la demande.

Intégration socketio 

 from chromatrace import SocketRequestIdMiddleware

socket_application = SocketRequestIdMiddleware ( socket_application )

L'exemple complet se trouve dans le fichier socket_app.py. Je vous recommande de le vérifier avant de prendre une décision. Le code côté client peut être trouvé dans le fichier socket_client.py.

Résultat: 

 [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

Oui, les journaux de socket sont également dans la trace. L'ID de trace - S-4e2b7c5e et S-aaf46528 a été ajouté aux messages de journal. Pour une meilleure expérience, le S a été ajouté à l'ID de trace pour le différencier de l'ID de demande.

Intégration en uvicorne 

 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 ,
        )
    ),
)

Résultat: 

 (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]

Les journaux sont dans l'ID de processus - PID:3710345 a été ajouté aux messages de journal. Les messages de journal sont également colorés pour une meilleure visibilité. Les messages de journal sont également écrits dans le fichier si le enable_file_logging est défini sur True . Pour plus d'informations, vérifiez le fichier config.py, classe UvicornLoggingSettings .

Exemples

Tu ne me fais pas confiance, n'est-ce pas? Je comprends. Tu veux le voir en action, non? Je t'ai couvert. :)

Vous pouvez trouver des exemples d'utilisation de Chromatrace dans le répertoire des exemples. Exécutez les exemples en utilisant la commande suivante: 

python main.py

Ensuite, courez: 

curl 0.0.0.0:8000

Maintenant, vérifiez les journaux dans le terminal.

De plus, le serveur de socket commencera et attendra que le client se connecte sur http://localhost:8001 . Pour la prise côté client, exécutez la commande suivante dans un autre terminal: 

python adaptors/socket_client.py

Maintenant, vérifiez les journaux dans les deux terminaux.

Licence

Ce projet est autorisé en vertu de la licence publique générale de GNU Affero - consultez le dossier de licence pour plus de détails.

Idées et sources

  • Python Logging Best Practices Conseils
  • 12 Python Logging Best Practices pour déboguer les applications plus rapidement
  • 10 meilleures pratiques pour enregistrer Python
Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout