Описание

Функциональность позволяет видеть количество неотправленных документов с касс, чтобы своевременно решать вопросы, связанные с их недоставкой на сервер.

На стороне кассы необходимо реализовать сервис, который в специальном формате (Prometheus) отдаёт информацию о неотправленных документах.

Производится мониторинг следующих документов:

чеки;
внесения;
изъятия;
Z-отчеты.

Для каждого из перечисленных документов сохраняется информация о:

количестве документов в очереди;
количестве неотправленных документов.

Документ считается неотправленным по следующему критерию:

Дата создания документа +5 минут в статусе Не отправлен = документ считается неотправленным

Также считается количество успешных и ошибочных попыток отправки чеков, внесений и изъятий (counter). Счетчики с информацией обнуляются при перезапуске кассы.

Включение функциональности

1. Выполните скрипт в базе данных set на сервере SetRetail/SetCentrum → перезагрузите кассовый модуль.

SELECT add_property('CASH_METRICS', 'enabled', 'true', 'Включение метрик Prometheus', 10, 2, 0);

Для выдачи метрик по http-протоколу по умолчанию используется порт 8083.

2. Выполните скрипт в базе данных set на сервере SetRetail/SetCentrum.

В примере где 1234 укажите нужный порт.

SELECT add_property('CASH_METRICS', 'port', '1234', 'Порт для метрик Prometheus', 10, 2, 0);

Просмотр метрик

Просмотр метрик в текстовом формате доступен по адресу: http://<ip кассы>:<port>/metrics

Расшифровка метрик отчета

Документ считается неотправленным, если с момента его проведения (datecommit) прошло больше 5 минут, и он находится в статусе, отличном от SENT.

Документы в очереди - те, которые находятся в статусе NO_SENT.

Чеки

purchases_in_queue - число чеков в очереди на отправку.
not_sent_purchases - число неотправленных чеков.
purchases_success_sending_attempts_total - количество успешных попыток отправки чеков.
purchases_failed_sending_attempts_total - количество неуспешных попыток отправки чеков.

Изъятия

withdrawals_in_queue - число изъятий в очереди на отправку.
not_sent_withdrawals - число неотправленных изъятий.
withdrawals_success_sending_attempts_total - количество успешных попыток отправки изъятий.
withdrawals_failed_sending_attempts_total- количество неуспешных попыток отправки изъятий.

Внесения

introductions_in_queue - число внесений в очереди на отправку.
not_sent_introductions - число неотправленных внесений.
introductions_success_sending_attempts_total - количество успешных попыток отправки внесений.
introductions_failed_sending_attempts_total - количество неуспешных попыток отправки внесений.

Z-отчеты

report_shift_in_queue - число Z-отчетов в очереди на отправку.
not_sent_report_shift - число неотправленных Z-отчетов.
report_shift_success_sending_attempts_total - количество успешных попыток отправки Z-отчетов.
report_shift_failed_sending_attempts_total- количество неуспешных попыток отправки Z-отчетов.

Портал поддержки продуктов CSI

Отчет по счетчикам успешных и ошибочных попыток отправки чеков, внесений, изъятий