From da9aaf69df4afb0d3cbabcd1ff745ab3c2301654 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Mon, 5 Oct 2020 22:09:57 +0200 Subject: [PATCH] admin: add metrics and charts --- passbook/admin/api/overview_metrics.py | 80 ++++++++ .../templates/administration/overview.html | 184 +++++++++++------- passbook/admin/views/overview.py | 27 ++- passbook/api/v2/urls.py | 2 + passbook/providers/oauth2/views/authorize.py | 6 + passbook/static/static/package-lock.json | 18 +- passbook/static/static/package.json | 1 + swagger.yaml | 26 +++ 8 files changed, 258 insertions(+), 86 deletions(-) create mode 100644 passbook/admin/api/overview_metrics.py diff --git a/passbook/admin/api/overview_metrics.py b/passbook/admin/api/overview_metrics.py new file mode 100644 index 000000000..07b8c1beb --- /dev/null +++ b/passbook/admin/api/overview_metrics.py @@ -0,0 +1,80 @@ +"""passbook administration overview""" +import time +from collections import Counter +from datetime import timedelta +from typing import Dict, List + +from django.db.models import Count, ExpressionWrapper, F +from django.db.models.fields import DurationField +from django.db.models.functions import ExtractHour +from django.http import response +from django.utils.timezone import now +from drf_yasg.utils import swagger_auto_schema +from rest_framework.fields import SerializerMethodField +from rest_framework.permissions import IsAdminUser +from rest_framework.request import Request +from rest_framework.response import Response +from rest_framework.serializers import Serializer +from rest_framework.viewsets import ViewSet + +from passbook.audit.models import Event, EventAction + + +class AdministrationMetricsSerializer(Serializer): + """Overview View""" + + logins_per_1h = SerializerMethodField() + logins_failed_per_1h = SerializerMethodField() + + def get_events_per_1h(self, action: str) -> List[Dict[str, int]]: + """Get event count by hour in the last day, fill with zeros""" + date_from = now() - timedelta(days=1) + result = ( + Event.objects.filter(action=action, created__gte=date_from) + .annotate( + age=ExpressionWrapper( + now() - F("created"), output_field=DurationField() + ) + ) + .annotate(age_hours=ExtractHour("age")) + .values("age_hours") + .annotate(count=Count("pk")) + .order_by("age_hours") + ) + data = Counter({d["age_hours"]: d["count"] for d in result}) + results = [] + _now = now() + for hour in range(0, -24, -1): + results.append( + { + "x": time.mktime((_now + timedelta(hours=hour)).timetuple()) * 1000, + "y": data[hour * -1], + } + ) + return results + + def get_logins_per_1h(self, _): + """Get successful logins per hour for the last 24 hours""" + return self.get_events_per_1h(EventAction.LOGIN) + + def get_logins_failed_per_1h(self, _): + """Get failed logins per hour for the last 24 hours""" + return self.get_events_per_1h(EventAction.LOGIN_FAILED) + + def create(self, request: Request) -> response: + raise NotImplementedError + + def update(self, request: Request) -> Response: + raise NotImplementedError + + +class AdministrationMetricsViewSet(ViewSet): + """Return single instance of AdministrationMetricsSerializer""" + + permission_classes = [IsAdminUser] + + @swagger_auto_schema(responses={200: AdministrationMetricsSerializer(many=True)}) + def list(self, request: Request) -> Response: + """Return single instance of AdministrationMetricsSerializer""" + serializer = AdministrationMetricsSerializer(True) + return Response(serializer.data) diff --git a/passbook/admin/templates/administration/overview.html b/passbook/admin/templates/administration/overview.html index e1d6a6b58..1004acd8a 100644 --- a/passbook/admin/templates/administration/overview.html +++ b/passbook/admin/templates/administration/overview.html @@ -1,6 +1,7 @@ {% extends "administration/base.html" %} {% load i18n %} +{% load static %} {% block content %}
@@ -10,33 +11,51 @@
- +
- {% trans 'Applications' %} + {% trans 'Logins over the last 24 hours' %} +
+
+
+ +
+
+
+
+
+ {% trans 'Apps with most usage' %}
-

- {{ application_count }} -

+ + + + + + + + + + {% for app in most_used_applications %} + + + + + + {% endfor %} + +
{% trans 'Application' %}{% trans 'Logins' %}
+ {{ app.application.name }} + + {{ app.total_logins }} + + +
- +
- -
-
- {% trans 'Sources' %} -
-
-
-

- {{ source_count }} -

-
- - - +
{% trans 'Providers' %} @@ -54,42 +73,9 @@

{% endif %}
- +
- -
-
- {% trans 'Stages' %} -
-
-
- {% if stage_count < 1 %} -

- {{ stage_count }} -

-

{% trans 'No Stages configured. No Users will be able to login.' %}">

- {% else %} -

- {{ stage_count }} -

- {% endif %} -
- - - -
-
- {% trans 'Flows' %} -
-
-
-

- {{ flow_count }} -

-
- - - +
{% trans 'Policies' %} @@ -107,22 +93,9 @@

{% endif %}
- +
- -
-
- {% trans 'Invitation' %} -
-
-
-

- {{ invitation_count }} -

-
- - - +
{% trans 'Users' %} @@ -133,9 +106,9 @@ {{ user_count }}

- +
-
+
{% trans 'Version' %} @@ -161,7 +134,7 @@
-
+
{% trans 'Workers' %} @@ -189,7 +162,7 @@
- +
{% trans 'Cached Policies' %} @@ -209,7 +182,7 @@
-
+
{% trans 'Cached Flows' %} @@ -262,4 +235,65 @@
+ + + + {% endblock %} diff --git a/passbook/admin/views/overview.py b/passbook/admin/views/overview.py index 08acc6a6b..7a9d41e50 100644 --- a/passbook/admin/views/overview.py +++ b/passbook/admin/views/overview.py @@ -3,6 +3,8 @@ from typing import Union from django.conf import settings from django.core.cache import cache +from django.db.models import Count +from django.db.models.fields.json import KeyTextTransform from django.shortcuts import redirect, reverse from django.views.generic import TemplateView from packaging.version import LegacyVersion, Version, parse @@ -10,10 +12,9 @@ from packaging.version import LegacyVersion, Version, parse from passbook import __version__ from passbook.admin.mixins import AdminRequiredMixin from passbook.admin.tasks import VERSION_CACHE_KEY, update_latest_version -from passbook.core.models import Application, Provider, Source, User -from passbook.flows.models import Flow, Stage +from passbook.audit.models import Event, EventAction +from passbook.core.models import Provider, User from passbook.policies.models import Policy -from passbook.stages.invitation.models import Invitation class AdministrationOverviewView(AdminRequiredMixin, TemplateView): @@ -37,17 +38,27 @@ class AdministrationOverviewView(AdminRequiredMixin, TemplateView): return parse(__version__) return parse(version_in_cache) + def get_most_used_applications(self): + """Get Most used applications, total login counts and unique users that have used them.""" + return ( + Event.objects.filter(action=EventAction.AUTHORIZE_APPLICATION) + .exclude(context__authorized_application=None) + .annotate(application=KeyTextTransform("authorized_application", "context")) + .annotate(user_pk=KeyTextTransform("pk", "user")) + .values("application") + .annotate(total_logins=Count("application")) + .annotate(unique_users=Count("user_pk", distinct=True)) + .values("unique_users", "application", "total_logins") + .order_by("-total_logins")[:15] + ) + def get_context_data(self, **kwargs): - kwargs["application_count"] = len(Application.objects.all()) kwargs["policy_count"] = len(Policy.objects.all()) kwargs["user_count"] = len(User.objects.all()) - 1 # Remove anonymous user kwargs["provider_count"] = len(Provider.objects.all()) - kwargs["source_count"] = len(Source.objects.all()) - kwargs["stage_count"] = len(Stage.objects.all()) - kwargs["flow_count"] = len(Flow.objects.all()) - kwargs["invitation_count"] = len(Invitation.objects.all()) kwargs["version"] = parse(__version__) kwargs["version_latest"] = self.get_latest_version() + kwargs["most_used_applications"] = self.get_most_used_applications() kwargs["providers_without_application"] = Provider.objects.filter( application=None ) diff --git a/passbook/api/v2/urls.py b/passbook/api/v2/urls.py index b0d1d5a53..7785a0ccc 100644 --- a/passbook/api/v2/urls.py +++ b/passbook/api/v2/urls.py @@ -5,6 +5,7 @@ from drf_yasg.views import get_schema_view from rest_framework import routers from passbook.admin.api.overview import AdministrationOverviewViewSet +from passbook.admin.api.overview_metrics import AdministrationMetricsViewSet from passbook.api.permissions import CustomObjectPermissions from passbook.api.v2.messages import MessagesViewSet from passbook.audit.api import EventViewSet @@ -55,6 +56,7 @@ router.register("root/messages", MessagesViewSet, basename="messages") router.register( "admin/overview", AdministrationOverviewViewSet, basename="admin_overview" ) +router.register("admin/metrics", AdministrationMetricsViewSet, basename="admin_metrics") router.register("core/applications", ApplicationViewSet) router.register("core/groups", GroupViewSet) diff --git a/passbook/providers/oauth2/views/authorize.py b/passbook/providers/oauth2/views/authorize.py index 21f6d3fa5..312864d4e 100644 --- a/passbook/providers/oauth2/views/authorize.py +++ b/passbook/providers/oauth2/views/authorize.py @@ -10,6 +10,7 @@ from django.utils import timezone from django.views import View from structlog import get_logger +from passbook.audit.models import Event, EventAction from passbook.core.models import Application from passbook.flows.models import in_memory_stage from passbook.flows.planner import ( @@ -226,6 +227,11 @@ class OAuthFulfillmentStage(StageView): "consent_required", self.params.grant_type, ) + Event.new( + EventAction.AUTHORIZE_APPLICATION, + authorized_application=application, + flow=self.executor.plan.flow_pk, + ).from_http(self.request) return redirect(self.create_response_uri()) except (ClientIdError, RedirectUriError) as error: self.executor.stage_invalid() diff --git a/passbook/static/static/package-lock.json b/passbook/static/static/package-lock.json index 8daa213fb..3e2b700d7 100644 --- a/passbook/static/static/package-lock.json +++ b/passbook/static/static/package-lock.json @@ -167,6 +167,15 @@ "supports-color": "^5.3.0" } }, + "chart.js": { + "version": "2.9.3", + "resolved": "https://registry.npmjs.org/chart.js/-/chart.js-2.9.3.tgz", + "integrity": "sha512-+2jlOobSk52c1VU6fzkh3UwqHMdSlgH1xFv9FKMqHiNCpXsGPQa/+81AFa+i3jZ253Mq9aAycPwDjnn1XbRNNw==", + "requires": { + "chartjs-color": "^2.1.0", + "moment": "^2.10.2" + } + }, "clean-css": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/clean-css/-/clean-css-4.2.3.tgz", @@ -185,7 +194,6 @@ "version": "1.9.3", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", - "dev": true, "requires": { "color-name": "1.1.3" } @@ -193,8 +201,7 @@ "color-name": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", - "dev": true + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=" }, "commander": { "version": "2.20.3", @@ -349,6 +356,11 @@ "parse-literals": "^1.2.0" } }, + "moment": { + "version": "2.29.0", + "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.0.tgz", + "integrity": "sha512-z6IJ5HXYiuxvFTI6eiQ9dm77uE0gyy1yXNApVHqTcnIKfY9tIwEjlzsZ6u1LQXvVgKeTnv9Xm7NDvJ7lso3MtA==" + }, "no-case": { "version": "2.3.2", "resolved": "https://registry.npmjs.org/no-case/-/no-case-2.3.2.tgz", diff --git a/passbook/static/static/package.json b/passbook/static/static/package.json index b3ae9a484..551f79c8d 100644 --- a/passbook/static/static/package.json +++ b/passbook/static/static/package.json @@ -7,6 +7,7 @@ "dependencies": { "@fortawesome/fontawesome-free": "^5.15.0", "@patternfly/patternfly": "^4.42.2", + "chart.js": "^2.9.3", "codemirror": "^5.58.1", "lit-element": "^2.4.0", "lit-html": "^1.3.0", diff --git a/swagger.yaml b/swagger.yaml index f6348ca0a..ee0dcd8af 100755 --- a/swagger.yaml +++ b/swagger.yaml @@ -19,6 +19,21 @@ securityDefinitions: security: - token: [] paths: + /admin/metrics/: + get: + operationId: admin_metrics_list + description: Return single instance of AdministrationMetricsSerializer + parameters: [] + responses: + '200': + description: '' + schema: + type: array + items: + $ref: '#/definitions/AdministrationMetrics' + tags: + - admin + parameters: [] /admin/overview/: get: operationId: admin_overview_list @@ -5958,6 +5973,17 @@ paths: type: string format: uuid definitions: + AdministrationMetrics: + type: object + properties: + logins_per_1h: + title: Logins per 1h + type: string + readOnly: true + logins_failed_per_1h: + title: Logins failed per 1h + type: string + readOnly: true AdministrationOverview: type: object properties: