Teamspeak Input Plugin
This plugin collects statistics of one or more virtual Teamspeak
servers using the ServerQuery
interface. Currently this plugin only supports
Teamspeak 3 servers.
For querying external Teamspeak server, make sure to add the Telegraf host
to the query_ip_allowlist.txt
file in the Teamspeak Server directory.
Introduced in: Telegraf v1.5.0 Tags: server OS support: all
Global configuration options
In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.
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]
Teamspeak configuration
For information about how to configure the Teamspeak server take a look at the Teamspeak 3 ServerQuery Manual.
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
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Telegraf and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.