kallithea Files · docs/usage/statistics.rst

Files @ 77aa8e4cd0a2

Branch filter:

Location: kallithea/docs/usage/statistics.rst

77aa8e4cd0a2 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

mads

helpers: very partial support for pygments >= 2.12

setup.py makes it clear that Kallithea only supports "Pygments >= 2.2.0, < 2.8".
Later versions are known to cause minor breakage to tests, and it hasn't been
validated that they don't expose other problems.

Pawel (aka momat) reported a problem with pygments >= 2.12 when subclassing
HtmlFormatter. The wrap outfile parameter has been dropped, and he suggested
this workaround.

The workaround seems safe and backwards compatible and nice to have, but we
still don't recommend or support using Pygments >= 2.8 .

.. _statistics:

=====================
Repository statistics
=====================

Kallithea has a *repository statistics* feature, disabled by default. When
enabled, the amount of commits per committer is visualized in a timeline. This
feature can be enabled using the ``Enable statistics`` checkbox on the
repository ``Settings`` page.

The statistics system makes heavy demands on the server resources, so
in order to keep a balance between usability and performance, statistics are
cached inside the database and gathered incrementally.

When Celery is disabled:

  On each first visit to the summary page a set of 250 commits are parsed and
  added to the statistics cache. This incremental gathering also happens on each
  visit to the statistics page, until all commits are fetched.

  Statistics are kept cached until additional commits are added to the
  repository. In such a case Kallithea will only fetch the new commits when
  updating its statistics cache.

When Celery is enabled:

  On the first visit to the summary page, Kallithea will create tasks that will
  execute on Celery workers. These tasks will gather all of the statistics until
  all commits are parsed. Each task parses 250 commits, then launches a new
  task.