Главная страница>Связанные с программированием>AI Исходный код
Скачать

Хроматр




Chromatrace - это пакет Python, предназначенный для расширенных возможностей для ведения журнала, включая управление идентификаторами трассировки и идентификатора запроса, а также идентификатор процесса. Он обеспечивает гибкую конфигурацию ведения журнала и поддерживает цветные журналы для лучшей видимости.

Я полагаю, что регистрация является неотъемлемой частью любого приложения, и крайне важно иметь хорошо организованную и структурированную систему ведения журнала. Chromatrace стремится предоставить простую и простую в использовании систему ведения журнала, которая может быть интегрирована в любое приложение Python. Проще говоря, Chromatrace является наилучшей практикой ведения ведения питона.

Функции

  • Настраиваемые настройки журнала с использованием Pydantic.
  • Настраиваемые уровни журналов и регистраторы для разных служб.
  • Поддержка идентификаторов трассировки и идентификаторов запроса.
  • Поддержка идентификаторов процесса.
  • Настраиваемые форматы журнала и обработчики.
  • Асинхронная и синхронная трассировка функции.
  • Интеграция UVICORN для конфигурации журнала для настройки настройки журнала.
  • Интеграция FASTAPI для управления идентификаторами запроса.
  • Интеграция Socketio для управления идентификаторами запроса.
  • Практические примеры для различных структур и вариантов использования.

Установка

Вы можете установить Chromatrace через PIP: 

pip install chromatrace

Использование

Чтобы использовать хроматр в вашем приложении, вы можете импортировать необходимые компоненты: 

 from chromatrace import LoggingSettings , LoggingConfig , tracer

Настройте настройки журнала: 

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

Используйте декоратор tracer , чтобы отследить ваши функции: 

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

Инъекция зависимости с использованием лагома 

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

Затем добавьте LoggingConfig в свой сервис: 

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

Результаты: 

 [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

Два первого журнала был вне следа, и идентификатор трассировки не был добавлен в сообщение журнала. Остальные журналы находились в пределах трассировки, а в сообщение журнала было добавлено идентификатор трассировки - T-dc1be4de .

Примечание . Важно то, что каждый класс или сервис может иметь свой собственный уровень журнала. Это полезно, когда вы хотите иметь разные уровни журналов для разных служб.

Интеграция FASTAPI 

 from chromatrace import RequestIdMiddleware

app = FastAPI ()
app . add_middleware ( RequestIdMiddleware )

Результат: 

 [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

Как вы можете видеть, идентификатор запроса - R-ffe0a9a2 автоматически добавляется в сообщения журнала из потока, который обрабатывает запрос.

Интеграция сокета 

 from chromatrace import SocketRequestIdMiddleware

socket_application = SocketRequestIdMiddleware ( socket_application )

Полный пример можно найти в файле socket_app.py. Я рекомендую вам проверить это, прежде чем принимать какое -либо решение. Код на стороне клиента можно найти в файле socket_client.py.

Результат: 

 [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-4e2b7c5e и S-aaf46528 были добавлены в сообщения журнала. Для лучшего опыта префикс S был добавлен в идентификатор трассировки, чтобы отличить его от идентификатора запроса.

Uvicorn Integration 

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

Результат: 

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

Журналы находятся в пределах идентификатора процесса - PID:3710345 был добавлен в сообщения журнала. Сообщения журнала также окрашены для лучшей видимости. Сообщения журнала также записываются в файл, если enable_file_logging установлен на True . Для получения дополнительной информации проверьте файл config.py, класс UvicornLoggingSettings .

Примеры

Ты мне не доверяешь, не так ли? Я понимаю. Вы хотите увидеть это в действии, верно? Я тебя покрыл. :)

Вы можете найти примеры того, как использовать хроматр в каталоге примеров. Запустите примеры, используя следующую команду: 

python main.py

Затем беги: 

curl 0.0.0.0:8000

Теперь проверьте журналы в терминале.

Кроме того, сервер Socket запустит и ждал, пока клиент подключится к http://localhost:8001 . Для сокета клиента запустите следующую команду в другом терминале: 

python adaptors/socket_client.py

Теперь проверьте журналы в оба терминале.

Лицензия

Этот проект лицензирован по общей публичной лицензии GNU Affero - для получения подробной информации см. Файл лицензии.

Идеи и источники

  • Питоны
  • 12 лучших методов ведения журнала питона для быстрее отладки приложений
  • 10 лучших практик для регистрации в Python
Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все