---
title: Telegraf Documentation
description: Telegraf plugin for collecting metrics from Teamspeak
url: https://docs.influxdata.com/telegraf/v1/input-plugins/teamspeak/
estimated_tokens: 1041
product: Telegraf
version: v1
---

-   Telegraf v1.5.0+

# Teamspeak Input Plugin

This plugin collects statistics of one or more virtual [Teamspeak](https://www.teamspeak.com) 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

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.

## Configuration

```toml
# 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](http://media.teamspeak.com/ts3_literature/TeamSpeak%203%20Server%20Query%20Manual.pdf).

## 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

```text
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
```

#### Related

-   [Configure plugins](/telegraf/v1/configure_plugins/)
-   [Teamspeak Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/teamspeak/README.md)