metricway-sdk 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- metricway_sdk-0.1.0/LICENSE +21 -0
- metricway_sdk-0.1.0/PKG-INFO +150 -0
- metricway_sdk-0.1.0/README.md +115 -0
- metricway_sdk-0.1.0/metricway/__init__.py +20 -0
- metricway_sdk-0.1.0/metricway/client.py +272 -0
- metricway_sdk-0.1.0/metricway/middleware.py +93 -0
- metricway_sdk-0.1.0/metricway/models.py +148 -0
- metricway_sdk-0.1.0/metricway_sdk.egg-info/PKG-INFO +150 -0
- metricway_sdk-0.1.0/metricway_sdk.egg-info/SOURCES.txt +14 -0
- metricway_sdk-0.1.0/metricway_sdk.egg-info/dependency_links.txt +1 -0
- metricway_sdk-0.1.0/metricway_sdk.egg-info/requires.txt +12 -0
- metricway_sdk-0.1.0/metricway_sdk.egg-info/top_level.txt +1 -0
- metricway_sdk-0.1.0/pyproject.toml +57 -0
- metricway_sdk-0.1.0/setup.cfg +4 -0
- metricway_sdk-0.1.0/tests/test_client.py +270 -0
- metricway_sdk-0.1.0/tests/test_middleware.py +114 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Alexander Tunik
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: metricway-sdk
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Async metrics collector SDK for Telegram bots
|
|
5
|
+
Author: Alexander Tunik
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://metricway.tech
|
|
8
|
+
Project-URL: Source, https://github.com/urlifeceo/tgmetricks-sdk
|
|
9
|
+
Project-URL: Issues, https://github.com/urlifeceo/tgmetricks-sdk/issues
|
|
10
|
+
Keywords: telegram,aiogram,analytics,metrics
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Framework :: AsyncIO
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
20
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Requires-Dist: aiohttp<4,>=3.8
|
|
25
|
+
Provides-Extra: aiogram
|
|
26
|
+
Requires-Dist: aiogram<4,>=3.0; extra == "aiogram"
|
|
27
|
+
Provides-Extra: dev
|
|
28
|
+
Requires-Dist: build>=1.2; extra == "dev"
|
|
29
|
+
Requires-Dist: pytest>=8; extra == "dev"
|
|
30
|
+
Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
|
|
31
|
+
Requires-Dist: pytest-cov>=5; extra == "dev"
|
|
32
|
+
Requires-Dist: ruff>=0.6; extra == "dev"
|
|
33
|
+
Requires-Dist: twine>=5; extra == "dev"
|
|
34
|
+
Dynamic: license-file
|
|
35
|
+
|
|
36
|
+
# metricway-sdk
|
|
37
|
+
|
|
38
|
+
Асинхронный SDK для отправки событий Telegram-бота в [metricway](https://metricway.tech). Поддерживает ручную отправку и автоматический сбор из aiogram 3.
|
|
39
|
+
|
|
40
|
+
## Установка и быстрый старт
|
|
41
|
+
|
|
42
|
+
Нужен Python 3.10+. Создайте проект в metricway и сохраните токен в переменной окружения `METRICWAY_PROJECT_TOKEN`. Для aiogram-бота установите пакет:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
python -m pip install "metricway-sdk[aiogram]"
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
import asyncio
|
|
50
|
+
import os
|
|
51
|
+
|
|
52
|
+
from aiogram import Bot, Dispatcher
|
|
53
|
+
from aiogram.filters import CommandStart
|
|
54
|
+
from aiogram.types import Message
|
|
55
|
+
from metricway import MetricsClient, setup_aiogram_metrics
|
|
56
|
+
|
|
57
|
+
metrics = MetricsClient(
|
|
58
|
+
api_url="https://metricway.tech",
|
|
59
|
+
project_token=os.environ["METRICWAY_PROJECT_TOKEN"],
|
|
60
|
+
)
|
|
61
|
+
dp = Dispatcher()
|
|
62
|
+
setup_aiogram_metrics(dp, metrics)
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
@dp.message(CommandStart())
|
|
66
|
+
async def start_command(message: Message) -> None:
|
|
67
|
+
await message.answer("Привет!")
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
async def on_startup(bot: Bot) -> None:
|
|
71
|
+
await metrics.start()
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
async def on_shutdown(bot: Bot) -> None:
|
|
75
|
+
await metrics.close()
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
dp.startup.register(on_startup)
|
|
79
|
+
dp.shutdown.register(on_shutdown)
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
async def main() -> None:
|
|
83
|
+
bot = Bot(token=os.environ["TELEGRAM_BOT_TOKEN"])
|
|
84
|
+
try:
|
|
85
|
+
await dp.start_polling(bot)
|
|
86
|
+
finally:
|
|
87
|
+
await bot.session.close()
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
if __name__ == "__main__":
|
|
91
|
+
asyncio.run(main())
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
`setup_aiogram_metrics` подключают один раз к роутеру. Он учитывает все входящие сообщения и callback-запросы, даже без подходящего обработчика. В таком случае имя обработчика — `unknown`. Для ручной отправки без aiogram установите `metricway-sdk` без дополнения.
|
|
95
|
+
|
|
96
|
+
## Ручная отправка
|
|
97
|
+
|
|
98
|
+
Методы `track_*` синхронные: они добавляют запись в очередь, не ожидая сеть.
|
|
99
|
+
|
|
100
|
+
```python
|
|
101
|
+
metrics.track_event(
|
|
102
|
+
user_id=123,
|
|
103
|
+
chat_id=456,
|
|
104
|
+
handler="trial_started",
|
|
105
|
+
update_type="trial",
|
|
106
|
+
payload={"product_id": "pro_month"},
|
|
107
|
+
)
|
|
108
|
+
metrics.track_traffic(user_id=123, start_payload="campaign_a", utm_source="telegram")
|
|
109
|
+
metrics.track_error(
|
|
110
|
+
user_id=123,
|
|
111
|
+
error_type="PaymentError",
|
|
112
|
+
error_message="Payment failed",
|
|
113
|
+
stack="",
|
|
114
|
+
)
|
|
115
|
+
metrics.track_purchase(
|
|
116
|
+
user_id=123,
|
|
117
|
+
amount=990.0,
|
|
118
|
+
currency="RUB",
|
|
119
|
+
product_id="pro_month",
|
|
120
|
+
payment_provider="telegram_payments",
|
|
121
|
+
)
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Покупку отправляйте только после подтверждённой оплаты. Конвертации валюты нет.
|
|
125
|
+
|
|
126
|
+
## Автоматически собираемые данные
|
|
127
|
+
|
|
128
|
+
| Событие | Передаваемые данные |
|
|
129
|
+
| --- | --- |
|
|
130
|
+
| Сообщение | ID пользователя и чата, имя обработчика, тип обновления, полный текст |
|
|
131
|
+
| Callback | ID пользователя и чата, имя обработчика, тип обновления, callback data |
|
|
132
|
+
| `/start <payload>` | Дополнительная запись трафика со start payload |
|
|
133
|
+
| Ошибка обработчика | Тип, сообщение и полный стек; исключение продолжает распространяться |
|
|
134
|
+
|
|
135
|
+
**Текст, callback data и стек могут содержать личные данные и секреты.** Проверьте правила обработки данных своего бота перед подключением. Не передавайте пароли, платёжные реквизиты и другие секреты в payload или текстах ошибок. Храните токен проекта только на сервере; SDK передаёт его в заголовке `X-Project-Token` и поле записи, но не печатает в своих логах.
|
|
136
|
+
|
|
137
|
+
## Доставка и ограничения
|
|
138
|
+
|
|
139
|
+
Параметры клиента: `batch_size=500`, `flush_interval=3.0`, `max_queue_size=10000`, `max_retries=5`, `shutdown_timeout=10.0`. Батч ограничен 500 записями и 1 МиБ JSON. Ошибки сети, HTTP 429 и 5xx повторяются до пяти раз после первой попытки с возрастающей задержкой; `Retry-After` учитывается до 60 секунд. Остальные 4xx отклоняются сразу. При заполненной очереди новая запись отбрасывается. `close()` пытается отправить остаток до 10 секунд.
|
|
140
|
+
|
|
141
|
+
Очередь находится **только в памяти**. Сбой процесса, исчерпание повторов или лимитов может привести к потере событий. Успешный HTTP-ответ означает принятие батча collector, но не гарантирует его запись в постоянное хранилище. Для предупреждений включите логгер `metricway`. После `close()` новые записи отбрасываются.
|
|
142
|
+
|
|
143
|
+
## Диагностика
|
|
144
|
+
|
|
145
|
+
1. Проверьте токен проекта и вызов `start()` при старте бота.
|
|
146
|
+
2. Проверьте доступность `https://metricway.tech/collector/` с сервера бота.
|
|
147
|
+
3. Посмотрите логи `metricway`: 401 — токен, 429 — ограничение частоты, 413 — размер запроса.
|
|
148
|
+
4. Отправьте `/start test_campaign` и проверьте событие и источник трафика в кабинете.
|
|
149
|
+
|
|
150
|
+
Разработка описана в [CONTRIBUTING.md](CONTRIBUTING.md). Лицензия — MIT.
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# metricway-sdk
|
|
2
|
+
|
|
3
|
+
Асинхронный SDK для отправки событий Telegram-бота в [metricway](https://metricway.tech). Поддерживает ручную отправку и автоматический сбор из aiogram 3.
|
|
4
|
+
|
|
5
|
+
## Установка и быстрый старт
|
|
6
|
+
|
|
7
|
+
Нужен Python 3.10+. Создайте проект в metricway и сохраните токен в переменной окружения `METRICWAY_PROJECT_TOKEN`. Для aiogram-бота установите пакет:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
python -m pip install "metricway-sdk[aiogram]"
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
```python
|
|
14
|
+
import asyncio
|
|
15
|
+
import os
|
|
16
|
+
|
|
17
|
+
from aiogram import Bot, Dispatcher
|
|
18
|
+
from aiogram.filters import CommandStart
|
|
19
|
+
from aiogram.types import Message
|
|
20
|
+
from metricway import MetricsClient, setup_aiogram_metrics
|
|
21
|
+
|
|
22
|
+
metrics = MetricsClient(
|
|
23
|
+
api_url="https://metricway.tech",
|
|
24
|
+
project_token=os.environ["METRICWAY_PROJECT_TOKEN"],
|
|
25
|
+
)
|
|
26
|
+
dp = Dispatcher()
|
|
27
|
+
setup_aiogram_metrics(dp, metrics)
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
@dp.message(CommandStart())
|
|
31
|
+
async def start_command(message: Message) -> None:
|
|
32
|
+
await message.answer("Привет!")
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
async def on_startup(bot: Bot) -> None:
|
|
36
|
+
await metrics.start()
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
async def on_shutdown(bot: Bot) -> None:
|
|
40
|
+
await metrics.close()
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
dp.startup.register(on_startup)
|
|
44
|
+
dp.shutdown.register(on_shutdown)
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
async def main() -> None:
|
|
48
|
+
bot = Bot(token=os.environ["TELEGRAM_BOT_TOKEN"])
|
|
49
|
+
try:
|
|
50
|
+
await dp.start_polling(bot)
|
|
51
|
+
finally:
|
|
52
|
+
await bot.session.close()
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
if __name__ == "__main__":
|
|
56
|
+
asyncio.run(main())
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
`setup_aiogram_metrics` подключают один раз к роутеру. Он учитывает все входящие сообщения и callback-запросы, даже без подходящего обработчика. В таком случае имя обработчика — `unknown`. Для ручной отправки без aiogram установите `metricway-sdk` без дополнения.
|
|
60
|
+
|
|
61
|
+
## Ручная отправка
|
|
62
|
+
|
|
63
|
+
Методы `track_*` синхронные: они добавляют запись в очередь, не ожидая сеть.
|
|
64
|
+
|
|
65
|
+
```python
|
|
66
|
+
metrics.track_event(
|
|
67
|
+
user_id=123,
|
|
68
|
+
chat_id=456,
|
|
69
|
+
handler="trial_started",
|
|
70
|
+
update_type="trial",
|
|
71
|
+
payload={"product_id": "pro_month"},
|
|
72
|
+
)
|
|
73
|
+
metrics.track_traffic(user_id=123, start_payload="campaign_a", utm_source="telegram")
|
|
74
|
+
metrics.track_error(
|
|
75
|
+
user_id=123,
|
|
76
|
+
error_type="PaymentError",
|
|
77
|
+
error_message="Payment failed",
|
|
78
|
+
stack="",
|
|
79
|
+
)
|
|
80
|
+
metrics.track_purchase(
|
|
81
|
+
user_id=123,
|
|
82
|
+
amount=990.0,
|
|
83
|
+
currency="RUB",
|
|
84
|
+
product_id="pro_month",
|
|
85
|
+
payment_provider="telegram_payments",
|
|
86
|
+
)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Покупку отправляйте только после подтверждённой оплаты. Конвертации валюты нет.
|
|
90
|
+
|
|
91
|
+
## Автоматически собираемые данные
|
|
92
|
+
|
|
93
|
+
| Событие | Передаваемые данные |
|
|
94
|
+
| --- | --- |
|
|
95
|
+
| Сообщение | ID пользователя и чата, имя обработчика, тип обновления, полный текст |
|
|
96
|
+
| Callback | ID пользователя и чата, имя обработчика, тип обновления, callback data |
|
|
97
|
+
| `/start <payload>` | Дополнительная запись трафика со start payload |
|
|
98
|
+
| Ошибка обработчика | Тип, сообщение и полный стек; исключение продолжает распространяться |
|
|
99
|
+
|
|
100
|
+
**Текст, callback data и стек могут содержать личные данные и секреты.** Проверьте правила обработки данных своего бота перед подключением. Не передавайте пароли, платёжные реквизиты и другие секреты в payload или текстах ошибок. Храните токен проекта только на сервере; SDK передаёт его в заголовке `X-Project-Token` и поле записи, но не печатает в своих логах.
|
|
101
|
+
|
|
102
|
+
## Доставка и ограничения
|
|
103
|
+
|
|
104
|
+
Параметры клиента: `batch_size=500`, `flush_interval=3.0`, `max_queue_size=10000`, `max_retries=5`, `shutdown_timeout=10.0`. Батч ограничен 500 записями и 1 МиБ JSON. Ошибки сети, HTTP 429 и 5xx повторяются до пяти раз после первой попытки с возрастающей задержкой; `Retry-After` учитывается до 60 секунд. Остальные 4xx отклоняются сразу. При заполненной очереди новая запись отбрасывается. `close()` пытается отправить остаток до 10 секунд.
|
|
105
|
+
|
|
106
|
+
Очередь находится **только в памяти**. Сбой процесса, исчерпание повторов или лимитов может привести к потере событий. Успешный HTTP-ответ означает принятие батча collector, но не гарантирует его запись в постоянное хранилище. Для предупреждений включите логгер `metricway`. После `close()` новые записи отбрасываются.
|
|
107
|
+
|
|
108
|
+
## Диагностика
|
|
109
|
+
|
|
110
|
+
1. Проверьте токен проекта и вызов `start()` при старте бота.
|
|
111
|
+
2. Проверьте доступность `https://metricway.tech/collector/` с сервера бота.
|
|
112
|
+
3. Посмотрите логи `metricway`: 401 — токен, 429 — ограничение частоты, 413 — размер запроса.
|
|
113
|
+
4. Отправьте `/start test_campaign` и проверьте событие и источник трафика в кабинете.
|
|
114
|
+
|
|
115
|
+
Разработка описана в [CONTRIBUTING.md](CONTRIBUTING.md). Лицензия — MIT.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
from metricway.client import MetricsClient
|
|
2
|
+
|
|
3
|
+
__all__ = ["MetricsClient", "AiogramMetricsMiddleware", "setup_aiogram_metrics"]
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def __getattr__(name: str):
|
|
7
|
+
if name in {"AiogramMetricsMiddleware", "setup_aiogram_metrics"}:
|
|
8
|
+
try:
|
|
9
|
+
from metricway.middleware import AiogramMetricsMiddleware, setup_aiogram_metrics
|
|
10
|
+
except ModuleNotFoundError as exc:
|
|
11
|
+
if exc.name == "aiogram":
|
|
12
|
+
raise ModuleNotFoundError(
|
|
13
|
+
"aiogram integration requires: pip install 'metricway-sdk[aiogram]'"
|
|
14
|
+
) from exc
|
|
15
|
+
raise
|
|
16
|
+
return {
|
|
17
|
+
"AiogramMetricsMiddleware": AiogramMetricsMiddleware,
|
|
18
|
+
"setup_aiogram_metrics": setup_aiogram_metrics,
|
|
19
|
+
}[name]
|
|
20
|
+
raise AttributeError(f"module 'metricway' has no attribute {name!r}")
|
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
"""Asynchronous, best-effort metrics delivery."""
|
|
2
|
+
|
|
3
|
+
import asyncio
|
|
4
|
+
import json
|
|
5
|
+
import logging
|
|
6
|
+
import math
|
|
7
|
+
from collections import defaultdict
|
|
8
|
+
from datetime import datetime, timezone
|
|
9
|
+
from email.utils import parsedate_to_datetime
|
|
10
|
+
from typing import Any
|
|
11
|
+
|
|
12
|
+
import aiohttp
|
|
13
|
+
|
|
14
|
+
from metricway.models import ErrorDTO, EventDTO, PurchaseDTO, TrafficDTO
|
|
15
|
+
|
|
16
|
+
logger = logging.getLogger("metricway")
|
|
17
|
+
MAX_BATCH_SIZE = 500
|
|
18
|
+
MAX_REQUEST_BYTES = 1024 * 1024
|
|
19
|
+
TABLES = ("events", "traffic", "errors", "purchases")
|
|
20
|
+
Record = tuple[str, dict[str, Any]]
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
class MetricsClient:
|
|
24
|
+
"""Queue metrics in memory and send them without blocking bot handlers."""
|
|
25
|
+
|
|
26
|
+
def __init__(
|
|
27
|
+
self,
|
|
28
|
+
api_url: str,
|
|
29
|
+
project_token: str,
|
|
30
|
+
batch_size: int = MAX_BATCH_SIZE,
|
|
31
|
+
flush_interval: float = 3.0,
|
|
32
|
+
max_queue_size: int = 10_000,
|
|
33
|
+
max_retries: int = 5,
|
|
34
|
+
shutdown_timeout: float = 10.0,
|
|
35
|
+
) -> None:
|
|
36
|
+
if not api_url or not api_url.startswith(("https://", "http://")):
|
|
37
|
+
raise ValueError("api_url must be an HTTP(S) URL")
|
|
38
|
+
if not project_token:
|
|
39
|
+
raise ValueError("project_token must not be empty")
|
|
40
|
+
if not 1 <= batch_size <= MAX_BATCH_SIZE:
|
|
41
|
+
raise ValueError("batch_size must be between 1 and 500")
|
|
42
|
+
if flush_interval <= 0 or max_queue_size <= 0 or max_retries < 0:
|
|
43
|
+
raise ValueError(
|
|
44
|
+
"flush_interval and max_queue_size must be positive; max_retries cannot be negative"
|
|
45
|
+
)
|
|
46
|
+
if shutdown_timeout <= 0:
|
|
47
|
+
raise ValueError("shutdown_timeout must be positive")
|
|
48
|
+
|
|
49
|
+
self.url = api_url.rstrip("/")
|
|
50
|
+
self.project_token = project_token
|
|
51
|
+
self.batch_size = batch_size
|
|
52
|
+
self.flush_interval = flush_interval
|
|
53
|
+
self.max_retries = max_retries
|
|
54
|
+
self.shutdown_timeout = shutdown_timeout
|
|
55
|
+
self._queue: asyncio.Queue[Record] = asyncio.Queue(maxsize=max_queue_size)
|
|
56
|
+
self._wake = asyncio.Event()
|
|
57
|
+
self._worker_task: asyncio.Task[None] | None = None
|
|
58
|
+
self._session: aiohttp.ClientSession | None = None
|
|
59
|
+
self._inflight_count = 0
|
|
60
|
+
self._closed = False
|
|
61
|
+
self._close_lock = asyncio.Lock()
|
|
62
|
+
|
|
63
|
+
async def start(self) -> None:
|
|
64
|
+
"""Start the worker. Repeated calls are safe."""
|
|
65
|
+
if self._closed:
|
|
66
|
+
raise RuntimeError("MetricsClient cannot be restarted after close()")
|
|
67
|
+
if self._worker_task is not None:
|
|
68
|
+
return
|
|
69
|
+
self._session = aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=5))
|
|
70
|
+
self._worker_task = asyncio.create_task(self._flusher_loop())
|
|
71
|
+
logger.info("MetricsClient started")
|
|
72
|
+
|
|
73
|
+
async def close(self) -> None:
|
|
74
|
+
"""Drain pending records for at most shutdown_timeout seconds."""
|
|
75
|
+
async with self._close_lock:
|
|
76
|
+
if self._closed:
|
|
77
|
+
return
|
|
78
|
+
self._closed = True
|
|
79
|
+
if self._worker_task is None:
|
|
80
|
+
remaining = self._queue.qsize()
|
|
81
|
+
if remaining:
|
|
82
|
+
logger.warning("Discarding %d metrics: client was never started", remaining)
|
|
83
|
+
return
|
|
84
|
+
|
|
85
|
+
self._wake.set()
|
|
86
|
+
try:
|
|
87
|
+
await asyncio.wait_for(self._queue.join(), timeout=self.shutdown_timeout)
|
|
88
|
+
except asyncio.TimeoutError:
|
|
89
|
+
logger.warning(
|
|
90
|
+
"MetricsClient shutdown timed out; %d metrics were not sent",
|
|
91
|
+
self._queue.qsize() + self._inflight_count,
|
|
92
|
+
)
|
|
93
|
+
finally:
|
|
94
|
+
self._worker_task.cancel()
|
|
95
|
+
try:
|
|
96
|
+
await self._worker_task
|
|
97
|
+
except asyncio.CancelledError:
|
|
98
|
+
pass
|
|
99
|
+
if self._session is not None:
|
|
100
|
+
await self._session.close()
|
|
101
|
+
logger.info("MetricsClient closed")
|
|
102
|
+
|
|
103
|
+
def track_event(
|
|
104
|
+
self, user_id: int, chat_id: int, handler: str, update_type: str, payload: dict[str, Any]
|
|
105
|
+
) -> None:
|
|
106
|
+
try:
|
|
107
|
+
dto = EventDTO.create(
|
|
108
|
+
self.project_token, user_id, chat_id, handler, update_type, payload
|
|
109
|
+
)
|
|
110
|
+
except (TypeError, ValueError):
|
|
111
|
+
logger.warning("Discarding events metric: payload is not JSON serializable")
|
|
112
|
+
return
|
|
113
|
+
self._enqueue("events", dto.to_dict())
|
|
114
|
+
|
|
115
|
+
def track_traffic(
|
|
116
|
+
self,
|
|
117
|
+
user_id: int,
|
|
118
|
+
start_payload: str = "",
|
|
119
|
+
utm_source: str = "",
|
|
120
|
+
utm_campaign: str = "",
|
|
121
|
+
referrer: str = "",
|
|
122
|
+
) -> None:
|
|
123
|
+
dto = TrafficDTO.create(
|
|
124
|
+
self.project_token, user_id, start_payload, utm_source, utm_campaign, referrer
|
|
125
|
+
)
|
|
126
|
+
self._enqueue("traffic", dto.to_dict())
|
|
127
|
+
|
|
128
|
+
def track_error(
|
|
129
|
+
self, user_id: int, error_type: str, error_message: str, stack: str = ""
|
|
130
|
+
) -> None:
|
|
131
|
+
dto = ErrorDTO.create(self.project_token, user_id, error_type, error_message, stack)
|
|
132
|
+
self._enqueue("errors", dto.to_dict())
|
|
133
|
+
|
|
134
|
+
def track_purchase(
|
|
135
|
+
self,
|
|
136
|
+
user_id: int,
|
|
137
|
+
amount: float,
|
|
138
|
+
currency: str = "RUB",
|
|
139
|
+
product_id: str = "",
|
|
140
|
+
payment_provider: str = "",
|
|
141
|
+
) -> None:
|
|
142
|
+
dto = PurchaseDTO.create(
|
|
143
|
+
self.project_token, user_id, amount, currency, product_id, payment_provider
|
|
144
|
+
)
|
|
145
|
+
self._enqueue("purchases", dto.to_dict())
|
|
146
|
+
|
|
147
|
+
def _enqueue(self, table: str, item: dict[str, Any]) -> None:
|
|
148
|
+
if self._closed:
|
|
149
|
+
logger.warning("Discarding %s metric: client is closed", table)
|
|
150
|
+
return
|
|
151
|
+
try:
|
|
152
|
+
body = self._encode([item])
|
|
153
|
+
except (TypeError, ValueError):
|
|
154
|
+
logger.warning("Discarding %s metric: record is not JSON serializable", table)
|
|
155
|
+
return
|
|
156
|
+
if len(body) > MAX_REQUEST_BYTES:
|
|
157
|
+
logger.warning("Discarding %s metric: record exceeds collector request limit", table)
|
|
158
|
+
return
|
|
159
|
+
try:
|
|
160
|
+
self._queue.put_nowait((table, item))
|
|
161
|
+
except asyncio.QueueFull:
|
|
162
|
+
logger.warning("Discarding %s metric: queue is full", table)
|
|
163
|
+
return
|
|
164
|
+
if self._queue.qsize() >= self.batch_size:
|
|
165
|
+
self._wake.set()
|
|
166
|
+
|
|
167
|
+
async def _flusher_loop(self) -> None:
|
|
168
|
+
while True:
|
|
169
|
+
try:
|
|
170
|
+
if not self._closed:
|
|
171
|
+
try:
|
|
172
|
+
await asyncio.wait_for(self._wake.wait(), timeout=self.flush_interval)
|
|
173
|
+
except asyncio.TimeoutError:
|
|
174
|
+
pass
|
|
175
|
+
self._wake.clear()
|
|
176
|
+
while not self._queue.empty():
|
|
177
|
+
await self._flush()
|
|
178
|
+
if self._closed:
|
|
179
|
+
return
|
|
180
|
+
except asyncio.CancelledError:
|
|
181
|
+
raise
|
|
182
|
+
except Exception:
|
|
183
|
+
logger.exception("Unexpected error in metrics flusher")
|
|
184
|
+
await asyncio.sleep(1)
|
|
185
|
+
|
|
186
|
+
async def _flush(self) -> None:
|
|
187
|
+
grouped: dict[str, list[dict[str, Any]]] = defaultdict(list)
|
|
188
|
+
count = 0
|
|
189
|
+
while count < self.batch_size:
|
|
190
|
+
try:
|
|
191
|
+
table, item = self._queue.get_nowait()
|
|
192
|
+
except asyncio.QueueEmpty:
|
|
193
|
+
break
|
|
194
|
+
grouped[table].append(item)
|
|
195
|
+
self._inflight_count += 1
|
|
196
|
+
count += 1
|
|
197
|
+
|
|
198
|
+
for table in TABLES:
|
|
199
|
+
chunk: list[dict[str, Any]] = []
|
|
200
|
+
for item in grouped[table]:
|
|
201
|
+
if chunk and len(self._encode([*chunk, item])) > MAX_REQUEST_BYTES:
|
|
202
|
+
await self._finish_batch(table, chunk)
|
|
203
|
+
chunk = []
|
|
204
|
+
chunk.append(item)
|
|
205
|
+
if chunk:
|
|
206
|
+
await self._finish_batch(table, chunk)
|
|
207
|
+
|
|
208
|
+
async def _finish_batch(self, table: str, items: list[dict[str, Any]]) -> None:
|
|
209
|
+
try:
|
|
210
|
+
await self._send_batch(table, items)
|
|
211
|
+
finally:
|
|
212
|
+
for _ in items:
|
|
213
|
+
self._queue.task_done()
|
|
214
|
+
self._inflight_count -= len(items)
|
|
215
|
+
|
|
216
|
+
async def _send_batch(self, table: str, items: list[dict[str, Any]]) -> None:
|
|
217
|
+
assert self._session is not None
|
|
218
|
+
endpoint = f"{self.url}/collector/track/{table}"
|
|
219
|
+
body = self._encode(items)
|
|
220
|
+
headers = {"Content-Type": "application/json", "X-Project-Token": self.project_token}
|
|
221
|
+
for attempt in range(self.max_retries + 1):
|
|
222
|
+
retry_after = 0.0
|
|
223
|
+
try:
|
|
224
|
+
async with self._session.post(endpoint, data=body, headers=headers) as response:
|
|
225
|
+
if 200 <= response.status < 300:
|
|
226
|
+
return
|
|
227
|
+
if response.status == 429 or response.status >= 500:
|
|
228
|
+
retry_after = self._retry_after(response.headers.get("Retry-After"))
|
|
229
|
+
else:
|
|
230
|
+
logger.error(
|
|
231
|
+
"Discarding %d %s metrics: collector returned HTTP %d",
|
|
232
|
+
len(items),
|
|
233
|
+
table,
|
|
234
|
+
response.status,
|
|
235
|
+
)
|
|
236
|
+
return
|
|
237
|
+
status = f"HTTP {response.status}"
|
|
238
|
+
except (aiohttp.ClientError, asyncio.TimeoutError, OSError) as exc:
|
|
239
|
+
status = type(exc).__name__
|
|
240
|
+
|
|
241
|
+
if attempt == self.max_retries:
|
|
242
|
+
logger.error(
|
|
243
|
+
"Discarding %d %s metrics after %d attempts (%s)",
|
|
244
|
+
len(items),
|
|
245
|
+
table,
|
|
246
|
+
attempt + 1,
|
|
247
|
+
status,
|
|
248
|
+
)
|
|
249
|
+
return
|
|
250
|
+
await asyncio.sleep(max(min(2**attempt, 60), retry_after))
|
|
251
|
+
|
|
252
|
+
@staticmethod
|
|
253
|
+
def _encode(items: list[dict[str, Any]]) -> bytes:
|
|
254
|
+
return json.dumps(items, separators=(",", ":"), ensure_ascii=False, allow_nan=False).encode(
|
|
255
|
+
"utf-8"
|
|
256
|
+
)
|
|
257
|
+
|
|
258
|
+
@staticmethod
|
|
259
|
+
def _retry_after(value: str | None) -> float:
|
|
260
|
+
if not value:
|
|
261
|
+
return 0.0
|
|
262
|
+
try:
|
|
263
|
+
seconds = float(value)
|
|
264
|
+
except ValueError:
|
|
265
|
+
try:
|
|
266
|
+
date = parsedate_to_datetime(value)
|
|
267
|
+
seconds = (date - datetime.now(timezone.utc)).total_seconds()
|
|
268
|
+
except (TypeError, ValueError, OverflowError):
|
|
269
|
+
return 0.0
|
|
270
|
+
if not math.isfinite(seconds):
|
|
271
|
+
return 0.0
|
|
272
|
+
return min(max(seconds, 0.0), 60.0)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
"""Optional aiogram 3 integration."""
|
|
2
|
+
|
|
3
|
+
import traceback
|
|
4
|
+
from collections.abc import Awaitable, Callable
|
|
5
|
+
from dataclasses import dataclass
|
|
6
|
+
from typing import Any
|
|
7
|
+
|
|
8
|
+
from aiogram import BaseMiddleware, Router
|
|
9
|
+
from aiogram.types import CallbackQuery, Message, TelegramObject
|
|
10
|
+
|
|
11
|
+
from metricway.client import MetricsClient
|
|
12
|
+
|
|
13
|
+
Handler = Callable[[TelegramObject, dict[str, Any]], Awaitable[Any]]
|
|
14
|
+
_CONTEXT_KEY = "_metricway_context"
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
@dataclass
|
|
18
|
+
class _EventContext:
|
|
19
|
+
handler: str = "unknown"
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
class AiogramMetricsMiddleware(BaseMiddleware):
|
|
23
|
+
"""Outer middleware for message and callback observers."""
|
|
24
|
+
|
|
25
|
+
def __init__(self, metrics_client: MetricsClient) -> None:
|
|
26
|
+
super().__init__()
|
|
27
|
+
self.client = metrics_client
|
|
28
|
+
|
|
29
|
+
async def __call__(self, handler: Handler, event: TelegramObject, data: dict[str, Any]) -> Any:
|
|
30
|
+
user_id = 0
|
|
31
|
+
chat_id = 0
|
|
32
|
+
update_type = "unknown"
|
|
33
|
+
payload: dict[str, Any] = {}
|
|
34
|
+
|
|
35
|
+
if isinstance(event, Message):
|
|
36
|
+
update_type = "message"
|
|
37
|
+
user_id = event.from_user.id if event.from_user else 0
|
|
38
|
+
chat_id = event.chat.id
|
|
39
|
+
payload["text"] = event.text or ""
|
|
40
|
+
parts = (event.text or "").split(maxsplit=1)
|
|
41
|
+
if parts and parts[0].split("@", 1)[0] == "/start" and len(parts) > 1:
|
|
42
|
+
payload["start_payload"] = parts[1]
|
|
43
|
+
if user_id:
|
|
44
|
+
self.client.track_traffic(user_id=user_id, start_payload=parts[1])
|
|
45
|
+
elif isinstance(event, CallbackQuery):
|
|
46
|
+
update_type = "callback_query"
|
|
47
|
+
user_id = event.from_user.id
|
|
48
|
+
chat_id = event.message.chat.id if event.message else 0
|
|
49
|
+
payload["callback_data"] = event.data or ""
|
|
50
|
+
|
|
51
|
+
context = _EventContext()
|
|
52
|
+
data[_CONTEXT_KEY] = context
|
|
53
|
+
try:
|
|
54
|
+
return await handler(event, data)
|
|
55
|
+
except Exception as exc:
|
|
56
|
+
if user_id:
|
|
57
|
+
self.client.track_error(
|
|
58
|
+
user_id=user_id,
|
|
59
|
+
error_type=type(exc).__name__,
|
|
60
|
+
error_message=str(exc),
|
|
61
|
+
stack=traceback.format_exc(),
|
|
62
|
+
)
|
|
63
|
+
raise
|
|
64
|
+
finally:
|
|
65
|
+
if user_id:
|
|
66
|
+
self.client.track_event(
|
|
67
|
+
user_id=user_id,
|
|
68
|
+
chat_id=chat_id,
|
|
69
|
+
handler=context.handler,
|
|
70
|
+
update_type=update_type,
|
|
71
|
+
payload=payload,
|
|
72
|
+
)
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
class _HandlerNameMiddleware(BaseMiddleware):
|
|
76
|
+
"""Inner middleware sees the handler resolved by aiogram's filters."""
|
|
77
|
+
|
|
78
|
+
async def __call__(self, handler: Handler, event: TelegramObject, data: dict[str, Any]) -> Any:
|
|
79
|
+
context = data.get(_CONTEXT_KEY)
|
|
80
|
+
handler_obj = data.get("handler")
|
|
81
|
+
if context is not None and handler_obj is not None:
|
|
82
|
+
callback = getattr(handler_obj, "callback", None)
|
|
83
|
+
if callback is not None:
|
|
84
|
+
context.handler = getattr(callback, "__name__", "unknown")
|
|
85
|
+
return await handler(event, data)
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
def setup_aiogram_metrics(router: Router, client: MetricsClient) -> None:
|
|
89
|
+
"""Register metrics for all messages and callbacks on a router."""
|
|
90
|
+
router.message.outer_middleware(AiogramMetricsMiddleware(client))
|
|
91
|
+
router.callback_query.outer_middleware(AiogramMetricsMiddleware(client))
|
|
92
|
+
router.message.middleware(_HandlerNameMiddleware())
|
|
93
|
+
router.callback_query.middleware(_HandlerNameMiddleware())
|