FLB output plugin for Telegram

FluentBit output plugin for Telegram

FluentBit OUTPUT Params

param name	default	description	example	mandatory
Name	telegram	pulgin name (fixed)		yes
api_token		telegram api token	YOUR_API_KEY	yes
room_ids		comma seperated room ids	1111111111,2222222222	yes
message_key	message	key for message to send	cpu_p	no
timestamp_layout	20060102T15:04:05Z	Go timestamp layout	060102-150405	no
timestamp_location	UTC	timestamp in specific timezone	Asia/Seoul	no
optional_keys		optional keys to send	level,hostname	no
suppress_duplication	no	suppress duplicated messages	yes,on,true	no
suppress_timeout	0	stop suppressing after given duration	10s	no
floor_float	no	floor float value	yes,on,true	no

Build and Run

Build docker image flb-tg which is Telegram enabled fluent-bit image:

docker buildx build \
  --platform linux/amd64 \
  --tag=flb-tg:latest \
  .

Run example:

docker run \
  -it --rm \
  -e TG_API_TOKEN="YOUR_TELEGRAM_API_TOKEN"
  -e TG_ROOM_IDS="ROOM_ID1, ROOM_ID2"
  flb-tg:latest

Run Telegram enabled FluentBit

Check out sample conf file. Make your own conf and run like this:

docker run \
  -it --rm \
  -e TG_API_TOKEN="YOUR_TELEGRAM_API_TOKEN"
  -e TG_ROOM_IDS="ROOM_ID1, ROOM_ID2"
  -v /YOUR/FLB_CONF_PATH:/conf/flb.conf
  flb-tg:latest -c /conf/flb.conf

Example of practical cofiguration with rewrite_tag filter:

[FILTER]
    Name    rewrite_tag
    Match   app.*
    Rule    $alert ^(.+)$ notify.$1 true
    Rule    $level ^error notify.telegram true
    Rule    $level ^fatal notify.telegram true

[OUTPUT]
    Name    telegram
    Match   notify.telegram
    api_token               ${TG_API_TOKEN}
    room_ids                ${TG_ROOM_IDS}
    timestamp_location      Asia/Seoul
    timestamp_layout        20060102 15:04:05
    optional_keys           level,program,ver,hostname
    suppress_duplication    yes
    suppress_timeout        10s

Reference

• Fluent Bit Official Manual - Golang Output Plugins