doc/INSTALL.fcgi

   1
   2 Diese Datei ist in Plain Old Documentation geschrieben. Mit
   3
   4 > perldoc INSTALL.fcgi
   5
   6 ist sie deutlich leichter zu lesen.
   7
   8 =head1 FastCGI für Lx-Office
   9
  10 =head2 Was ist FastCGI?
  11
  12 Direkt aus L<http://de.wikipedia.org/wiki/FastCGI> kopiert:
  13
  14   FastCGI ist ein Standard für die Einbindung externer Software zur Generierung
  15   dynamischer Webseiten in einem Webserver. FastCGI ist vergleichbar zum Common
  16   Gateway Interface (CGI), wurde jedoch entwickelt, um dessen
  17   Performance-Probleme zu umgehen.
  18
  19
  20 =head2 Warum FastCGI?
  21
  22 Perl Programme (wie Lx-Office eines ist) werden nicht statisch kompiliert.
  23 Stattdessen werden die Quelldateien bei jedem Start übersetzt, was bei kurzen
  24 Laufzeiten einen Großteil der Laufzeit ausmacht. Während SQL Ledger einen
  25 Großteil der Funktionalität in einzelne Module kapselt, um immer nur einen
  26 kleinen Teil laden zu müssen, ist die Funktionalität von Lx-Office soweit
  27 gewachsen, dass immer mehr Module auf den Rest des Programms zugreifen.
  28 Zusätzlich benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
  29 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies führt dazu dass
  30 ein Lx-Office Aufruf der Kernmasken mittlerweile deutlich länger dauert als
  31 früher, und dass davon 90% für das Laden der Module verwendet wird.
  32
  33 Mit FastCGI werden nun die Module einmal geladen, und danach wird nur die
  34 eigentliche Programmlogik ausgeführt.
  35
  36 =head2 Kombinationen aus Webservern und Plugin.
  37
  38 Folgende Kombinationen sind getestet:
  39
  40  * Apache 2.2.11 (Ubuntu) und mod_fastcgi.
  41
  42 Folgende Kombinationen funktionieren nicht:
  43
  44  * Apache 2.2.11 (Ubuntu) + mod_fcgid:
  45
  46
  47
  48 =head2 Konfiguration des Webservers.
  49
  50 Variante 1:
  51
  52   AddHandler fastcgi-script .pl
  53
  54 Variante 2:
  55
  56   AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
  57
  58   <Directory /path/to/lx-office-erp>
  59     AllowOverride All
  60     AddHandler fastcgi-script .fpl
  61     Options ExecCGI Includes FollowSymlinks
  62     Order Allow,Deny
  63     Allow from All
  64   </Directory>
  65
  66   <DirectoryMatch //.*/users>
  67     Order Deny,Allow
  68     Deny from All
  69   </DirectoryMatch>
  70
  71
  72 Variante 1 startet einfach jeden Lx-Office Request als fcgi Prozess. Für sehr
  73 große Installationen ist das die schnellste Version, benötigt aber sehr viel
  74 Arbeitspseicher (ca. 2GB).
  75
  76 Variante 2 startet nur einen zentralen Dispatcher und lenkt alle Scripte auf
  77 diesen. Dadurch dass zur Laufzeit öfter mal Scripte neu geladen werden gibt es
  78 hier kleine Performance Einbußen.
  79
  80
  81 =head2 Entwicklungsaspekte
  82
  83 Die AddHandler Direktive vom Apache ist entgegen der Dokumentation
  84 anscheinend nicht lokal auf das Verzeichnis beschränkt sondern global im
  85 vhost.
  86
  87 Wenn Änderungen in der Konfiguration von Lx-Office gemacht werden, oder wenn
  88 Templates editiert werden muss der Server neu gestartet werden.
  89
  90 Es ist möglich die gleiche Lx-Office Version parallel unter cgi und fastcgi zu
  91 betreiben. Da nimmt man Variante 2 wie oben beschrieben, und ändert die
  92 MatchAlias Zeile auf eine andere URL, und lässt alle anderen URLs auch
  93 weiterleiten:
  94
  95
  96   AliasMatch ^/web/path/to/lx-office-erp-fcgi/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
  97   AliasMatch ^/web/path/to/lx-office-erp-fcgi/(.*) /path/to/lx-office-erp/$1
  98
  99 Dann ist unter C</web/path/to/lx-office-erp/> die normale Version erreichbar,
 100 und unter C</web/opath/to/lx-office-erp-fcgi/> die FastCGI Version.
 101
 102 Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu achten. Dadurch
 103 dass das Programm in einer Endlosschleife läuft, müssen folgende Aspekte
 104 geachtet werden:
 105
 106 =head3 C<warn>, C<die>, C<exit>, C<carp>, C<confess>
 107
 108 Fehler die normalerweise dass Programm sofort beenden (fatale Fehler) werden
 109 mit dem FastCGI Dispatcher abgefangen, um das Programm amLaufen zu halten. Man
 110 kann mit C<die>, C<confess> oder C<carp> Fehler ausgeben, die dann vom Dispatcher
 111 angezeigt werden. Die Lx-Office eigene C<$::form->error()> tut im Prinzip das
 112 Gleiche, mit ein paar Extraoptionen. C<warn> und C<exit> hingegen werden nicht
 113 abgefangen. C<warn> wird direkt nach STDERR, also in Server Log eine Nachricht
 114 schreiben, und C<exit> wird die Ausführung beenden.
 115
 116 Prinzipiell ist es ein Beinbruch, wenn sich der Prozess beendet, fcgi wird ihn
 117 sofort neu starten, allerdings sollte das die Ausnahme sein. Quintessenz: Bitte
 118 kein C<warn> oder C<exit> benutzen, alle anderen Excepionmechanismen sind ok.
 119
 120 =head3 Globale Variablen
 121
 122 Um zu vermeiden, dass Informationen von einem Request in einen anderen gelangen
 123 müssen alle globalen Variablen vor einem Request sauber initialisiert werden.
 124 Das ist besonders wichtig im C<$::cgi> und C<$::auth> Objekt, weil diese nicht
 125 gelöscht werden pro Instanz, sondern persistent gehalten werden.
 126
 127 Datenbankverbindungen wird noch ein Guide verfasst werden, wie man sichergeht,
 128 dass man die richtige erwischt.
 129
 130 =head2 Performance und Statistiken
 131
 132 Die kritischen Pfade des Programms sind die Belegmasken, und unter diesen ganz
 133 besonders die Verkaufsrechnungsmaske. Ein Aufruf der Rechnungsmaske in
 134 Lx-Office 2.4.3 stable dauert auf einem Core2duo mit 2GB Arbeitsspeicher und
 135 Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0 sind es je nach Menge der
 136 definierten Variablen 1-2s. Ab der Moose/Rose::DB Version sind es 5-6s.
 137
 138 Mit FastCGI ist die neuste Version auf 0,4 Sekunden selbst in den kritischen
 139 Pfaden, unter 0,15 sonst.
 140
 141 =head2 Bekannte Probleme
 142
 143 Bei mehreren Benutzern scheint ab und zu eine Datenbankverbidung von Rose::DB
 144 in den falschen Benutzer zu geraten. Das ist ein kritischer Bug und muss gefixt
 145 werden.
 146
 147 Bei Administrativen Tätigkeiten werden in seltenen Fällen die Locales nicht
 148 richtig geladen und die Maske erscheint in Englisch.