forked from blacktwin/JBOPS
-
Notifications
You must be signed in to change notification settings - Fork 0
/
weekly_stats_reporting.py
517 lines (417 loc) · 18.1 KB
/
weekly_stats_reporting.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
Pull library and user statistics of last week.
Library stats can display total items in Shows, Seasons, Episodes, Artists, Albums, Tracks, and Movies
User stats display username and hour, minutes, and seconds of view time
Tautulli Settings > Extra Settings > Check - Calculate Total File Sizes [experimental] ...... wait
"""
from __future__ import print_function
from __future__ import unicode_literals
from builtins import range
from builtins import object
from plexapi.server import CONFIG
from datetime import datetime, timedelta, date
from requests import Session
from requests.adapters import HTTPAdapter
from requests.exceptions import RequestException
from operator import itemgetter
import time
import json
import argparse
# EDIT THESE SETTINGS #
TAUTULLI_URL = ''
TAUTULLI_APIKEY = ''
TAUTULLI_PUBLIC_URL = '0'
if not TAUTULLI_URL:
TAUTULLI_URL = CONFIG.data['auth'].get('tautulli_baseurl')
if not TAUTULLI_APIKEY:
TAUTULLI_APIKEY = CONFIG.data['auth'].get('tautulli_apikey')
if not TAUTULLI_PUBLIC_URL:
TAUTULLI_PUBLIC_URL = CONFIG.data['auth'].get('tautulli_public_url')
VERIFY_SSL = False
if TAUTULLI_PUBLIC_URL != '/':
# Check to see if there is a public URL set in Tautulli
TAUTULLI_LINK = TAUTULLI_PUBLIC_URL
else:
TAUTULLI_LINK = TAUTULLI_URL
RICH_TYPE = ['discord', 'slack']
# Colors for rich notifications
SECTIONS_COLOR = 10964298
USERS_COLOR = 10964298
# Author name for rich notifications
AUTHOR_NAME = 'My Server'
TAUTULLI_ICON = 'https://github.com/Tautulli/Tautulli/raw/master/data/interfaces/default/images/logo-circle.png'
SUBJECT_TEXT = "Tautulli Statistics"
# Notification notifier ID: https://github.com/JonnyWong16/plexpy/blob/master/API.md#notify
NOTIFIER_ID = 12 # The email notification notifier ID for Tautulli
# Remove library element you do not want shown. Logging before exclusion.
# SHOW_STAT = 'Shows: {0}, Episodes: {2}'
# SHOW_STAT = 'Episodes: {2}'
# SHOW_STAT = ''
SHOW_STAT = 'Shows: {0}, Seasons: {1}, Episodes: {2}'
ARTIST_STAT = 'Artists: {0}, Albums: {1}, Songs: {2}'
PHOTO_STAT = 'Folders: {0}, Subfolders: {1}, Photos: {2}'
MOVIE_STAT = 'Movies: {0}'
# Library names you do not want shown. Logging before exclusion.
LIB_IGNORE = ['XXX']
# Customize user stats display
# User: USER1 -> 1 hr 32 min 00 sec
USER_STAT = '{0} -> {1}'
# Usernames you do not want shown. Logging before exclusion.
USER_IGNORE = ['User1']
# User stat choices
STAT_CHOICE = ['duration', 'plays']
# Customize time display
# {0:d} hr {1:02d} min {2:02d} sec --> 1 hr 32 min 00 sec
# {0:d} hr {1:02d} min --> 1 hr 32 min
# {0:02d} hr {1:02d} min --> 01 hr 32 min
TIME_DISPLAY = "{0:d} hr {1:02d} min {2:02d} sec"
# Customize BODY to your liking
BODY_TEXT = """\
<html>
<head></head>
<body>
<p>Hi!<br>
<br>Below are the current server stats.<br>
<ul>
{sections_stats}
</ul>
<br>Below are the user stats for the week of ({start} - {end})<br>
<ol>
{user_stats}
</ol>
</p>
</body>
</html>
"""
# /EDIT THESE SETTINGS #
def utc_now_iso():
"""Get current time in ISO format"""
utcnow = datetime.utcnow()
return utcnow.isoformat()
def hex_to_int(value):
"""Convert hex value to integer"""
try:
return int(value, 16)
except (ValueError, TypeError):
return 0
def sizeof_fmt(num, suffix='B'):
# Function found https://stackoverflow.com/a/1094933
for unit in ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi']:
if abs(num) < 1024.0:
return "%3.1f%s%s" % (num, unit, suffix)
num /= 1024.0
return "%.1f%s%s" % (num, 'Yi', suffix)
def date_split(to_split):
split_year = int(to_split.split('-')[0])
split_month = int(to_split.split('-')[1])
split_day = int(to_split.split('-')[2])
return [split_year, split_month, split_day]
def add_to_dictval(d, key, val):
if key not in d:
d[key] = val
else:
d[key] += val
def daterange(start_date, end_date):
for n in range(int((end_date - start_date).days) + 1):
yield start_date + timedelta(n)
def get_user_stats(home_stats, rich, stats_type, notify=None):
user_stats_lst = []
user_stats_dict = {}
print('Checking users stats.')
for stats in home_stats:
if stats['stat_id'] == 'top_users':
for row in stats['rows']:
if stats_type == 'duration':
add_to_dictval(user_stats_dict, row['friendly_name'], row['total_duration'])
else:
add_to_dictval(user_stats_dict, row['friendly_name'], row['total_plays'])
for user, stat in sorted(user_stats_dict.items(), key=itemgetter(1), reverse=True):
if user not in USER_IGNORE:
if stats_type == 'duration':
user_total = timedelta(seconds=stat)
USER_STATS = USER_STAT.format(user, user_total)
else:
USER_STATS = USER_STAT.format(user, stat)
if rich or not notify:
user_stats_lst += ['{}'.format(USER_STATS)]
else:
# Html formatting
user_stats_lst += ['<li>{}</li>'.format(USER_STATS)]
return user_stats_lst
def get_library_stats(libraries, tautulli, rich, notify=None):
section_count = ''
total_size = 0
sections_stats_lst = []
print('Checking library stats.')
for section in libraries:
library = tautulli.get_library_media_info(section['section_id'])
total_size += library['total_file_size']
if section['section_type'] == 'artist':
section_count = ARTIST_STAT.format(section['count'], section['parent_count'], section['child_count'])
elif section['section_type'] == 'show':
section_count = SHOW_STAT.format(section['count'], section['parent_count'], section['child_count'])
elif section['section_type'] == 'photo':
section_count = PHOTO_STAT.format(section['count'], section['parent_count'], section['child_count'])
elif section['section_type'] == 'movie':
section_count = MOVIE_STAT.format(section['count'])
if section['section_name'] not in LIB_IGNORE and section_count:
if rich or not notify:
sections_stats_lst += ['{}: {}'.format(section['section_name'], section_count)]
else:
# Html formatting
sections_stats_lst += ['<li>{}: {}</li>'.format(section['section_name'], section_count)]
if rich or not notify:
sections_stats_lst += ['Capacity: {}'.format(sizeof_fmt(total_size))]
else:
# Html formatting. Adding the Capacity to bottom of list.
sections_stats_lst += ['<li>Capacity: {}</li>'.format(sizeof_fmt(total_size))]
return sections_stats_lst
class Tautulli(object):
def __init__(self, url, apikey, verify_ssl=False, debug=None):
self.url = url
self.apikey = apikey
self.debug = debug
self.session = Session()
self.adapters = HTTPAdapter(max_retries=3,
pool_connections=1,
pool_maxsize=1,
pool_block=True)
self.session.mount('http://', self.adapters)
self.session.mount('https://', self.adapters)
# Ignore verifying the SSL certificate
if verify_ssl is False:
self.session.verify = False
# Disable the warning that the request is insecure, we know that...
import urllib3
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
def get_library_media_info(self, section_id=None, refresh=None):
"""Call Tautulli's get_activity api endpoint"""
payload = {}
if refresh:
for library in self.get_libraries():
payload['section_id'] = library['section_id']
payload['refresh'] = 'true'
print('Refreshing library: {}'.format(library['section_name']))
self._call_api('get_library_media_info', payload)
print('Libraries have been refreshed, please wait while library stats are updated.')
exit()
else:
payload['section_id'] = section_id
return self._call_api('get_library_media_info', payload)
def get_libraries(self):
"""Call Tautulli's get_activity api endpoint"""
payload = {}
return self._call_api('get_libraries', payload)
def get_home_stats(self, time_range, stats_type, stats_count):
"""Call Tautulli's get_activity api endpoint"""
payload = {}
payload['time_range'] = time_range
payload['stats_type'] = stats_type
payload['stats_count'] = stats_count
return self._call_api('get_home_stats', payload)
def get_history(self, section_id, check_date):
"""Call Tautulli's get_activity api endpoint"""
payload = {}
payload['section_id'] = int(section_id)
payload['start_date'] = check_date
return self._call_api('get_history', payload)
def notify(self, notifier_id, subject, body):
"""Call Tautulli's notify api endpoint"""
payload = {'notifier_id': notifier_id,
'subject': subject,
'body': body}
return self._call_api('notify', payload)
def _call_api(self, cmd, payload, method='GET'):
payload['cmd'] = cmd
payload['apikey'] = self.apikey
try:
response = self.session.request(method, self.url + '/api/v2', params=payload)
except RequestException as e:
print("Tautulli request failed for cmd '{}'. Invalid Tautulli URL? Error: {}".format(cmd, e))
return
try:
response_json = response.json()
except ValueError:
print(
"Failed to parse json response for Tautulli API cmd '{}': {}"
.format(cmd, response.content))
return
if response_json['response']['result'] == 'success':
if self.debug:
print("Successfully called Tautulli API cmd '{}'".format(cmd))
return response_json['response']['data']
else:
error_msg = response_json['response']['message']
print("Tautulli API cmd '{}' failed: {}".format(cmd, error_msg))
return
class Notification(object):
def __init__(self, notifier_id, subject, body, tautulli, stats=None):
self.notifier_id = notifier_id
self.subject = subject
self.body = body
self.tautulli = tautulli
if stats:
self.stats = stats
def send(self, subject='', body=''):
"""Send to Tautulli notifier.
Parameters
----------
subject : str
Subject of the message.
body : str
Body of the message.
"""
subject = subject or self.subject
body = body or self.body
self.tautulli.notify(notifier_id=self.notifier_id, subject=subject, body=body)
def send_discord(self, title, color, stat, footer):
"""Build the Discord message.
Parameters
----------
title : str
The title of the message.
color : int
The color of the message
"""
discord_message = {
"embeds": [
{
"author": {
"icon_url": TAUTULLI_ICON,
"name": AUTHOR_NAME,
},
"color": color,
"fields": [
{
"name": "{} Stats".format(stat),
"value": "".join(self.stats)
},
],
"title": title,
"timestamp": utc_now_iso(),
"footer": {
"text": " to ".join(x for x in footer)
}
}
],
}
discord_message = json.dumps(discord_message, sort_keys=True,
separators=(',', ': '))
self.send(body=discord_message)
def send_slack(self, title, color, stat):
"""Build the Slack message.
Parameters
----------
title : str
The title of the message.
color : int
The color of the message
poster_url : str
The media poster URL.
plex_url : str
Plex media URL.
message : str
Message sent to the player.
footer : str
Footer of the message.
"""
slack_message = {
"attachments": [
{
"title": title,
"author_icon": TAUTULLI_ICON,
"author_name": AUTHOR_NAME,
"author_link": TAUTULLI_LINK.rstrip('/'),
"color": color,
"fields": [
{
"title": "{} Stats".format(stat),
"value": self.stats,
"short": True
},
],
"ts": time.time()
}
],
}
slack_message = json.dumps(slack_message, sort_keys=True,
separators=(',', ': '))
self.send(body=slack_message)
if __name__ == '__main__':
parser = argparse.ArgumentParser(description="Use Tautulli to pull library and user statistics for date range.",
formatter_class=argparse.RawTextHelpFormatter)
parser.add_argument('-d', '--days', default=7, metavar='', type=int,
help='Enter in number of days to go back. \n(default: %(default)s)')
parser.add_argument('-t', '--top', default=5, metavar='', type=int,
help='Enter in number of top users to find. \n(default: %(default)s)')
parser.add_argument('--stat', default='duration', choices=STAT_CHOICE,
help='Enter in number of top users to find. \n(default: %(default)s)')
parser.add_argument('--notify', type=int,
help='Notification Agent ID number to Agent to '
'send notification.')
parser.add_argument('--richMessage', choices=RICH_TYPE,
help='Rich message type selector.\nChoices: (%(choices)s)')
parser.add_argument('--refresh', action='store_true',
help='Refresh all libraries in Tautulli')
parser.add_argument('--libraryStats', action='store_true',
help='Only retrieve library stats.')
parser.add_argument('--userStats', action='store_true',
help='Only retrieve users stats.')
# todo Goals: growth reporting? show library size growth over time?
opts = parser.parse_args()
tautulli_server = Tautulli(TAUTULLI_URL.rstrip('/'), TAUTULLI_APIKEY, VERIFY_SSL)
if opts.refresh:
tautulli_server.get_library_media_info(refresh=True)
TODAY = int(time.time())
DAYS = opts.days
DAYS_AGO = int(TODAY - DAYS * 24 * 60 * 60)
START_DATE = (datetime.utcfromtimestamp(DAYS_AGO).strftime("%Y-%m-%d")) # DAYS_AGO as YYYY-MM-DD
END_DATE = (datetime.utcfromtimestamp(TODAY).strftime("%Y-%m-%d")) # TODAY as YYYY-MM-DD
start_date = date(date_split(START_DATE)[0], date_split(START_DATE)[1], date_split(START_DATE)[2])
end_date = date(date_split(END_DATE)[0], date_split(END_DATE)[1], date_split(END_DATE)[2])
dates_range_lst = []
for single_date in daterange(start_date, end_date):
dates_range_lst += [single_date.strftime("%Y-%m-%d")]
end = datetime.strptime(time.ctime(float(TODAY)), "%a %b %d %H:%M:%S %Y").strftime("%a %b %d %Y")
start = datetime.strptime(time.ctime(float(DAYS_AGO)), "%a %b %d %H:%M:%S %Y").strftime("%a %b %d %Y")
sections_stats = ''
if opts.libraryStats or (not opts.libraryStats and not opts.userStats):
libraries = tautulli_server.get_libraries()
lib_stats = get_library_stats(libraries, tautulli_server, opts.richMessage, opts.notify)
sections_stats = "\n".join(lib_stats)
user_stats = ''
if opts.userStats or (not opts.libraryStats and not opts.userStats):
print('Checking user stats from {:02d} days ago.'.format(opts.days))
home_stats = tautulli_server.get_home_stats(opts.days, opts.stat, opts.top)
user_stats_lst = get_user_stats(home_stats, opts.richMessage, opts.stat, opts.notify)
user_stats = "\n".join(user_stats_lst)
if opts.notify and opts.richMessage:
user_notification = ''
if user_stats:
user_notification = Notification(opts.notify, None, None, tautulli_server, user_stats)
section_notification = ''
if sections_stats:
section_notification= Notification(opts.notify, None, None, tautulli_server, sections_stats)
if opts.richMessage == 'slack':
if user_notification:
user_notification.send_slack(SUBJECT_TEXT, USERS_COLOR, 'User ' + opts.stat.capitalize())
if section_notification:
section_notification.send_slack(SUBJECT_TEXT, SECTIONS_COLOR, 'Section')
elif opts.richMessage == 'discord':
if user_notification:
user_notification.send_discord(SUBJECT_TEXT, USERS_COLOR, 'User ' + opts.stat.capitalize(),
footer=(end,start))
if section_notification:
section_notification.send_discord(SUBJECT_TEXT, SECTIONS_COLOR, 'Section', footer=(end,start))
elif opts.notify and not opts.richMessage:
BODY_TEXT = BODY_TEXT.format(end=end, start=start, sections_stats=sections_stats, user_stats=user_stats)
print('Sending message.')
notify = Notification(opts.notify, SUBJECT_TEXT, BODY_TEXT, tautulli_server)
notify.send()
else:
if sections_stats:
print('Section Stats:\n{}'.format(''.join(sections_stats)))
if user_stats:
print('User {} Stats:\n{}'.format(opts.stat.capitalize(), ''.join(user_stats)))