Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Nimond committed May 5, 2022
1 parent 413eff1 commit 6a3c9c7
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# pybotx-smartapp-smart-logger

## Интеграция [pybotx-smart-logger](https://github.com/ExpressApp/pybotx-smart-logger) и [pybotx-smartapp-rpc](https://github.com/ExpressApp/pybotx-smartapp-rpc)

## Установка и использование

1. Устанавливаем библиотеку:
```bash
poetry add pybotx-smartapp-smart-logger
```

2. Подключаем `pybotx-smart-logger` по инструкции из [README](https://github.com/ExpressApp/pybotx-smart-logger/blob/master/README.md)

3. Подключаем `pybotx-smartapp-rpc` по инструкции из [README](https://github.com/ExpressApp/pybotx-smartapp-rpc/blob/master/README.md)

4. Подключаем хендлер исключений к смартапу

```python
from botx_smartapp_smart_logger import smartapp_exception_handler

smartapp = SmartAppRPC(
routers=...,
exception_handlers={Exception: smartapp_exception_handler}
)
```

5. Оборачиваем вызов `handle_smartapp_event` в контекстный менеджер:

```python
from botx_smart_logger import wrap_system_event

@collector.smartapp_event
async def handle_smartapp_event(event: SmartAppEvent, bot: Bot) -> None:
with wrap_system_event(event, settings.DEBUG):
await smartapp.handle_smartapp_event(event, bot)
```

## Гдe применять

Добавлять логи лучше везде, где информация из них поможет при диагностике ошибки. Например, здесь выводятся аргументы перед выполением деления.

```python
from pybotx_smart_logger import smart_log

@rpc.method("divide")
async def divide(
smartapp: SmartApp, rpc_arguments: SumArgs
) -> RPCResultResponse[int]:
smart_log(f"RPC method `divide` called with args: {rpc_arguments}")
return RPCResultResponse(result=rpc_arguments.a / rpc_arguments.b)
```

0 comments on commit 6a3c9c7

Please sign in to comment.