telegraf | driven server agent for collecting & reporting metrics | Plugin library

by influxdata Go Version: v1.25.0 License: MIT

kandi X-RAY | telegraf Summary

telegraf is a Go library typically used in Plugin, Prometheus applications. telegraf has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can download it from GitHub.

Telegraf is an agent for collecting, processing, aggregating, and writing metrics. Based on a plugin system to enable developers in the community to easily add support for additional metric collection. There are four distinct types of plugins:. New plugins are designed to be easy to contribute, pull requests are welcomed, and we work to incorporate as many pull requests as possible. Consider looking at the list of external plugins as well.

Support

Quality

Security

License

Reuse

kandi-support Support

telegraf has a medium active ecosystem.
It has 12440 star(s) with 5176 fork(s). There are 313 watchers for this library.
There were 7 major release(s) in the last 6 months.
There are 510 open issues and 5900 have been closed. On average issues are closed in 177 days. There are 30 open pull requests and 0 closed requests.
It has a neutral sentiment in the developer community.
The latest version of telegraf is v1.25.0

telegraf Support

Best in #Plugin

Average in #Plugin

telegraf Support

Best in #Plugin

Average in #Plugin

quality kandi Quality

telegraf has 0 bugs and 0 code smells.

telegraf Quality

Best in #Plugin

Average in #Plugin

telegraf Quality

Best in #Plugin

Average in #Plugin

security Security

telegraf has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.
telegraf code analysis shows 0 unresolved vulnerabilities.
There are 0 security hotspots that need review.

telegraf Security

Best in #Plugin

Average in #Plugin

telegraf Security

Best in #Plugin

Average in #Plugin

license License

telegraf is licensed under the MIT License. This license is Permissive.
Permissive licenses have the least restrictions, and you can use them in most projects.

telegraf License

Best in #Plugin

Average in #Plugin

telegraf License

Best in #Plugin

Average in #Plugin

build Reuse

telegraf releases are available to install and integrate.
Installation instructions, examples and code snippets are available.
It has 272001 lines of code, 8856 functions and 1197 files.
It has medium code complexity. Code complexity directly impacts maintainability of the code.

telegraf Reuse

Best in #Plugin

Average in #Plugin

telegraf Reuse

Best in #Plugin

Average in #Plugin

Top functions reviewed by kandi - BETA

kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample Here

Get all kandi verified functions for this library.

telegraf Key Features

Input Plugins collect metrics from the system, services, or 3rd party APIs

Processor Plugins transform, decorate, and/or filter metrics

Aggregator Plugins create aggregate metrics (e.g. mean, min, max, quantiles, etc.)

Output Plugins write metrics to various destinations

telegraf Examples and Code Snippets

Community Discussions

Trending Discussions on telegraf

telegraf output plugin http error with TDengine
Telegraf doesn’t seem to send data to influxedb in dockerised images
Why are some entire sub topics absent from my Telegraf MQTT data?
How can I mount configuration file and other files on AWS Fargate
Error on Telegraf Helm Chart update: Error parsing data
Can I get suggestions of all possible properties of an object in TypeScript?
Telegram Bot how to send HTML file directly?
chat_member not getting invocked
Not possible to install add-on on specifiek nodes
Uncaught TypeError: bot.setMyCommands is not a function

Trending Discussions on telegraf

QUESTION

telegraf output plugin http error with TDengine

Asked 2022-Mar-31 at 02:17

I'm working on a monitoring system to retrieve hardware metric by telegraf and store the time-series data to TDengine.

But seem the data insertion is very slow even making telegraf reject to work anymore.

I got error msg like following:

2021-12-28T11:36:14Z W! [agent] ["outputs.http"] did not complete within its flush interval

2021-12-28T11:36:23Z E! [agent] Error writing to outputs.http: Post "http://xxxxxx:6041/influxdb/v1/write?db=bmc": context deadline exceeded (Client.Timeout exceeded while awaiting headers)

2021-12-28T11:36:35Z W! [agent] ["outputs.http"] did not complete within its flush interval

2021-12-28T11:36:43Z E! [agent] Error writing to outputs.http: Post "http://xxxxxx:6041/influxdb/v1/write?db=bmc": context deadline exceeded (Client.Timeout exceeded while awaiting headers)

2021-12-28T11:37:02Z W! [agent] ["outputs.http"] did not complete within its flush interval

2021-12-28T11:37:07Z E! [agent] Error writing to outputs.http: Post "http://xxxxxx:6041/influxdb/v1/write?db=bmc": context deadline exceeded (Client.Timeout exceeded while awaiting headers)

2021-12-28T11:37:08Z W! [outputs.http] Metric buffer overflow; 7824 metrics have been dropped

2021-12-28T11:37:21Z W! [agent] ["outputs.http"] did not complete within its flush interval

2021-12-28T11:37:28Z E! [agent] Error writing to outputs.http: Post "http://xxxxxxxx:6041/influxdb/v1/write?db=bmc": context deadline exceeded (Client.Timeout exceeded while awaiting headers)

2021-12-28T11:37:28Z W! [outputs.http] Metric buffer overflow; 14363 metrics have been dropped

Does anyone know how to tune TDengine to work better performance?

ANSWER

Answered 2022-Mar-31 at 02:17

Edit /etc/taos/taosadatper.toml and add following lines:

debug = true
port = 6041
logLevel = "debug"

Source https://stackoverflow.com/questions/70533119

QUESTION

Telegraf doesn’t seem to send data to influxedb in dockerised images

Asked 2022-Mar-26 at 18:35

I have a dockerised telegraf (influxdata-docker/telegraf/1.21 at master · influxdata/influxdata-docker · GitHub) and influxdb (influxdata-docker/Dockerfile at master · influxdata/influxdata-docker · GitHub).

I’m trying to send data to influxdb from ttn but without any success. The config file for telegraf is:

[agent]
interval = "30s"
debug = true
quiet = false
logfile = "/var/log/telegraf/telegraf.log"
[[inputs.mqtt_consumer]]
servers = ["tcp://eu1.cloud.thethings.network:1883"]
qos = 0
connection_timeout = "30s"
topics = [ "+/devices/+/up" ]
client_id = "_my_id"
username = "my_username"
password = "my_password"
data_format = "json"
[[outputs.influxdb_v2]]
urls = ["http://172.21.0.2:8086"]
token = "my_token"
organization = "iot"
bucket = "ttn_data"
[[outputs.file]]
  files = ["stdout", "/var/log/telegraf/metrics.out"]
  use_batch_format = false
  rotation_interval = "0h"
  rotation_max_size = "0MB"
  rotation_max_archives = 5
  data_format = "influx"

It seems that the dockers have been setup properly and one sees the other:

Starting datahandler_influxdb_1 ... done
Starting datahandler_telegraf_1 ... done
Attaching to datahandler_influxdb_1, datahandler_telegraf_1
influxdb_1  | 2022-03-25T21:16:33.734688793Z    info    found existing boltdb file, skipping setup wrapper      {"system": "docker", "bolt_path": "/var/lib/influxdb2/influxd.bolt"}
influxdb_1  | ts=2022-03-25T21:16:33.895365Z lvl=info msg="Welcome to InfluxDB" log_id=0_SjrEuW000 version=2.1.1 commit=657e1839de build_date=2021-11-09T03:03:48Z
influxdb_1  | ts=2022-03-25T21:16:33.899857Z lvl=info msg="Resources opened" log_id=0_SjrEuW000 service=bolt path=/var/lib/influxdb2/influxd.bolt
influxdb_1  | ts=2022-03-25T21:16:33.900228Z lvl=info msg="Resources opened" log_id=0_SjrEuW000 service=sqlite path=/var/lib/influxdb2/influxd.sqlite
influxdb_1  | ts=2022-03-25T21:16:33.912460Z lvl=info msg="Checking InfluxDB metadata for prior version." log_id=0_SjrEuW000 bolt_path=/var/lib/influxdb2/influxd.bolt
influxdb_1  | ts=2022-03-25T21:16:33.912610Z lvl=info msg="Using data dir" log_id=0_SjrEuW000 service=storage-engine service=store path=/var/lib/influxdb2/engine/data
influxdb_1  | ts=2022-03-25T21:16:33.912651Z lvl=info msg="Compaction settings" log_id=0_SjrEuW000 service=storage-engine service=store max_concurrent_compactions=2 throughput_bytes_per_second=50331648 throughput_bytes_per_second_burst=50331648
influxdb_1  | ts=2022-03-25T21:16:33.912670Z lvl=info msg="Open store (start)" log_id=0_SjrEuW000 service=storage-engine service=store op_name=tsdb_open op_event=start
influxdb_1  | ts=2022-03-25T21:16:33.942051Z lvl=info msg="index opened with 8 partitions" log_id=0_SjrEuW000 service=storage-engine index=tsi
influxdb_1  | ts=2022-03-25T21:16:33.944176Z lvl=info msg="Reading file" log_id=0_SjrEuW000 service=storage-engine engine=tsm1 service=cacheloader path=/var/lib/influxdb2/engine/wal/fd224ef0f0444b4b/autogen/2/_00001.wal size=1576906
telegraf_1  | 2022-03-25T21:16:34Z I! Starting Telegraf 1.21.4
telegraf_1  | 2022-03-25T21:16:34Z I! Using config file: /etc/telegraf/telegraf.conf
influxdb_1  | ts=2022-03-25T21:16:34.165432Z lvl=info msg="Opened shard" log_id=0_SjrEuW000 service=storage-engine service=store op_name=tsdb_open index_version=tsi1 path=/var/lib/influxdb2/engine/data/fd224ef0f0444b4b/autogen/2 duration=249.364ms
influxdb_1  | ts=2022-03-25T21:16:34.165582Z lvl=info msg="Open store (end)" log_id=0_SjrEuW000 service=storage-engine service=store op_name=tsdb_open op_event=end op_elapsed=252.912ms
influxdb_1  | ts=2022-03-25T21:16:34.165659Z lvl=info msg="Starting retention policy enforcement service" log_id=0_SjrEuW000 service=retention check_interval=30m
influxdb_1  | ts=2022-03-25T21:16:34.165687Z lvl=info msg="Starting precreation service" log_id=0_SjrEuW000 service=shard-precreation check_interval=10m advance_period=30m
influxdb_1  | ts=2022-03-25T21:16:34.165749Z lvl=info msg="Starting query controller" log_id=0_SjrEuW000 service=storage-reads concurrency_quota=1024 initial_memory_bytes_quota_per_query=9223372036854775807 memory_bytes_quota_per_query=9223372036854775807 max_memory_bytes=0 queue_size=1024
influxdb_1  | ts=2022-03-25T21:16:34.169554Z lvl=info msg="Configuring InfluxQL statement executor (zeros indicate unlimited)." log_id=0_SjrEuW000 max_select_point=0 max_select_series=0 max_select_buckets=0
influxdb_1  | ts=2022-03-25T21:16:34.476773Z lvl=info msg=Listening log_id=0_SjrEuW000 service=tcp-listener transport=http addr=:8086 port=8086
influxdb_1  | ts=2022-03-25T21:16:34.476855Z lvl=info msg=Starting log_id=0_SjrEuW000 service=telemetry interval=8h
grafana_1   | t=2022-03-25T21:16:43+0000 lvl=info msg="Request Completed" logger=context userId=1 orgId=1 uname=admin method=GET path=/api/live/ws status=0 remote_addr=172.21.0.1 time_ms=1 size=0 referer=
influxdb_1  | ts=2022-03-25T21:16:51.247533Z lvl=info msg=Unauthorized log_id=0_SjrEuW000 error="session not found"

In the /var/log/telegraf/metrics.out doesn’t seem to write anything and in telegraf.log I have:

2022-03-25T21:42:20Z D! [agent] Stopping service inputs
2022-03-25T21:42:20Z D! [inputs.mqtt_consumer] Disconnecting [tcp://eu1.cloud.thethings.network:1883]
2022-03-25T21:42:20Z D! [inputs.mqtt_consumer] Disconnected [tcp://eu1.cloud.thethings.network:1883]
2022-03-25T21:42:20Z D! [agent] Input channel closed
2022-03-25T21:42:20Z I! [agent] Hang on, flushing any cached metrics before shutdown
2022-03-25T21:42:20Z D! [outputs.influxdb_v2] Buffer fullness: 0 / 10000 metrics
2022-03-25T21:42:20Z D! [outputs.file] Buffer fullness: 0 / 10000 metrics
2022-03-25T21:42:20Z I! [agent] Stopping running outputs
2022-03-25T21:42:20Z D! [agent] Stopped Successfully
2022-03-25T21:42:28Z I! Loaded inputs: mqtt_consumer
2022-03-25T21:42:28Z I! Loaded aggregators: 
2022-03-25T21:42:28Z I! Loaded processors: 
2022-03-25T21:42:28Z I! Loaded outputs: file influxdb_v2
2022-03-25T21:42:28Z I! Tags enabled: host=169916e15b06
2022-03-25T21:42:28Z I! [agent] Config: Interval:30s, Quiet:false, Hostname:"169916e15b06", Flush Interval:10s
2022-03-25T21:42:28Z D! [agent] Initializing plugins
2022-03-25T21:42:28Z D! [agent] Connecting outputs
2022-03-25T21:42:28Z D! [agent] Attempting connection to [outputs.file]
2022-03-25T21:42:28Z D! [agent] Successfully connected to outputs.file
2022-03-25T21:42:28Z D! [agent] Attempting connection to [outputs.influxdb_v2]
2022-03-25T21:42:28Z D! [agent] Successfully connected to outputs.influxdb_v2
2022-03-25T21:42:28Z D! [agent] Starting service inputs
2022-03-25T21:42:28Z I! [inputs.mqtt_consumer] Connected [tcp://eu1.cloud.thethings.network:1883]
2022-03-25T21:42:38Z D! [outputs.influxdb_v2] Buffer fullness: 0 / 10000 metrics
2022-03-25T21:42:38Z D! [outputs.file] Buffer fullness: 0 / 10000 metrics
2022-03-25T21:42:48Z D! [outputs.influxdb_v2] Buffer fullness: 0 / 10000 metrics
2022-03-25T21:42:48Z D! [outputs.file] Buffer fullness: 0 / 10000 metrics
2022-03-25T21:42:58Z D! [outputs.file] Buffer fullness: 0 / 10000 metrics
2022-03-25T21:42:58Z D! [outputs.influxdb_v2] Buffer fullness: 0 / 10000 metrics
2022-03-25T21:43:08Z D! [outputs.influxdb_v2] Buffer fullness: 0 / 10000 metrics
2022-03-25T21:43:08Z D! [outputs.file] Buffer fullness: 0 / 10000 metrics

I suppose all the connections have been done properly, however I don’t see anything in influxdb or anything comming in telegraf. TTN has data for sure, but I don’t get anything.

Some advice would be great

ANSWER

Answered 2022-Mar-26 at 18:35

Just in case somebody else has the same issue, it was finally due to the fact I was using ttn v3, ie. in telegraf.conf:

topics = [ "v3/+/devices/+/up" ]

instead of:

topics = [ "+/devices/+/up" ]

Source https://stackoverflow.com/questions/71623562

QUESTION

Why are some entire sub topics absent from my Telegraf MQTT data?

Asked 2022-Mar-24 at 01:42

I am running InfluxDB and Telegraf ingesting MQTT data into the database. I have an odd behavior where in I am missing some data that I should be ingesting with Telegraf. I'm seeing loads of MQTT data, from topics and subtopics that are siblings of the missing data, but yet some data is still missing. I'm also not seeing anything indicating an error in the logs. This is my telegraf.conf

[[outputs.influxdb_v2]]
  urls = ["http://influxdb:8086"]
  token = "$KTS_TELEMETRY_INFLUXDB_TOKEN"
  organization = "$KTS_TELEMETRY_INFLUXDB_ORG"
  bucket = "$KTS_TELEMETRY_INFLUXDB_BUCKET"

[[inputs.mqtt_consumer]]
  data_format = "json"
  servers = ["tcp://10.0.200.10:1883"]
  topics = [ 
    "/sample/#"
  ]

And I am getting data on topics like /sample/runout/data and other subtopics, but I'm not getting anything on one of my topics, /sample/runout/status. I can see that there definitely is data coming across the wire on that topic however, running this command gives me plenty of data constantly.

mosquitto_sub -h 10.0.200.10 -t /sample/runout/status

Running the same command with /sample/runout/data also shows lots of messages just the same. Oddly /sample/runout/data is showing up in the database but /sample/runout/status is not.

This is one example of a message published to /sample/runout/status

{"RollingReady":false,"TwinSAFE_enable":false,"ReceivedDataValid":false,"FramesAligned":false,"FramesCoupled":false,"inner_frame":{"virtualAxisJogEnabled":true,"virtualAxisJogReady":false,"motionReady":false,"motionAccepted":false},"outer_frame":{"virtualAxisJogEnabled":true,"virtualAxisJogReady":false,"motionReady":false,"motionAccepted":false},"inner_big_vee":{"axesInPosition":true,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"outer_big_vee":{"axesInPosition":true,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_i1":{"axesInPosition":true,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_a1":{"axesInPosition":true,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_a2":{"axesInPosition":true,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_a3":{"axesInPosition":true,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_b1":{"axesInPosition":false,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_b2":{"axesInPosition":false,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_b3":{"axesInPosition":false,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_b4":{"axesInPosition":false,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_c1":{"axesInPosition":false,"enabled":false,"error":false,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_c2":{"axesInPosition":false,"enabled":false,"error":true,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_c3":{"axesInPosition":false,"enabled":false,"error":true,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_c4":{"axesInPosition":false,"enabled":false,"error":true,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_d1":{"axesInPosition":false,"enabled":false,"error":true,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false},"support_d2":{"axesInPosition":false,"enabled":false,"error":true,"initialized":false,"operational":false,"payoutMode":false,"payoutReady":false,"ready":false,"rollingMode":true,"rollingReady":false}}

The only thing I can thing of of significance here is that all of the values in this sub topic are booleans but the InfluxDB supports booleans just fine. What am I missing? I haven't been able to find any helpful ways to debug this.

ANSWER

Answered 2022-Mar-24 at 01:42

The answer here turned out to be that the input data_format="json" does not support booleans. I needed to upgrade to json_v2. This was not exactly clear to me how to just get the same exact behavior because the documentation wasn't really great. But I ended up with this and it works just fine.

[[outputs.influxdb_v2]]
  urls = ["http://influxdb:8086"]
  token = "$KTS_TELEMETRY_INFLUXDB_TOKEN"
  organization = "$KTS_TELEMETRY_INFLUXDB_ORG"
  bucket = "$KTS_TELEMETRY_INFLUXDB_BUCKET"


[[inputs.mqtt_consumer]]
  data_format = "json_v2"
  servers = ["tcp://10.0.200.10:1883"]
  topics = [ 
    "/sample/#"
  ]
  [[inputs.mqtt_consumer.json_v2]]
    [[inputs.mqtt_consumer.json_v2.object]]
      path = "@this"
      excluded_keys = []

Source https://stackoverflow.com/questions/71346762

QUESTION

Error on Telegraf Helm Chart update: Error parsing data

Asked 2022-Mar-11 at 12:37

Im trying to deploy telegraf helm chart on kubernetes.

helm upgrade --install telegraf-instance -f values.yaml influxdata/telegraf

When I add modbus input plugin with holding_register i get error

[telegraf] Error running agent: Error loading config file /etc/telegraf/telegraf.conf: Error parsing data: line 49: key `name’ is in conflict with line 2fd

my values.yaml like below

## Default values.yaml for Telegraf
## This is a YAML-formatted file.
## ref: https://hub.docker.com/r/library/telegraf/tags/

replicaCount: 1

image:
  repo: "telegraf"
  tag: "1.21.4"
  pullPolicy: IfNotPresent

podAnnotations: {}

podLabels: {}

imagePullSecrets: []

args: []

env:
  - name: HOSTNAME
    value: "telegraf-polling-service"

resources: {}

nodeSelector: {}

affinity: {}

tolerations: []

service:
  enabled: true
  type: ClusterIP
  annotations: {}

rbac:
  create: true
  clusterWide: false
  rules: []

serviceAccount:
  create: false
  name:
  annotations: {}

config:
  agent:
    interval: 60s
    round_interval: true
    metric_batch_size: 1000000
    metric_buffer_limit: 100000000
    collection_jitter: 0s
    flush_interval: 60s
    flush_jitter: 0s
    precision: ''
    hostname: '9825128'
    omit_hostname: false
  processors:
    - enum:
        mapping:
          field: "status"
          dest: "status_code"
          value_mappings:
            healthy: 1
            problem: 2
            critical: 3
  inputs:
    - modbus:
        name: "PS MAIN ENGINE"
        controller: 'tcp://192.168.0.101:502'
        slave_id: 1
        holding_registers: 
          - name: "Coolant Level"
            byte_order: CDAB
            data_type: FLOAT32
            scale: 0.001
            address: [51410, 51411]
    - modbus:
        name: "SB MAIN ENGINE"
        controller: 'tcp://192.168.0.102:502'
        slave_id: 1
        holding_registers: 
          - name: "Coolant Level"
            byte_order: CDAB
            data_type: FLOAT32
            scale: 0.001
            address: [51410, 51411]
  outputs:
    - influxdb_v2:
        token: token
        organization: organisation
        bucket: bucket
        urls:
          - "url"

metrics:
  health:
    enabled: true
    service_address: "http://:8888"
    threshold: 5000.0
  internal:
    enabled: true
    collect_memstats: false

pdb:
  create: true
  minAvailable: 1

ANSWER

Answered 2022-Mar-11 at 12:37

Problem resolved by doing the following steps

deleted config section of my values.yaml
added my telegraf.conf to /additional_config path
added configmap to kubernetes with the following command

  kubectl create configmap external-config --from-file=/additional_config

added the following command to values.yaml

    volumes:
      - name: my-config
        configMap:
          name: external-config
    volumeMounts:
      - name: my-config
        mountPath: /additional_config
    args:
      - "--config=/etc/telegraf/telegraf.conf"
      - "--config-directory=/additional_config"

Source https://stackoverflow.com/questions/71396884

QUESTION

Can I get suggestions of all possible properties of an object in TypeScript?

Asked 2022-Feb-17 at 09:28

I'm trying to use Telegraf (4.6.0) types and I'm having an issue with exploring possible message properties.

Here's what I do now:

import { Telegraf, Context } from 'telegraf'

const myBot = new Telegraf(myToken)
listenerBot.on('message', (ctx: Context) => {
    const {
        text,
        forward_from_chat, forward_from_message_id,
        photo, caption, caption_entities,
        // what it will contain if there's a video? audio? document? ...
    } = ctx.message as any
    // do stuff with message
}

Since messages can be of various types (in both non-TS and TS sense), when I type ctx.message. in IDE (VS Code in my case) I'm only suggested the props that are always in message object (like message_id). Yes, I can do things like

if('text' in ctx.message) {
    // do stuff with ctx.message.text
}

but this doesn't help me explore what props can ctx.message hold. I can imagine a hacky way like

class ExploredContext = ExploreProps<Context> → gives a class similar to Context,
  but all possible props are non-optional

...
(ctx as ExploredContext).message._ // cursor here, IDE shows possilbe props
(ctx.message as ExploredMessage)._ // or like this

but neither I know how to implement things like ExploreProps helper (I'm only aware of utility types) nor I know any better, non-hacky ways to get this (like some configuration of typescript and/or IDE).

Can you suggest a way to implement ExploreProps or a better way to explore possible props?

(in Telegraf context, I've also asked at in an issue, but a consistent solution would be helpful without regard to Telegraf itself)

ANSWER

Answered 2022-Feb-17 at 09:28

You can flatten a union using StrictUnion as defined here This type will basically add the missing members to all union constituents with the type undefined. This will allow de-structuring to suggest all members from any constituent, but each member that is not present in all union constituents will also contain undefined (which is probably for the best from a type-safety perspective)

import { Telegraf, Context } from 'telegraf'

type UnionKeys<T> = T extends T ? keyof T : never;
type StrictUnionHelper<T, TAll> = T extends any ? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, undefined>> : never;
type StrictUnion<T> = StrictUnionHelper<T, T>


const myToken = ""
const myBot = new Telegraf(myToken)
myBot.on('message', (ctx: Context) => {
    const {
        text,
        forward_from_chat, forward_from_message_id,
        photo, caption, caption_entities,
        
    } = ctx.message as StrictUnion<Context['message']>
})

Playground Link

Source https://stackoverflow.com/questions/71154609

QUESTION

Telegram Bot how to send HTML file directly?

Asked 2022-Jan-25 at 10:22

I created a game using HTML, now I am trying to import it in my js file, and send to user.

This is my code so far

const { Telegraf } = require('telegraf')
const bot = new Telegraf(process.env.BOT_TOKEN);
const test = require('./index.html');

bot.hears('?', ctx => {
//   console.log(ctx.from)
  let msg = `Spin the wheel`;
  ctx.deleteMessage();
  bot.telegram.sendMessage(ctx.chat.id, msg, {
      reply_markup: {
          inline_keyboard: [
              [{
                      text: "SPIN",
                      callback_data: 'wheeloffortune'
                  }
              ],
          ]
      }
  })
})


bot.action('wheeloffortune', ctx => {
    bot.telegram.sendMessage(ctx.chat.id, test, {parse_mode: 'HTML'});
})

but I am getting this error

<!DOCTYPE html>
^

SyntaxError: Unexpected token '<'

Any advice is appreciated

ANSWER

Answered 2022-Jan-25 at 10:22

As mentioned on Telegram BOT API's documentation, parse_mode of type html only supports a few tags. Therefore, you can't send your game's html file to the chat for the user with parse_mode set to html.

Here's what the docs say:

To use this mode, pass HTML in the parse_mode field. The following tags are currently supported:

<b>bold</b>, <strong>bold</strong>
<i>italic</i>, <em>italic</em>
<u>underline</u>, <ins>underline</ins>
<s>strikethrough</s>, <strike>strikethrough</strike>, <del>strikethrough</del>
<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler>
<b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b>
<a href="http://www.example.com/">inline URL</a>
<a href="tg://user?id=123456789">inline mention of a user</a>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
<pre><code class="language-python">pre-formatted fixed-width code block written in the Python programming language</code></pre>

Only the tags mentioned above are currently supported.
All <, > and & symbols that are not a part of a tag or an HTML entity must be replaced with the corresponding HTML entities (< with <, > with > and & with &).
All numerical HTML entities are supported.
The API currently supports only the following named HTML entities: <, >, & and ".
Use nested pre and code tags, to define programming language for pre entity.
Programming language can't be specified for standalone code tags.

Source https://stackoverflow.com/questions/70845713

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install telegraf

Telegraf requires Go version 1.17 or newer, the Makefile requires GNU make.
Install Go >=1.17 (1.17.2 recommended)
Clone the Telegraf repository: git clone https://github.com/influxdata/telegraf.git
Run make from the source directory cd telegraf make