Mercurial > p > roundup > code
annotate doc/tracker_templates.txt @ 6565:2c2dbfc332ba
Try to handle multiple connections better.
The session database is a hot spot. When multiple requests (e.g. 20)
come in at the same time session database contention can get great.
The original code didn't retry session database access when the open
failed. This resulted in errors at the client.
The second pass delayed 0.01 seconds and retried. It was better but we
still had multiple second stalls. I think the first request got in,
everybody else backed up and then retried at the same time. Again they
stepped on each other. With logging I would see many counters go all
the way to low single digits or to -1 indicating falure.
This pass uses randomint to generate delays from 0-.125 seconds in 5ms
increments. This performs better in testing. I rarely saw a counter
less than 13 (2 failed retries). Current logging starts after 6
failures and counts down until success or failure.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 16 Dec 2021 20:02:00 -0500 |
| parents | b76be13e027e |
| children | 3f3ce3004013 |
| rev | line source |
|---|---|
|
2133
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1 ========================= |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
2 Roundup Tracker Templates |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 ========================= |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
4 |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
5 The templates distributed with Roundup are stored in the "share" directory |
|
2826
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
6 nominated by Python. On Unix this is typically |
|
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
7 ``/usr/share/roundup/templates/`` (or ``/usr/local/share...``) and |
|
2133
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 on Windows this is ``c:\python22\share\roundup\templates\``. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
10 The template loading looks in four places to find the templates: |
|
2826
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
11 |
|
2133
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 1. *share* - eg. ``<prefix>/share/roundup/templates/*``. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
13 This should be the standard place to find them when Roundup is |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
14 installed. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
15 2. ``<roundup.admin.__file__>/../templates/*``. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
16 This will be used if Roundup's run in the distro (aka. source) |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
17 directory. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
18 3. ``<current working dir>/*``. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
19 This is for when someone unpacks a 3rd-party template. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
20 4. ``<current working dir>``. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
21 This is for someone who "cd"s to the 3rd-party template dir. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
22 |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
23 Templates contain: |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
24 |
|
2826
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
25 - modules ``schema.py`` and ``initial_data.py`` |
|
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
26 - directories ``html``, ``detectors`` and ``extensions`` |
|
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
27 (with appropriate contents) |
|
5762
b76be13e027e
issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents:
4557
diff
changeset
|
28 - optional ``config_ini.ini`` file. It is structured like a tracker's |
|
b76be13e027e
issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents:
4557
diff
changeset
|
29 ``config.ini`` but contains only headers (e.g. ``[main]``) and |
|
b76be13e027e
issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents:
4557
diff
changeset
|
30 *required* parameters that are different from defaults: |
|
b76be13e027e
issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents:
4557
diff
changeset
|
31 e.g. ``template_engine = jinja2`` and ``static_files = |
|
b76be13e027e
issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents:
4557
diff
changeset
|
32 static``. These settings override the default values saved to the |
|
b76be13e027e
issue2551029: Jinja2 template install error.
John Rouillard <rouilj@ieee.org>
parents:
4557
diff
changeset
|
33 tracker's ``config.ini``. |
|
2826
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
34 - template "marker" file ``TEMPLATE-INFO.txt``, which contains |
|
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
35 the name of the template, a description of the template |
|
eb0015a2caa5
template contents description changed to new layout
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2133
diff
changeset
|
36 and its intended audience. |
|
2133
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
37 |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
38 An example TEMPLATE-INFO.txt:: |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
39 |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
40 Name: classic |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
41 Description: This is a generic issue tracker that may be used to track bugs, |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
42 feature requests, project issues or any number of other types |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
43 of issues. Most users of Roundup will find that this template |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
44 suits them, with perhaps a few customisations. |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
45 Intended-For: All first-time Roundup users |
|
f01befe8a7fe
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
46 |
