Экспортер котировок для Prometheus

Экспортер котировок финансовых инструментов из TBank (Tinkoff Bank) InvestAPI

Особенности:

• Получение и экспорт для Prometheus котировки финансовых инструментов в реальном времени для заданного набора тикеров
• Использует метки для каждого тикера финансового инструмента
• Использует неблокирующий цикл событий (event loop) "Revolt", веб-сервер и клиент amphp для обеспечения высокой производительности

Область применения:

• Отслеживание цен на финансовые инструменты Московской фондовой биржи (MOEX), Санкт-Петербургской биржи (SPBEX) и вторичных рынках в реальном времени для экспорта данных в Prometheus
• Оповещения в Prometheus для уведомлений о значительных изменениях
• Сравнение производительности различных финансовых инструментов с помощью метрик и графиков в Grafana

Установка

git clone git@github.com:rekryt/tbank-exporter.git .
cp .env.example .env
# configure API_TOKEN in .env
# nano .env

Настройка

API_TOKEN=""
API_TICKERS="GOLD:BBG00V9V16J8|AKGD:BBG014M8NBM4|TGLD:TCS10A101X50|SBGD:BBG019HZM0H0|GAZP:BBG004730RP0|XAU:BBG0013HGFZ7|GLDRUB_TOM:BBG000VJ5YR4|TMOS:BBG333333333"

Параметр	Описание	Значение по умолчанию
API_TOKEN	Токен доступа	ОБЯЗАТЕЛЬНЫЙ ПАРАМЕТР
API_TICKERS	Список финансовых инструментов в формате "TICKER:FIGI" разделённый вертикальной чертой	GOLD:BBG00V9V16J8
API_ACCOUNT	ID аккаунта (если не задано будет взять первый из доступных)
API_URL_REST	Базовый URL REST API	https://invest-public-api.tinkoff.ru
API_URL_WS	Базовый URL WS API	wss://invest-public-api.tinkoff.ru/ws
METRICS_PORTFOLIO	Имя метрики - Портфель	portfolio
METRICS_PRICE	Имя метрики - Стоимость бумаги	price
METRICS_ORDER_COUNTS	Имя метрики - Количество позиций в портфеле	order_counts
METRICS_ORDER_TOTALS	Имя метрики - Стоимость позиций в портфеле	order_totals
METRICS_POSITIONS_COUNT	Имя метрики - Количество позиций в заявках	positions_count
METRICS_POSITIONS_PRICE	Имя метрики - Стоимость позиций в заявках	positions_price
HTTP_HOST	Сетевой интерфейс	0.0.0.0
HTTP_PORT	Порт	8080
HTTP_DOCUMENT_ROOT	Папка со статическим данными для веб-сервера	public
SYS_TIMEZONE	Частовой пояс	Europe/Mosco
SYS_MEMORY_LIMIT	Максимальный объём памяти	4096M
DEBUG	Режим отладки	false
AMP_DEBUG	Режим отладки EventLoop	false

API_TOKEN

• Документация о получении токена.
• • Перейдите в настройки профиля Т-Инвестиции и авторизуйтесь в системе, если это требуется. Функция Подтверждение сделок кодом должна быть отключена.
• • Выпустите токен T-Invest API для биржи и/или песочницы. Рекомендуется оставить права доступа "только чтение".
• • Скопируйте токен и сохраните его в .env файле. Токен отображается только один раз, просмотреть его позже не получится. Вы можете выпускать неограниченное количество токенов.
• • Срок жизни токена — три месяца с даты последнего использования.

API_TICKERS

• Укажите список финансовых инструментов в формате "TICKER:FIGI|TICKER:FIGI|TICKER:FIGI"

Запуск вручную

composer install
php index.php

Запуск через docker compose

docker network create web
docker compose build
docker compose up -d

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

Экспортер запустит веб-сервер на порту 8080 и будет экспортировать метрики по адресу /metrics

Метрики

Имя	Описание	Метки
portfolio	Портфель	label - наименование параметра
price	Стоимость бумаги	ticker – тикер
positions_count	Количество позиций в портфеле	ticker – тикер
positions_price	Стоимость позиций в портфеле	ticker – тикер
order_counts	Количество позиций в заявках	ticker – тикер
order_totals	Стоимость позиций в заявках	ticker – тикер

# HELP price price
# TYPE price gauge
price{ticker="GAZP"} 125.23
price{ticker="XAU"} 2474.34
price{ticker="GOLD"} 1.7645
price{ticker="TGLD"} 8.89
price{ticker="AKGD"} 160.74
price{ticker="GLDRUB_TOM"} 6982.4
price{ticker="SBGD"} 21.105
price{ticker="TMOS"} 6.27
# HELP order_counts order_counts
# TYPE order_counts gauge
order_counts{ticker="GOLD"} 1
# HELP order_totals order_totals
# TYPE order_totals gauge
order_totals{ticker="GOLD"} 1.7645
# HELP portfolio portfolio
# TYPE portfolio gauge
portfolio{label="totalAmountShares"} 1547.2695
portfolio{label="totalAmountBonds"} 0
portfolio{label="totalAmountEtf"} 1.7645
portfolio{label="totalAmountCurrencies"} 9708.12
portfolio{label="expectedYield"} -15513.6
# HELP positions_count positions_count
# TYPE positions_count gauge
positions_count{ticker="GOLD"} 1
positions_count{ticker="RUB000UTSTOM"} 9708.12
# HELP positions_price positions_price
# TYPE positions_price gauge
positions_price{ticker="GOLD"} 1.7645
positions_price{ticker="RUB000UTSTOM"} 1

Настройка prometheus.yaml

# A scrape configuration containing exactly one endpoint to scrape.
scrape_configs:
  - job_name: 'tbank'
    scrape_interval: 5s
    honor_labels: true
    static_configs:
      - targets: ['tbank-exporter-app-1:8080']

где "tbank-exporter-app-1" сетевой адрес сервиса

Настройка grafana

В корне проекта есть пример JSON модели dashboard-а.

Полезные ссылки

• Т-банк
• • Документация по API
• • Получение токена доступа к T-invest API
• • REST API получение данных по инструменту
• • Websocket API получение сообщений - gRPC streaming Т-Инвестиции
• Prometheus
• AMPHP
• • http server
• • http client
• • ws client
• Revolt

License

The MIT License (MIT). Please see LICENSE for more information.