annotate docs/usage/statistics.rst @ 4974:ac7e43325817

docs/usage: rework section on statistics
author Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date Sun, 05 Apr 2015 21:42:26 +0200
parents 4e6dfdb3fa01
children 5ae8e644aa88
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _statistics:
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
4974
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
3 =====================
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
4 Repository statistics
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
5 =====================
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6
4974
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
7 Kallithea has a ``repository statistics`` feature, disabled by default. When
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
8 enabled, the amount of commits per committer is visualized in a timeline. This
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
9 feature can be enabled using the ``Enable statistics`` checkbox on the
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
10 repository ``Settings`` page.
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
11
4974
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
12 The statistics system makes heavy demands on the server resources, so
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
13 in order to keep a balance between usability and performance, statistics are
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
14 cached inside the database and gathered incrementally.
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
15
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
16 When Celery is disabled:
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
17
4974
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
18 On each first visit to the summary page a set of 250 commits are parsed and
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
19 added to the statistics cache. This incremental gathering also happens on each
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
20 visit to the statistics page, until all commits are fetched.
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
21
4974
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
22 Statistics are kept cached until additional commits are added to the
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
23 repository. In such a case Kallithea will only fetch the new commits when
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
24 updating its statistics cache.
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
25
4974
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
26 When Celery is enabled:
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
27
4974
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
28 On the first visit to the summary page, Kallithea will create tasks that will
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
29 execute on Celery workers. These tasks will gather all of the statistics until
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
30 all commits are parsed. Each task parses 250 commits, then launches a new
ac7e43325817 docs/usage: rework section on statistics
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
31 task.