@real-token/realt-gateway-telegram-logger

RealT Gateway Telegram logger

Ce repo a pour objectif de rendre disponible dans tous les micro-services de l'API Gateway aux fonctions ne notification dans Telegram

Fonctionnalités

TelegramService

Envoi de message

Le service permet l'envoi de messages via Telegram avec les fonctionnalités suivantes :

• Envoi de messages texte simples vers un chat ou groupe spécifique Support des messages formatés en HTML ou Markdown
• Possibilité d'envoyer des messages avec des boutons inline
• Gestion des retours d'erreur et des tentatives de renvoi
• Support de l'envoi de fichiers et médias
• Configuration flexible du bot token et chat ID

Formattage de message

Le service offre plusieurs options de formattage :

• Support complet de la syntaxe Markdown pour le style du texte (gras, italique, code, etc.)
• Formatage HTML pour une mise en page plus complexe
• Templates prédéfinis pour les messages courants (alertes, notifications, rapports)
• Possibilité de créer des messages multi-lignes avec préservation du formatage
• Support des emojis et caractères spéciaux
• Échappement automatique des caractères spéciaux

Logger

Log

Utilise le logger standard de NestJS (Logger.log())

Envoie un message Telegram formatté avec un style neutre

Debug

Exploite le logger debug de NestJS (Logger.debug())

Envoie un message Telegram formatté avec des détails techniques

Error

S'appuie sur le logger d'erreur de NestJS (Logger.error())

Envoie un message Telegram formatté en rouge avec les détails de l'erreur

Info

Utilise le logger info de NestJS (Logger.info()) Envoie un message Discord formatté en bleu pour une meilleure visibilité

Installation

Il faut dans un premier temps le cloner :

1. SSH

git clone [e-mail]:real-token/realt-gateway-telegram-logger.git

2. HTTPS

git clone https://github.com/real-token/realt-gateway-telegram-logger.git

Ensuite installer les dépendances nécessaires :

cd realt-gateway-telegram-logger
yarn

Déploiement

Une fois que vous avez apporté les modifications nécessaires, il faut le publish sur le repo NPM de RealT et pour cela il suffit de push le code depuis la branche main.

git add .
git commit -m "feat : lorem ipsum"
git push

Après avoir poussé le code et augmenté la version il suffira de créer une release sur Github pour publier le repo.

Test

Pour tester votre code, il suffit de mettre à jour la dépendence dans le ou les repos concernés. Puis utiliser les différents guards déjà à disposition.

Requirements

• Node v20.*
• Yarn 1.22.*