1
0
mirror of https://github.com/haiwen/seahub.git synced 2025-08-10 11:22:09 +00:00
seahub/seahub/api2/endpoints/admin/statistics.py
2025-04-10 15:22:13 +08:00

584 lines
22 KiB
Python

# Copyright (c) 2012-2016 Seafile Ltd.
import datetime
import pytz
import logging
from rest_framework.authentication import SessionAuthentication
from rest_framework.permissions import IsAdminUser
from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework import status
from django.utils import timezone
from django.utils.translation import gettext as _
from django.http import HttpResponse
from seaserv import ccnet_api
from seahub.utils import get_file_ops_stats_by_day, IS_DB_SQLITE3, \
get_total_storage_stats_by_day, get_user_activity_stats_by_day, \
is_pro_version, EVENTS_ENABLED, get_system_traffic_by_day, \
get_all_users_traffic_by_month, get_all_orgs_traffic_by_month
from seahub.utils.timeutils import datetime_to_isoformat_timestr
from seahub.utils.ms_excel import write_xls
from seahub.utils.file_size import byte_to_mb
from seahub.views.sysadmin import _populate_user_quota_usage
from seahub.base.templatetags.seahub_tags import email2nickname, \
email2contact_email
from seahub.api2.authentication import TokenAuthentication
from seahub.api2.throttling import UserRateThrottle
from seahub.api2.utils import api_error
from seahub.api2.endpoints.utils import get_seafevents_metrics
logger = logging.getLogger(__name__)
def check_parameter(func):
def _decorated(view, request, *args, **kwargs):
if not EVENTS_ENABLED or (not is_pro_version() and IS_DB_SQLITE3):
return api_error(status.HTTP_404_NOT_FOUND, 'Events not enabled.')
start_time = request.GET.get("start", "")
end_time = request.GET.get("end", "")
if not start_time:
error_msg = "Start time can not be empty"
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
if not end_time:
error_msg = "End time can not be empty"
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
try:
start_time = datetime.datetime.strptime(start_time,
"%Y-%m-%d %H:%M:%S")
except:
error_msg = "Start time %s invalid" % start_time
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
try:
end_time = datetime.datetime.strptime(end_time,
"%Y-%m-%d %H:%M:%S")
except:
error_msg = "End time %s invalid" % end_time
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
return func(view, request, start_time, end_time, *args, **kwargs)
return _decorated
class FileOperationsView(APIView):
"""
Get file operations statistics.
Permission checking:
1. only admin can perform this action.
"""
authentication_classes = (TokenAuthentication, SessionAuthentication)
throttle_classes = (UserRateThrottle,)
permission_classes = (IsAdminUser,)
@check_parameter
def get(self, request, start_time, end_time):
"""
Get records of the specified time range.
param:
start: the start time of the query.
end: the end time of the query.
return:
the list of file operations record.
"""
if not request.user.admin_permissions.can_view_statistic():
return api_error(status.HTTP_403_FORBIDDEN, 'Permission denied.')
offset = get_time_offset()
data = get_file_ops_stats_by_day(start_time, end_time, offset)
ops_added_dict = get_init_data(start_time, end_time)
ops_visited_dict = get_init_data(start_time, end_time)
ops_deleted_dict = get_init_data(start_time, end_time)
ops_modified_dict = get_init_data(start_time, end_time)
for e in data:
if e[1] == 'Added':
ops_added_dict[e[0]] = e[2]
elif e[1] == 'Visited':
ops_visited_dict[e[0]] = e[2]
elif e[1] == 'Deleted':
ops_deleted_dict[e[0]] = e[2]
elif e[1] == 'Modified':
ops_modified_dict[e[0]] = e[2]
res_data = []
for k, v in list(ops_added_dict.items()):
res_data.append({'datetime': datetime_to_isoformat_timestr(k),
'added': v,
'visited': ops_visited_dict[k],
'deleted': ops_deleted_dict[k],
'modified': ops_modified_dict[k]})
return Response(sorted(res_data, key=lambda x: x['datetime']))
class TotalStorageView(APIView):
authentication_classes = (TokenAuthentication, SessionAuthentication)
throttle_classes = (UserRateThrottle,)
permission_classes = (IsAdminUser,)
@check_parameter
def get(self, request, start_time, end_time):
if not request.user.admin_permissions.can_view_statistic():
return api_error(status.HTTP_403_FORBIDDEN, 'Permission denied.')
data = get_total_storage_stats_by_day(start_time, end_time, get_time_offset())
res_data = []
init_data = get_init_data(start_time, end_time)
for e in data:
init_data[e[0]] = e[1]
for k, v in list(init_data.items()):
res_data.append({'datetime': datetime_to_isoformat_timestr(k), 'total_storage': v})
return Response(sorted(res_data, key=lambda x: x['datetime']))
class ActiveUsersView(APIView):
authentication_classes = (TokenAuthentication, SessionAuthentication)
throttle_classes = (UserRateThrottle,)
permission_classes = (IsAdminUser,)
@check_parameter
def get(self, request, start_time, end_time):
if not request.user.admin_permissions.can_view_statistic():
return api_error(status.HTTP_403_FORBIDDEN, 'Permission denied.')
data = get_user_activity_stats_by_day(start_time, end_time, get_time_offset())
res_data = []
init_data = get_init_data(start_time, end_time)
for e in data:
init_data[e[0]] = e[1]
for k, v in list(init_data.items()):
res_data.append({'datetime': datetime_to_isoformat_timestr(k), 'count': v})
return Response(sorted(res_data, key=lambda x: x['datetime']))
class SystemTrafficView(APIView):
authentication_classes = (TokenAuthentication, SessionAuthentication)
throttle_classes = (UserRateThrottle,)
permission_classes = (IsAdminUser,)
@check_parameter
def get(self, request, start_time, end_time):
if not request.user.admin_permissions.can_view_statistic():
return api_error(status.HTTP_403_FORBIDDEN, 'Permission denied.')
op_type_list = ['web-file-upload', 'web-file-download',
'sync-file-download', 'sync-file-upload',
'link-file-upload', 'link-file-download']
init_count = [0] * 6
init_data = get_init_data(start_time, end_time,
dict(list(zip(op_type_list, init_count))))
for e in get_system_traffic_by_day(start_time, end_time,
get_time_offset()):
dt, op_type, count = e
init_data[dt].update({op_type: count})
res_data = []
for k, v in list(init_data.items()):
res = {'datetime': datetime_to_isoformat_timestr(k)}
res.update(v)
res_data.append(res)
return Response(sorted(res_data, key=lambda x: x['datetime']))
def get_init_data(start_time, end_time, init_data=0):
res = {}
start_time = start_time.replace(hour=0).replace(minute=0).replace(second=0)
end_time = end_time.replace(hour=0).replace(minute=0).replace(second=0)
time_delta = end_time - start_time
date_length = time_delta.days + 1
for offset in range(date_length):
offset = offset * 24
dt = start_time + datetime.timedelta(hours=offset)
if isinstance(init_data, dict):
res[dt] = init_data.copy()
else:
res[dt] = init_data
return res
def get_time_offset():
timezone_name = timezone.get_current_timezone_name()
offset = pytz.timezone(timezone_name).localize(datetime.datetime.now()).strftime('%z')
return offset[:3] + ':' + offset[3:]
class SystemUserTrafficView(APIView):
authentication_classes = (TokenAuthentication, SessionAuthentication)
throttle_classes = (UserRateThrottle,)
permission_classes = (IsAdminUser,)
def get(self, request):
if not request.user.admin_permissions.can_view_statistic():
return api_error(status.HTTP_403_FORBIDDEN, 'Permission denied.')
month = request.GET.get("month", "")
if not month:
error_msg = "month invalid."
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
try:
month_obj = datetime.datetime.strptime(month, "%Y%m")
except Exception as e:
logger.error(e)
error_msg = "month %s invalid" % month
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
try:
page = int(request.GET.get('page', '1'))
per_page = int(request.GET.get('per_page', '25'))
except ValueError:
page = 1
per_page = 25
start = (page - 1) * per_page
order_by = request.GET.get('order_by', '')
filters = [
'sync_file_upload', 'sync_file_download',
'web_file_upload', 'web_file_download',
'link_file_upload', 'link_file_download',
]
if order_by not in filters and \
order_by not in map(lambda x: x + '_desc', filters):
order_by = 'link_file_download_desc'
# get one more item than per_page, to judge has_next_page
try:
traffics = get_all_users_traffic_by_month(month_obj,
start,
start + per_page + 1,
order_by)
except Exception as e:
logger.error(e)
error_msg = 'Internal Server Error'
return api_error(status.HTTP_500_INTERNAL_SERVER_ERROR, error_msg)
if len(traffics) == per_page + 1:
has_next_page = True
traffics = traffics[:per_page]
else:
has_next_page = False
user_monthly_traffic_list = []
for traffic in traffics:
info = {}
info['email'] = traffic['user']
info['name'] = email2nickname(traffic['user'])
info['sync_file_upload'] = traffic['sync_file_upload']
info['sync_file_download'] = traffic['sync_file_download']
info['web_file_upload'] = traffic['web_file_upload']
info['web_file_download'] = traffic['web_file_download']
info['link_file_upload'] = traffic['link_file_upload']
info['link_file_download'] = traffic['link_file_download']
user_monthly_traffic_list.append(info)
return Response({
'user_monthly_traffic_list': user_monthly_traffic_list,
'has_next_page': has_next_page
})
class SystemOrgTrafficView(APIView):
authentication_classes = (TokenAuthentication, SessionAuthentication)
throttle_classes = (UserRateThrottle,)
permission_classes = (IsAdminUser,)
def get(self, request):
if not request.user.admin_permissions.can_view_statistic():
return api_error(status.HTTP_403_FORBIDDEN, 'Permission denied.')
month = request.GET.get("month", "")
if not month:
error_msg = "month invalid."
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
try:
month_obj = datetime.datetime.strptime(month, "%Y%m")
except Exception as e:
logger.error(e)
error_msg = "month %s invalid" % month
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
try:
page = int(request.GET.get('page', '1'))
per_page = int(request.GET.get('per_page', '25'))
except ValueError:
page = 1
per_page = 25
start = (page - 1) * per_page
order_by = request.GET.get('order_by', '')
filters = [
'sync_file_upload', 'sync_file_download',
'web_file_upload', 'web_file_download',
'link_file_upload', 'link_file_download',
]
if order_by not in filters and \
order_by not in map(lambda x: x + '_desc', filters):
order_by = 'link_file_download_desc'
# get one more item than per_page, to judge has_next_page
try:
traffics = get_all_orgs_traffic_by_month(month_obj,
start,
start + per_page + 1,
order_by)
except Exception as e:
logger.error(e)
error_msg = 'Internal Server Error'
return api_error(status.HTTP_500_INTERNAL_SERVER_ERROR, error_msg)
if len(traffics) == per_page + 1:
has_next_page = True
traffics = traffics[:per_page]
else:
has_next_page = False
org_monthly_traffic_list = []
for traffic in traffics:
info = {}
info['org_id'] = traffic['org_id']
org = ccnet_api.get_org_by_id(traffic['org_id'])
info['org_name'] = org.org_name if org else ''
info['sync_file_upload'] = traffic['sync_file_upload']
info['sync_file_download'] = traffic['sync_file_download']
info['web_file_upload'] = traffic['web_file_upload']
info['web_file_download'] = traffic['web_file_download']
info['link_file_upload'] = traffic['link_file_upload']
info['link_file_download'] = traffic['link_file_download']
org_monthly_traffic_list.append(info)
return Response({
'org_monthly_traffic_list': org_monthly_traffic_list,
'has_next_page': has_next_page,
})
class SystemUserTrafficExcelView(APIView):
authentication_classes = (TokenAuthentication, SessionAuthentication)
throttle_classes = (UserRateThrottle,)
permission_classes = (IsAdminUser,)
def get(self, request):
if not request.user.admin_permissions.can_view_statistic():
return api_error(status.HTTP_403_FORBIDDEN, 'Permission denied.')
month = request.GET.get("month", "")
if not month:
error_msg = "month invalid."
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
try:
month_obj = datetime.datetime.strptime(month, "%Y%m")
except:
error_msg = "Month %s invalid" % month
return api_error(status.HTTP_400_BAD_REQUEST, error_msg)
try:
res_data = get_all_users_traffic_by_month(month_obj, -1, -1)
except Exception as e:
logger.error(e)
error_msg = 'Internal Server Error'
return api_error(status.HTTP_500_INTERNAL_SERVER_ERROR, error_msg)
data_list = []
head = [_("Time"), _("User"), _("Web Download") + ('(MB)'), \
_("Sync Download") + ('(MB)'), _("Link Download") + ('(MB)'), \
_("Web Upload") + ('(MB)'), _("Sync Upload") + ('(MB)'), \
_("Link Upload") + ('(MB)')]
for data in res_data:
web_download = byte_to_mb(data['web_file_download'])
sync_download = byte_to_mb(data['sync_file_download'])
link_download = byte_to_mb(data['link_file_download'])
web_upload = byte_to_mb(data['web_file_upload'])
sync_upload = byte_to_mb(data['sync_file_upload'])
link_upload = byte_to_mb(data['link_file_upload'])
row = [month, data['user'], web_download, sync_download, \
link_download, web_upload, sync_upload, link_upload]
data_list.append(row)
excel_name = "User Traffic %s" % month
try:
wb = write_xls(excel_name, head, data_list)
except Exception as e:
logger.error(e)
error_msg = 'Internal Server Error'
return api_error(status.HTTP_500_INTERNAL_SERVER_ERROR, error_msg)
response = HttpResponse(content_type='application/ms-excel')
response['Content-Disposition'] = 'attachment; filename="%s.xlsx"' % excel_name
wb.save(response)
return response
class SystemUserStorageExcelView(APIView):
authentication_classes = (TokenAuthentication, SessionAuthentication)
throttle_classes = (UserRateThrottle,)
permission_classes = (IsAdminUser,)
def get(self, request):
if not request.user.admin_permissions.can_view_statistic():
return api_error(status.HTTP_403_FORBIDDEN, 'Permission denied.')
db_users = ccnet_api.get_emailusers('DB', -1, -1)
ldap_import_users = ccnet_api.get_emailusers('LDAPImport', -1, -1)
all_users = db_users + ldap_import_users
head = [_("Email"), _("Name"), _("Contact Email"),
_("Space Usage") + "(MB)", _("Space Quota") + "(MB)"]
data_list = []
for user in all_users:
user_email = user.email
user_name = email2nickname(user_email)
user_contact_email = email2contact_email(user_email)
_populate_user_quota_usage(user)
space_usage_MB = byte_to_mb(user.space_usage)
space_quota_MB = byte_to_mb(user.space_quota)
row = [user_email, user_name, user_contact_email,
space_usage_MB, space_quota_MB]
data_list.append(row)
excel_name = 'User Storage'
try:
wb = write_xls('users', head, data_list)
except Exception as e:
logger.error(e)
error_msg = 'Internal Server Error'
return api_error(status.HTTP_500_INTERNAL_SERVER_ERROR, error_msg)
response = HttpResponse(content_type='application/ms-excel')
response['Content-Disposition'] = 'attachment; filename="%s.xlsx"' % excel_name
wb.save(response)
return response
def parse_prometheus_metrics(metrics_raw):
"""
Parse prometheus metrics and format metric names
"""
formatted_metrics_dict = {}
def ensure_metric_exists(raw_name):
"""
Ensure metric entry exists in formatted metrics dict
"""
if raw_name not in formatted_metrics_dict:
formatted_metrics_dict[raw_name] = {
'name': raw_name,
'help': '',
'type': '',
'data_points': []
}
return raw_name
def parse_labels(line):
"""
Parse labels from metric line
"""
labels = {}
if '{' in line and '}' in line:
labels_str = line[line.index('{')+1:line.index('}')]
for label in labels_str.split(','):
key, value = [part.strip() for part in label.split('=', 1)]
labels[key] = value.strip('"')
return labels
def parse_metric_line(line):
"""
Parse a single metric line
"""
if '{' in line:
name_part = line.split('{')[0]
value_part = line.split('}')[1].strip()
else:
name_part, value_part = line.split(' ', 1)
return (
name_part.strip(),
parse_labels(line),
float(value_part)
)
for line in metrics_raw.splitlines():
line = line.strip()
if not line:
continue
if line.startswith('# HELP'):
parts = line.split(' ', 3)
if len(parts) > 3:
metric_name, help_text = parts[2], parts[3]
ensure_metric_exists(metric_name)
formatted_metrics_dict[metric_name]['help'] = help_text
elif line.startswith('# TYPE'):
parts = line.split(' ')
if len(parts) > 3:
metric_name, metric_type = parts[2], parts[3]
ensure_metric_exists(metric_name)
formatted_metrics_dict[metric_name]['type'] = metric_type
elif not line.startswith('#'):
# handle metric data
parsed_data = parse_metric_line(line)
if parsed_data:
metric_name, labels, value = parsed_data
ensure_metric_exists(metric_name)
formatted_metrics_dict[metric_name]['data_points'].append({
'labels': labels,
'value': value
})
# check data
result = []
for metric in formatted_metrics_dict.values():
if metric['name'] and metric['type']:
result.append(metric)
return result
class SystemMetricsView(APIView):
authentication_classes = (TokenAuthentication, SessionAuthentication)
throttle_classes = (UserRateThrottle,)
permission_classes = (IsAdminUser,)
def get(self, request):
if not request.user.admin_permissions.can_view_statistic():
return api_error(status.HTTP_403_FORBIDDEN, 'Permission denied.')
try:
res = get_seafevents_metrics()
metrics_raw = res.content.decode('utf-8')
metrics_data = parse_prometheus_metrics(metrics_raw)
except Exception as e:
logger.error(e)
error_msg = 'Internal Server Error'
return api_error(status.HTTP_500_INTERNAL_SERVER_ERROR, error_msg)
return Response({ 'metrics': metrics_data })