aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--README.md2
-rwxr-xr-xteamspeak-multi.py198
2 files changed, 106 insertions, 94 deletions
diff --git a/README.md b/README.md
index a6334cf..91a72b4 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,8 @@ password = password
# host and port are not required if the default values are true for your setup
host = localhost
port = 10011
+# ids should only be seperated by kommas ( , ) without whitespaces
+id = 1,2
```
To install these plugins, you just have to symlink those plugins you would like to activate to the munin plugin directory eg. `/etc/munin/plugins/`. Or if you want to use the multigraph plugin only symlink that one the the munin plugin directory.
diff --git a/teamspeak-multi.py b/teamspeak-multi.py
index a072abe..6820811 100755
--- a/teamspeak-multi.py
+++ b/teamspeak-multi.py
@@ -2,11 +2,12 @@
# -*- coding: utf-8 -*-
# Plugin to monitor a TeamSpeak Server via telnet
-# * general bandwidth
+# * voice bandwidth
# * filetransfer bandwidth
# * uptime
# * user count
-# * connection statistics
+# * avg ping
+# * pktloss statistics
# Parameters understood:
# config (required)
@@ -20,7 +21,6 @@
import ts3
import sys
import os
-import re
class TeamspeakMulti:
@@ -30,7 +30,7 @@ class TeamspeakMulti:
self.port = os.environ.get('port', 10011)
self.id = os.environ.get('id', "1").split(sep=",")
- self.names = dict()
+ # config dictionarys
self.graph = {
'bandwidth': [
'multigraph teamspeak_transfer',
@@ -38,7 +38,7 @@ class TeamspeakMulti:
'graph_args --base 1024',
'graph_vlabel bytes in (-) / out (+)',
'graph_category voip',
- 'graph_info graph showing the total Teamspeak3 Bandwidth In and Out'
+ 'graph_info graph showing the voice bandwidth in and out'
],
'filetransfer': [
'multigraph teamspeak_fttransfer',
@@ -46,7 +46,7 @@ class TeamspeakMulti:
'graph_args --base 1024',
'graph_vlabel bytes in (-) / out (+)',
'graph_category voip',
- 'graph_info graph showing the Teamspeak3 File Bandwidth In and Out'
+ 'graph_info graph showing the file bandwidth in and out'
],
'uptime': [
'multigraph teamspeak_uptime',
@@ -55,7 +55,7 @@ class TeamspeakMulti:
'graph_scale no',
'graph_vlabel days',
'graph_category voip',
- 'graph_info graph showing the Teamspeak3 uptime'
+ 'graph_info graph showing TeamSpeak3 virtual server uptime'
],
'users': [
'multigraph teamspeak_usercount',
@@ -64,72 +64,103 @@ class TeamspeakMulti:
'graph_printf %.0lf',
'graph_vlabel connected users',
'graph_category voip',
- 'graph_info graph showing the number of connected users to the Teamspeak3 server'
+ 'graph_info graph showing the number of connected users to the server'
],
- 'connection': [
- 'multigraph teamspeak_connection',
- 'graph_title TeamSpeak connection statistics',
+ 'ping': [
+ 'multigraph teamspeak_ping',
+ 'graph_title TeamSpeak Ping',
'graph_args --base 1000 -l 0',
'graph_printf %.0lf',
- 'graph_vlabel connected users',
+ 'graph_vlabel Ping',
+ 'graph_category voip',
+ 'graph_info graph showing the average ping'
+ ],
+ 'pktloss': [
+ 'multigraph teamspeak_pktloss',
+ 'graph_title TeamSpeak packetloss statistics',
+ 'graph_args --base 1000 -l 0 -u 100 -r',
+ 'graph_scale no',
+ 'graph_vlabel packetloss in %',
'graph_category voip',
- 'graph_info graph showing general connection statistics'
+ 'graph_info graph showing packetloss statistics'
]
}
self.labels = {
"bandwidth": [
- 'down_%d.label %s',
- 'down_%d.info total amount of bytes received in the last 5 minutes',
- 'down_%d.type DERIVE',
- 'down_%d.graph no',
- 'down_%d.min 0',
- 'up_%d.label %s',
- 'up_%d.info total amount of bytes sent in the last 5 minutes',
- 'up_%d.type DERIVE',
- 'up_%d.negative up_%d',
- 'up_%d.min 0'
+ 'down_{sid}.label id_{sid}',
+ 'down_{sid}.info serverid {sid}\'s amount of bytes received in the last 5 minutes',
+ 'down_{sid}.type DERIVE',
+ 'down_{sid}.graph no',
+ 'down_{sid}.min 0',
+ 'up_{sid}.label id_{sid}',
+ 'up_{sid}.info serverid {sid}\'s amount of bytes sent in the last 5 minutes',
+ 'up_{sid}.type DERIVE',
+ 'up_{sid}.negative up_{sid}',
+ 'up_{sid}.min 0'
],
"filetransfer": [
- 'ftdown_%d.label %s',
- 'ftdown_%d.info file transfer bytes received in the last 5 minutes',
- 'ftdown_%d.type DERIVE',
- 'ftdown_%d.graph no',
- 'ftdown_%d.min 0',
- 'ftup_%d.label %s',
- 'ftup_%d.info file transfer bytes sent in the last 5 minutes',
- 'ftup_%d.type DERIVE',
- 'ftup_%d.negative ftup_%d',
- 'ftup_%d.min 0'
+ 'ftdown_{sid}.label id_{sid}',
+ 'ftdown_{sid}.info serverid {sid}\'s amount of filetransfer bytes received in the last 5 minutes',
+ 'ftdown_{sid}.type DERIVE',
+ 'ftdown_{sid}.graph no',
+ 'ftdown_{sid}.min 0',
+ 'ftup_{sid}.label id_{sid}',
+ 'ftup_{sid}.info serverid {sid}\'s amount of filetransfer bytes sent in the last 5 minutes',
+ 'ftup_{sid}.type DERIVE',
+ 'ftup_{sid}.negative ftup_{sid}',
+ 'ftup_{sid}.min 0'
],
"uptime": [
- 'uptime_%d.label %s uptime',
- 'uptime_%d.info %s server uptime',
- 'uptime_%d.cdef uptime_%d,86400,/',
- 'uptime_%d.min 0',
- 'uptime_%d.draw AREA'
+ 'uptime_{sid}.label id_{sid}',
+ 'uptime_{sid}.info serverid {sid}\'s uptime',
+ 'uptime_{sid}.cdef uptime_{sid},86400,/',
+ 'uptime_{sid}.min 0',
+ 'uptime_{sid}.draw AREA'
],
"users": [
- 'user_%d.label %s usercount',
- 'user_%d.info users connected in the last 5 minutes',
- 'user_%d.min 0',
- 'queryuser_%d.label %s queryuserscount',
- 'queryuser_%d.info queryusers connected in the last 5 minutes',
- 'queryuser_%d.min 0',
- 'ping_%d.label %s avg. ping',
- 'ping_%d.info average ping of users connected to %s',
- 'ping_%d.min 0'
+ 'user_{sid}.label id_{sid} users',
+ 'user_{sid}.info users connected to serverid_{sid} in the last 5 minutes',
+ 'user_{sid}.min 0',
+ 'queryuser_{sid}.label id_{sid} queryusers',
+ 'queryuser_{sid}.info queryusers connected to serverid_{sid} in the last 5 minutes',
+ 'queryuser_{sid}.min 0',
],
- "connection": [
- 'pktloss_%d.label %s avg. packetloss',
- 'pktloss_%d.info average packetloss of users connected to %s',
- 'pktloss_%d.min 0'
+ "ping": [
+ 'ping_{sid}.label id_{sid}',
+ 'ping_{sid}.info average ping of users connected to serverid_{sid}',
+ 'ping_{sid}.min 0'
+ ],
+ "pktloss": [
+ 'speech_{sid}.label id_{sid} speech',
+ 'speech_{sid}.info serverid {sid}\'s average speech packetloss',
+ 'speech_{sid}.min 0',
+ 'speech_{sid}.draw STACK',
+ 'keepalive_{sid}.label id_{sid} keepalive',
+ 'keepalive_{sid}.info serverid {sid}\'s average keepalive packetloss',
+ 'keepalive_{sid}.min 0',
+ 'keepalive_{sid}.draw STACK',
+ 'control_{sid}.label id_{sid} control',
+ 'control_{sid}.info serverid {sid}\'s average control packetloss',
+ 'control_{sid}.min 0',
+ 'control_{sid}.draw STACK',
+ 'total_{sid}.label id_{sid} total',
+ 'total_{sid}.info serverid {sid}\'s combined average packetloss',
+ 'total_{sid}.min 0',
+ 'total_{sid}.draw STACK'
]
}
- def config(self):
- # request additional info from the run method
- self.run("config")
+ # result dictionary
+ self.data = {
+ 'teamspeak_transfer': ['multigraph teamspeak_transfer'],
+ 'teamspeak_fttransfer': ['multigraph teamspeak_fttransfer'],
+ 'teamspeak_uptime': ['multigraph teamspeak_uptime'],
+ 'teamspeak_user': ['multigraph teamspeak_usercount'],
+ 'teamspeak_ping': ['multigraph teamspeak_ping'],
+ 'teamspeak_pktloss': ['multigraph teamspeak_pktloss']
+ }
+ def config(self):
# for every key in self.graph print out the config parameter
for key in self.graph:
print('\n'.join(self.graph[key]))
@@ -138,79 +169,58 @@ class TeamspeakMulti:
# fielname_$sid.option string
for sid in self.id:
if sid.isdigit():
- name = self.names[sid]
- print('\n'.join(self.labels[key]).replace("%d", str(sid)).replace("%s", str(name)))
-
- def get_data(self,sid, response):
- data = {
- 'teamspeak_transfer': [],
- 'teamspeak_fttransfer': [],
- 'teamspeak_uptime': [],
- 'teamspeak_usercount': [],
- 'teamspeak_connection': []
- }
+ print('\n'.join(self.labels[key]).replace("{sid}", str(sid)))
+
+ def get_data(self, sid, response):
+ # use the data dictionary to accumulate all results together
+ data = self.data
# transfer
- data['teamspeak_transfer'].append('multigraph teamspeak_transfer')
data['teamspeak_transfer'].append('down_%s.value %s' % (sid, response["connection_bytes_received_total"]))
data['teamspeak_transfer'].append('up_%s.value %s' % (sid, response["connection_bytes_sent_total"]))
# fttransfer
- data['teamspeak_fttransfer'].append('multigraph teamspeak_fttransfer')
data['teamspeak_fttransfer'].append('ftdown_%s.value %s' % (sid, response["connection_filetransfer_bytes_received_total"]))
data['teamspeak_fttransfer'].append('ftup_%s.value %s' % (sid, response["connection_filetransfer_bytes_sent_total"]))
# uptime
- data['teamspeak_uptime'].append('multigraph teamspeak_uptime')
data['teamspeak_uptime'].append('uptime_%s.value %s' % (sid, response["virtualserver_uptime"]))
# user connections
clientcount = int(response["virtualserver_clientsonline"]) - int(response["virtualserver_queryclientsonline"])
+ data['teamspeak_user'].append('user_%s.value %s' % (sid, clientcount))
+ data['teamspeak_user'].append('queryuser_%s.value %s' % (sid, response["virtualserver_queryclientsonline"]))
- data['teamspeak_usercount'].append('multigraph teamspeak_usercount')
- data['teamspeak_usercount'].append('user_%s.value %s' % (sid, clientcount))
- data['teamspeak_usercount'].append('queryuser_%s.value %s' % (sid, response["virtualserver_queryclientsonline"]))
- data['teamspeak_usercount'].append('ping_%s.value %s' % (sid, response["virtualserver_total_ping"]))
-
- # connection statistics
- data['teamspeak_connection'].append('multigraph teamspeak_connection')
- data['teamspeak_connection'].append('pktloss_%s.value %s' % (sid, response["virtualserver_total_packetloss_total"]))
-
- # for key in results print every entry in dict
- [print('\n'.join(data[key])) for key in data.keys()]
+ # avg ping
+ data['teamspeak_ping'].append('ping_%s.value %s' % (sid, response["virtualserver_total_ping"]))
- def clean_fieldname(self, text):
- # munin suggestion to produce clean fieldnames
- return re.sub(r"(^[^A-Za-z_]|[^A-Za-z0-9_ ])", "", text)
+ # packetloss statistics
+ data['teamspeak_pktloss'].append('speech_%s.value %s' % (sid, response["virtualserver_total_packetloss_speech"]))
+ data['teamspeak_pktloss'].append('keepalive_%s.value %s' % (sid, response["virtualserver_total_packetloss_keepalive"]))
+ data['teamspeak_pktloss'].append('control_%s.value %s' % (sid, response["virtualserver_total_packetloss_control"]))
+ data['teamspeak_pktloss'].append('total_%s.value %s' % (sid, response["virtualserver_total_packetloss_total"]))
- def get_names(self, response):
- # method to match serverid to the servername
- for server in response:
- self.names[str(server["virtualserver_id"])] = self.clean_fieldname(server["virtualserver_name"])
-
- def run(self, arg=None):
+ def run(self):
with ts3.query.TS3Connection(self.host, self.port) as ts3conn:
# will raise a TS3QueryError if response code is not 0
try:
ts3conn.login(client_login_name=os.environ['username'], client_login_password=os.environ['password'])
- if arg == "config":
- serverlist = ts3conn.serverlist().parsed
- self.get_names(serverlist)
- return
-
for sid in self.id:
if sid.isdigit():
ts3conn.use(sid=sid)
info = ts3conn.serverinfo().parsed
self.get_data(sid, info[0])
+ # for key in results print every entry in dict
+ [print('\n'.join(self.data[key])) for key in self.data.keys()]
+
except (ts3.query.TS3QueryError, KeyError) as err:
print("Login failed:", err.resp.error["msg"])
exit(1)
def main(self):
- # check if any argument is given
+ # check if any argument is given
if sys.argv.__len__() >= 2:
# check if first argument is config or autoconf if not fetch data
if sys.argv[1] == "config":
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-01 09:33:06 +0100