Telegram Error Logger

Monitor server errors in real-time via Telegram. Telegram Bot API.

📦 Install

npm i telegram-error-logger

prerequisites setup 🔴

import {Logger} from 'telegram-error-logger';

// First initialise the logger with your bot token that you create from bot father take a look at #prerequisites
const botToken = 'xxx'
// Initialise the logger with your bot token, this should only be called once
const logger = Logger.initialise<'info' | 'error'>(
  botToken,
  {
    displayConsoleLogs: true,
    displayTelegramLogs: true,
    useColoredLogs: true
  }
)

// Get the instance of your logger
const logger = Logger.getInstance()
// Add the telegram channels to your logger
logger
  .with('info', 'https://t.me/c/2021285143/1')
  .with('error','https://t.me/c/2021285143/6')

//example of when to use the logger 
try{
  await dynamoDB.putItem(params)
}catch(error){
  logger.logMessage('error', `FAILURE: ${error.message}`)
}

🔴 prerequisites

Inorder to send messages (IMPORTANT!)

1. Create a telegram account
2. Search for the bot father

3. Create a new telegram bot by writing the command /newbot in the chat and follow the steps. Copy the token id that was created. (Dont copy mine it wont exist when you read this😇) example bot token: 6879530036:AAFZBnoHOThpwuVn4oT2Vbp3j_n7Gs7gv_g

4. Create a new private telegram chat group with topics turned on.

5. Add your telegram bot to the private group chat you have made and give it admin rights.

8. Click the share button for the topic that you need (in this case info), then click the share button and copy the link.

9. You will then use this link and paste it in the info section when you initialise the bot.

What does this package do

Send your error or custom message logs to telegram.

🤖 Overview

This is a view of my setup

How to contribute

1. Clone the repository to your local machine.
2. Create a new branch on your local repository.
3. Follow the naming convention outlined in the article you provided (Check out this article) when naming your new branch.
4. Make the necessary changes to the code and push upstream, then open up a pr

DOCUMENTATION SOON: