telegraf/plugins/inputs/teamspeak
Sebastian Spaink d67f75e557
docs: Remove warning not to remove go:embed (#11797)
Co-authored-by: Joshua Powers <powersj@fastmail.com>
2022-09-13 12:47:58 -05:00
..
README.md chore: Fix readme linter errors for input plugins M-Z (#11274) 2022-06-08 15:22:56 -06:00
sample.conf chore(inputs_m-z): migrate sample configs into separate files (#11133) 2022-05-18 11:31:34 -05:00
teamspeak.go docs: Remove warning not to remove go:embed (#11797) 2022-09-13 12:47:58 -05:00
teamspeak_test.go Linter fixes (unhandled errors) -- Part 1 (#8992) 2021-04-08 11:43:39 -05:00

README.md

Teamspeak 3 Input Plugin

This plugin uses the Teamspeak 3 ServerQuery interface of the Teamspeak server to collect statistics of one or more virtual servers. If you are querying an external Teamspeak server, make sure to add the host which is running Telegraf to query_ip_allowlist.txt in the Teamspeak Server directory. For information about how to configure the server take a look the Teamspeak 3 ServerQuery Manual.

Configuration

# Reads metrics from a Teamspeak 3 Server via ServerQuery
[[inputs.teamspeak]]
  ## Server address for Teamspeak 3 ServerQuery
  # server = "127.0.0.1:10011"
  ## Username for ServerQuery
  username = "serverqueryuser"
  ## Password for ServerQuery
  password = "secret"
  ## Nickname of the ServerQuery client
  nickname = "telegraf"
  ## Array of virtual servers
  # virtual_servers = [1]

Metrics

  • teamspeak
    • uptime
    • clients_online
    • total_ping
    • total_packet_loss
    • packets_sent_total
    • packets_received_total
    • bytes_sent_total
    • bytes_received_total
    • query_clients_online

Tags

  • The following tags are used:
    • virtual_server
    • name

Example Output

teamspeak,virtual_server=1,name=LeopoldsServer,host=vm01 bytes_received_total=29638202639i,uptime=13567846i,total_ping=26.89,total_packet_loss=0,packets_sent_total=415821252i,packets_received_total=237069900i,bytes_sent_total=55309568252i,clients_online=11i,query_clients_online=1i 1507406561000000000