Python

Установка

Установите пакет hawk-python-sdk из PyPI.

pip install hawk-python-sdk

Подключение

Импортируйте модуль в проект:

from hawk_python_sdk import Hawk

Затем инициализируйте Hawk Catcher, передав интеграционный токен:

hawk = Hawk( "ВАШ_ТОКЕН" )

После этого все глобальные ошибки будут автоматически отправляться в Hawk.

Обработка ошибок в `try/except`

Если вы хотите отправлять ошибки из блока try/except, вызовите hawk.send() внутри except:

try: ... except: hawk.send()

Ручная отправка ошибок

В hawk.send() можно передать конкретное исключение:

try: ... except: hawk.send(ValueError("error description"))

Контекст события

Для отладки можно передать дополнительный контекст:

try: ... except: hawk.send(ValueError("error description"), {"params": "value"})

Данные пользователя

Также можно передать пользователя, которого затронула ошибка:

try: ... except: hawk.send(ValueError("error description"), {"params": "value"}, {"id": 123})

Параметры инициализации

Для базовой инициализации достаточно передать интеграционный токен проекта:

hawk = Hawk('ВАШ_ТОКЕН')

Дополнительные параметры

Если нужно использовать кастомный Хоук-сервер, передайте словарь с параметрами:

hawk = Hawk({ 'token': 'ВАШ_ТОКЕН', 'collector_endpoint': 'https://<id>.k1.hawk.so', })

Доступные параметры

Параметр	Тип	Обязательный	Описание
`token`	`str`	да	Интеграционный токен проекта
`release`	`str`	нет	Название релиза для функции Suspected Commits
`collector_endpoint`	`string`	нет	Адрес коллектора для отправки событий
`context`	`dict`	нет	Дополнительный контекст, который будет отправляться с каждым событием
`before_send`	`Callable[[dict], None]`	нет	Позволяет отфильтровать данные перед отправкой в Хоук

Требования

Python >= 3.10
requests

Ссылки