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

Python Logging Best Practice

Kode Sumber AI

v0.2.11

Unduh

Chromatrace

Chromatrace adalah paket Python yang dirancang untuk kemampuan logging canggih, termasuk jejak dan permintaan manajemen ID bersama dengan ID proses. Ini memberikan konfigurasi logging yang fleksibel dan mendukung logging berwarna untuk visibilitas yang lebih baik.

Saya percaya bahwa penebangan adalah bagian penting dari aplikasi apa pun, dan penting untuk memiliki sistem penebangan yang terorganisir dengan baik dan terstruktur. Chromatrace bertujuan untuk menyediakan sistem penebangan yang sederhana dan mudah digunakan yang dapat diintegrasikan ke dalam aplikasi Python apa pun. Secara sederhana, Chromatrace adalah praktik terbaik penebangan di Python.

Fitur

Pengaturan logging yang dapat dikonfigurasi menggunakan Pydantic.
Level log dan penebang yang dapat disesuaikan untuk berbagai layanan.
Dukungan untuk ID jejak dan permintaan ID.
Dukungan untuk ID Proses.
Format dan penangan log yang dapat disesuaikan.
Penelusuran fungsi asinkron dan sinkron.
Integrasi Uvicorn untuk konfigurasi logging untuk menyesuaikan pengaturan log.
Integrasi FASTAPI untuk Manajemen ID Permintaan.
Integrasi Socketio untuk Manajemen ID Permintaan.
Contoh praktis untuk berbagai kerangka kerja dan kasus penggunaan.

Instalasi

Anda dapat menginstal Chromatrace melalui PIP:

pip install chromatrace

Penggunaan

Untuk menggunakan Chromatrace di aplikasi Anda, Anda dapat mengimpor komponen yang diperlukan:

 from chromatrace import LoggingSettings , LoggingConfig , tracer

Konfigurasikan pengaturan logging Anda:

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

Gunakan dekorator tracer untuk melacak fungsi Anda:

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

Injeksi ketergantungan menggunakan 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 ])

Kemudian, tambahkan LoggingConfig ke layanan Anda:

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

Hasil:

 [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

Dua log pertama adalah di luar jejak dan ID jejak tidak ditambahkan ke pesan log. Sisa log berada dalam jejak dan ID jejak - T-dc1be4de , ditambahkan ke pesan log.

Catatan : Yang penting adalah bahwa setiap kelas atau layanan dapat memiliki level log sendiri. Ini berguna ketika Anda ingin memiliki level log yang berbeda untuk layanan yang berbeda.

Integrasi Fastapi

 from chromatrace import RequestIdMiddleware

app = FastAPI ()
app . add_middleware ( RequestIdMiddleware )

Hasil:

 [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

Seperti yang Anda lihat, ID permintaan - R-ffe0a9a2 secara otomatis ditambahkan ke pesan log dari utas yang menangani permintaan.

Integrasi Socketio

 from chromatrace import SocketRequestIdMiddleware

socket_application = SocketRequestIdMiddleware ( socket_application )

Contoh lengkap dapat ditemukan di file socket_app.py. Saya sarankan Anda untuk memeriksanya sebelum membuat keputusan. Kode sisi klien dapat ditemukan di file socket_client.py.

Hasil:

 [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

Ya, log soket juga berada dalam jejak. ID Trace- S-4e2b7c5e dan S-aaf46528 ditambahkan ke pesan log. Untuk pengalaman yang lebih baik, awalan S ditambahkan ke ID jejak untuk membedakannya dari ID permintaan.

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

Hasil:

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

Log berada dalam ID proses - PID:3710345 ditambahkan ke pesan log. Pesan log juga diwarnai untuk visibilitas yang lebih baik. Pesan log juga ditulis ke file jika enable_file_logging diatur ke True . Untuk informasi lebih lanjut, periksa kelas config.py, kelas UvicornLoggingSettings .

Contoh

Anda tidak mempercayai saya, bukan? Saya mengerti. Anda ingin melihatnya beraksi, kan? Aku membuatmu tertutup. :)

Anda dapat menemukan contoh cara menggunakan chromatrace di direktori contoh. Jalankan contoh menggunakan perintah berikut:

python main.py

Lalu, jalankan:

curl 0.0.0.0:8000

Sekarang, periksa log di terminal.

Juga, server soket akan mulai dan menunggu klien untuk terhubung di http://localhost:8001 . Untuk soket sisi klien jalankan perintah berikut di terminal lain: