# log4js-telegram-appender

> Writes logs to telegram chats

Latest version **1.1.0** (published 2021-05-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install log4js-telegram-appender
pnpm add log4js-telegram-appender
yarn add log4js-telegram-appender
bun add log4js-telegram-appender
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-05-20 |
| First published | 2019-12-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | human_ |
| Keywords | telegram, log4js, appender |

## Links

- npm: https://www.npmjs.com/package/log4js-telegram-appender
- Repository: https://github.com/superiority/log4js-telegram-appender
- Homepage: https://github.com/superiority/log4js-telegram-appender#readme
- Issues: https://github.com/superiority/log4js-telegram-appender/issues
- npm.io page: https://npm.io/package/log4js-telegram-appender

## Dependencies (1)

- [got](https://npm.io/package/got.md) ^11.8.2

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-05-20
- 1.0.2 — 2020-02-28
- 1.0.1 — 2019-12-26
- 1.0.0 — 2019-12-26

## README

# TelegramAppender - for [log4js](https://github.com/log4js-node/log4js-node)

Pre-requisites:
* registered a telegram bot
* telegram bot token
* put the bot in a chat group
* chat id of the group
* reference: [Telegram Bot API](https://core.telegram.org/bots/api)


Install peer dependency log4js:
```
npm install --save log4js
```

Install log4js-node-telegramAppender:
```
npm install --save log4js-telegram-appender
```

Sample usage:
```
'use strict';

const log4js = require("log4js");
log4js.configure({
    appenders: {
        colouredConsole: { type: 'stdout' },
        telegramAlert: {
            type: 'log4js-telegram-appender',
            silentAlertLevel: 'info',
            audioAlertLevel: 'error',
            bottoken: <token>,
            botchatid: <chatid>
        }
    },
    categories: { default: { appenders: ['colouredConsole', 'telegramAlert'], level: 'debug' } }
})

var logger = log4js.getLogger("TEST");

logger.debug(`This logs to console only`);
logger.info(`This logs to console and telegram, without telegram notification sound`);
logger.error(`This logs to console and telegram, with telegram notification sound`);
```

---
_Source: https://npm.io/package/log4js-telegram-appender · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._