plotly logs example

logs.urls.py

"""Gestion des URLs pour la gestion des logs des (hardware-id, product_name).

- https://gdevops.gitlab.io/tuto_django/tutos/hacksoft/hacksoft.html#urls

"""
from django.urls import path, re_path
from . import views

app_name = "logs"

urlpatterns = [
    path("plot_program/", views.PlotProgram.as_view(), name="plot_program",),
    path(
        "plot_all_programs/", views.PlotAllPrograms.as_view(), name="plot_all_programs",
    ),
    path(
        "plot_program/<str:product_name>/",
        views.PlotProgram.as_view(),
        name="plot_program_name",
    ),
]

logs.plots.py

"""
logs.plots.py


- https://plot.ly/python/pie-charts

Traduction de pie chart
=========================

- https://www.linguee.fr/anglais-francais/traduction/pie+chart.html

:pie chart:
    diagramme circulaire
    graphique circuliare
    graphique sectoriel
    diagramme en camenbert


"""
import logging
from typing import List

import numpy as np
import pendulum
import plotly.graph_objs as go
from logs.models import LogHardwareId
from logs.models import StatsProductName
from logs.models import StatsProductNameVersion
from plotly.offline import plot
from plotly.subplots import make_subplots
from programs.models import Program

logger = logging.getLogger(__name__)


def plot_program(product_name: str = "id3 Notaria Autenticacion") -> plot:
    """
    - https://plot.ly/python/pie-charts/#pie-charts-in-subplots
    """
    logs_hardware = LogHardwareId.objects.filter(
        product_name=product_name,
    ).order_by("product_name", "-version")

    nb_total_users = logs_hardware.count()

    # définition de l'ensemble des versions
    set_versions = set()
    for log in logs_hardware:
        set_versions.add(log.version)

    # Exemple: ["2.7.1", "2.6.1"]
    labels_versions = list(set_versions)
    nb_versions = len(labels_versions)

    # calcul du nombre de hardware-id utilisant cette version
    values_versions = []
    for version in labels_versions:
        total_version = logs_hardware.filter(version=version).count()
        values_versions.append(total_version)

    # on concatène aux labels le nombre d'occurrences et le pourcentage
    for i, total_version in enumerate(values_versions):
        p = total_version / nb_total_users
        labels_versions[
            i
        ] = f"version {labels_versions[i]} ({str(total_version)} users => {p:.1%})"

    fig = go.Figure(
        data=[go.Pie(labels=labels_versions, values=values_versions, name=product_name)]
    )
    # fig.update_traces(hole=0.4, hoverinfo="label+value+name")
    fig.update_traces(hole=0.4, hoverinfo="label")
    if nb_versions <= 1:
        str_nb_versions = f"{nb_versions} version"
    else:
        str_nb_versions = f"{nb_versions} versions"

    if nb_total_users > 0:
        title_text = f"{str_nb_versions} for {product_name} ({nb_total_users} users)"
    else:
        now = pendulum.now()
        title_text = (
            f"{str_nb_versions} for {product_name} (not used at the moment "
            f"{now.year}-{now.month:02}-{now.day:02} {now.hour:02}H{now.minute:02})"
        )

    fig.update_layout(
        title_text=title_text,
    )
    plot_div = plot(fig, output_type="div", include_plotlyjs=False)
    return plot_div


def plot_all_programs() -> List[plot]:
    """Returns all the program plots"""
    plots = []
    for product_name in (
        Program.objects.filter(version_is_ready=True)
        .values_list("product_name", flat=True)
        .distinct()
    ):
        plot = plot_program(product_name)
        plots.append(plot)

    return plots

logs.models.py

"""Logs des requetes sur getLastProductVersion.

"""
import logging
from dataclasses import dataclass
from dataclasses import field
from typing import List

import arrow
import django
from dateutil import tz
from django.db import connection
from django.db import models
from django.urls import reverse
from django.utils import timezone
from django.utils.translation import ugettext as _
from programs.models import Program

# http://crsmithdev.com/arrow/
# https://labix.org/python-dateutil
# https://docs.djangoproject.com/en/dev/topics/db/sql/
# https://docs.djangoproject.com/en/dev/topics/class-based-views/generic-editing/

# Get an instance of a logger
logger = logging.getLogger(__name__)


@dataclass
class StatsProductNameVersion:
    product_name: str
    version: str = ""
    nb_logs: int = 0
    stats_product_name: "StatsProductName" = None

    @property
    def percent_logs(self):
        percent = ""
        p = self.nb_logs / self.stats_product_name.nb_total_logs
        percent = f"({p:.2%})"
        return percent


@dataclass
class StatsProductName:
    product_name: str
    nb_total_logs: int = 0
    versions: List[StatsProductNameVersion] = field(default_factory=list)


class LogHardwareId(models.Model):
    """Description des logs à partir du hardware-id.

        http -b "localhost:8005/programs/getLastProductVersion/?product_name=id3 Notaria Autenticacion&version__gt=2.4.0&culture=es-CO&hardware_id=35ESDNN-486MAB5-4F3FWCJ-E5N8E02" 'Authorization: Token c62a063ef406c807f89b5e22706e0ad5de443442'

    On logge les informations suivantes lorsqu'une requete arrive sur getLastProductVersion

    - hardware_id
    - product_name
    - date de la requete
    - programme

    """

    class Meta(object):
        managed = True
        db_table = "log_hardware"
        ordering = ["-date_connexion"]
        verbose_name = _("log hardware id")
        verbose_name_plural = _("Les logs des hardware id")
        # https://docs.djangoproject.com/en/dev/ref/models/constraints/#uniqueconstraint
        constraints = [
            models.UniqueConstraint(
                fields=["hardware_id", "product_name"],
                name="unique_hardware_id_productname",
            )
        ]
        indexes = [
            models.Index(fields=["date_connexion"], name="index_date_connexion"),
            models.Index(fields=["hardware_id"], name="index_hardware_id"),
        ]

    id = models.AutoField(primary_key=True)
    hardware_id = models.CharField(max_length=100, help_text=_("Identifiant du PC"))
    date_connexion = models.DateTimeField(
        help_text=_("Dernière date de connexion"), auto_now_add=True
    )
    product_name = models.CharField(
        max_length=200,
        default="",
        help_text=_("Le nom du programme"),
    )
    version = models.CharField(
        max_length=50,
        default="0.1.0",
        help_text=_("La version du programme. Ex: 0.2.0. Voir http://semver.org/"),
        verbose_name=_("Version"),
    )
    program = models.ForeignKey(
        Program,
        on_delete=models.CASCADE,
        blank=True,
        null=True,
        related_name="programs",
        help_text=_("Le programme"),
    )
    error = models.CharField(
        max_length=200,
        default="",
        blank=True,
        null=True,
        help_text=_("Erreur"),
    )

    def __str__(self):
        """
        Affichage des logs hardware-id + product_name.
        """
        message = f"{self.id=} {self.date_connexion=} {self.product_name=} {self.version=} {self.program=}"
        return message

logs.views.py

"""
logs.views

"""

from django.shortcuts import render
import logging

from django.http import HttpResponse, HttpResponseBadRequest, JsonResponse
from django.views.generic import TemplateView
from . import plots

logger = logging.getLogger(__name__)


class PlotProgram(TemplateView):
    """

    - https://plot.ly/python/pie-charts/#pie-charts-in-subplots

    """

    template_name = "logs/plot.html"

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        product_name = None
        if "product_name" in self.kwargs:
            product_name = self.kwargs["product_name"]
            logger.info(f"PlotPrograms {product_name=}")
            plot = plots.plot_program(product_name)
        else:
            plot = plots.plot_program()

        context["plot"] = plot
        if product_name is None:
            product_name = "i version"
        context["product_name"] = product_name
        return context


class PlotAllPrograms(TemplateView):
    """

    - https://plot.ly/python/pie-charts/#pie-charts-in-subplots

    """

    template_name = "logs/plot_all_programs.html"

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        les_plots = plots.plot_all_programs()
        context["les_plots"] = les_plots
        return context

template

<div class="dropdown-menu" aria-labelledby="navbarDropdown">
  <div class="dropdown-divider"></div>
  {% url 'logs:plot_all_programs' as url_plot_all_programs %}
  <a class="dropdown-item" href="{{ url_plot_all_programs }}">All programs</a>
  <div class="dropdown-divider"></div>
  {% url 'logs:plot_program' as url_plot_program %}
  <a class="dropdown-item" href="{{ url_plot_program }}i version">Program1 version</a>
  <a class="dropdown-item" href="{{ url_plot_program }}i version - alpha">Program1 version PIN</a>
  <div class="dropdown-divider"></div>
  <a class="dropdown-item" href="{{ url_plot_program }}i Firma">Program1 Firma</a>
  <a class="dropdown-item" href="{{ url_plot_program }}i Firma - PIN">Program1 Firma PIN</a>
  <div class="dropdown-divider"></div>
  <a class="dropdown-item" href="{{ url_plot_program }}i Usuarios">Program1 Usuarios</a>
  <a class="dropdown-item" href="{{ url_plot_program }}i Usuarios - PIN">Program1 Usuarios PIN</a>
  <div class="dropdown-divider"></div>
  <a class="dropdown-item" href="{{ url_plot_program }}i Web Services">Program1 Web Services</a>
</div>