Skip to content

Simple utility based on telegram bot for tracking errors on the client/server and deploy

Notifications You must be signed in to change notification settings

Donatelo-app/Rafael

Repository files navigation

view

Rafael


Простая утилита на основе телеграм бота для отслеживания ошибок на клиенте/сервере и деплоя на сервер

Как запустить

  1. Создать .env файл с указанием токена вашего бота и id юзеров, которым будут приходить оповещания об ошибках. Пример:
TELEGRAM_BOT_TOKEN=469407242:AAHsVy...
USERS=0000000; 0000000; 0000000
  1. Установить зависимости: npm i
  2. Запустить процесс: node index.js

Server API

  • POST /issue: Создает новый лог в базе и сразу же оповещает в телеграме
{
    label: "BACKEND",
    type: 'error', // Типы для эмодзи: log, error, warning
    msg: 'Error',
    db: true // Определяет нужно ли хранить ошибку на сервере или нет. По стандарту true
}
  • POST /find: Ищет логи в базе
{
    query: {
      type: "error" // найдет все логи с типом Error
    }
}
  • GET /dump: Отдает полный дамп логов за все время

Кастомизация

Так же вы можете изменить некоторые данные для своего бота в setup.json

{
  // порт на котором работает express
  "port": 8080,
  // количество запросов на /issue в минуту для одного IP
  "notifyPerMinute": 1,
  
  // кастомизировать типы и иконки
  "types": {
    "log": "✉️",
    "error": "❗️",
    "warning": "⚠️",
    "default": "❓"
  },
  
  "noAccessMessage": "Sorry, this bot have private access. Try read https://github.com/Donatelo-app/donatelo-logger",
  "defaultLabel": "Houston, we have an unknown crap!",
  "pingMessage": "I'm alive, don't worry :)",
  "startMessage": "Hello! I'm Donatelo Logger and i can notify you about errors, cool? Cool."
}

About

Simple utility based on telegram bot for tracking errors on the client/server and deploy

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published