app/blueprints/metrics/__init__.py

   1 # ContentDB
   2 # Copyright (C) 2020  rubenwardy
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  16
  17 from flask import Blueprint, make_response
  18 from app.models import Package, PackageRelease, db, User, UserRank
  19 from sqlalchemy.sql.expression import func
  20
  21 bp = Blueprint("metrics", __name__)
  22
  23 def generate_metrics(full=False):
  24         def write_single_stat(name, help, type, value):
  25                 fmt = "# HELP {name} {help}\n# TYPE {name} {type}\n{name} {value}\n\n"
  26
  27                 return fmt.format(name=name, help=help, type=type, value=value)
  28
  29         def gen_labels(labels):
  30                 pieces = [key + "=" + str(val) for key, val in labels.items()]
  31                 return (",").join(pieces)
  32
  33
  34         def write_array_stat(name, help, type, data):
  35                 ret = ("# HELP {name} {help}\n# TYPE {name} {type}\n") \
  36                                 .format(name=name, help=help, type=type)
  37
  38                 for entry in data:
  39                         assert(len(entry) == 2)
  40                         ret += ("{name}{{{labels}}} {value}\n") \
  41                                         .format(name=name, labels=gen_labels(entry[0]), value=entry[1])
  42
  43                 return ret + "\n"
  44
  45         downloads_result = db.session.query(func.sum(Package.downloads)).one_or_none()
  46         downloads = 0 if not downloads_result or not downloads_result[0] else downloads_result[0]
  47
  48         packages = Package.query.filter_by(state=PackageState.APPROVED).count()
  49         users = User.query.filter(User.rank != UserRank.NOT_JOINED).count()
  50
  51         ret = ""
  52         ret += write_single_stat("contentdb_packages", "Total packages", "counter", packages)
  53         ret += write_single_stat("contentdb_users", "Number of registered users", "counter", users)
  54         ret += write_single_stat("contentdb_downloads", "Total downloads", "counter", downloads)
  55
  56         if full:
  57                 scores = Package.query.join(User).with_entities(User.username, Package.name, Package.score) \
  58                         .filter(Package.state==PackageState.APPROVED).all()
  59
  60                 ret += write_array_stat("contentdb_package_score", "Package score", "gauge", \
  61                         [({ "author": score[0], "name": score[1] }, score[2])  for score in scores])
  62         else:
  63                 score_result = db.session.query(func.sum(Package.score)).one_or_none()
  64                 score = 0 if not score_result or not score_result[0] else score_result[0]
  65                 ret += write_single_stat("contentdb_score", "Total package score", "gauge", score)
  66
  67         return ret
  68
  69 @bp.route("/metrics")
  70 def metrics():
  71     response = make_response(generate_metrics(), 200)
  72     response.mimetype = "text/plain"
  73     return response