-------------------------------------------------------------------------------
 Optional package: OPT_TIMELOG     TimeLog v0.7     04.01.2005
-------------------------------------------------------------------------------

TimeLog wertet die Logdatei von Imond aus und laesst den User so seine Verbindungsdaten
bequem ueber den Mini-HTTPD analysieren. Ausserdem wird der von Imond mitgeloggte Traffic
ausgewertet. Verschiedene ISDN-Circuits werden auch beachtet und koennen unabhaengig
ausgewertet werden. TimeLog richtet sich damit primaer an ISDN-Nutzer ohne Flatrate, aber
auch an DSL-Nutzer, die keinen Flatrate- oder Volumentarif haben. Es sind auch grafische Auswertungen
in Form von einfachen Diagrammen moeglich, fuer einen Monat oder ein ganzes Jahr. Dabei zu beachten ist aber,
dass dadurch ein erheblicher Rechenaufwand auf dem Router entsteht, und je nach Rechenleistung des Routers,
die Ausgabe relativ lange dauern kann.
Dieses OPT sollte unter allen Fli4l-Version ab Version 2.0 laufen.

Anzeige
-------
Die Anzeige kann ueber
 - einen Browser (bei installiertem Mini-Webserver httpd)
 - auf der Konsole (mit timelog.sh)
 - ueber SSHD (mit timelog.sh)
 - und auf einem LCD-Display erfolgen.


Installation
------------
Wie gewohnt mit Pfadangaben ins fli4l Hauptverzeichnis entpacken.
Wenn gefragt wird, ob opt/files/usr/local/bin/bc ueberschrieben werden soll, kann ja gesagt werden.
Ich verwende die Version aus dem OPT_accounting, wer unsicher ist, kann auch mit nein antworten,
dann bleibt die bestehende Version von bc erhalten.
Die Konfigurationsdatei config/timelog.txt anpassen:


OPT_TIMELOG       - 'yes' oder 'no', default 'no'
->installiert OPT_TIMELOG

TIMELOG_AUTO       - 'yes' oder 'no', default 'yes'
->berechnet die Verbindungsdaten nach dem Auflegen neu (empfohlen).
Wenn man hier 'no' sagt, muss man nach jeder Online-Verbindung die Daten "per Hand"
(entweder ueber SSH und dem Befehl "timelog-calc.sh" oder ueber den Mini-HTTPD) neu berechnen.

TIMELOG_CIRCUIT       - 'circuit-nummer' oder '0' fuer Alle Circuits
->Waehlt den Standard-Circuit aus, fuer den die Daten im Webinterface und auf dem LCD angezeigt
werden sollen, wenn nichts anderes gewaehlt wird (es ist die Circuit-Nummer anzugeben, bei DSL
sollte immer 0 oder 1 dastehen, zum. solange es nur einen DSL-Circuit gibt).

TIMELOG_LCD       - 'yes' oder 'no', default 'yes'
->Schreibt die Onlinezeit des aktuellen Tags in /etc/lcd_text4.txt.
Nur sinnvoll, wenn man ein LCD angeschlossen und konfiguriert hat.
In der Datei config/lcd.txt muss man dann den Wert ueber die Nummer 43 abfragen.

TIMELOG_RELOAD       - Zeit (1-...), default '600'
->Reload-Zeit fuer das Webinterface in Sekunden(!)

TIMELOG_DO_TRAFFIC       - 'yes' oder 'no', default 'yes'
->Mit dieser Option werden auch die von Imond mitgeloggten Traffic-Werte ausgewertet.
Diese Option nur aktivieren, wenn Du entweder ein schnellen Router hast, oder die Werte
wirklich brauchst. Die Auswertung dauert sehr lange, vor allen Dingen in der Monatsanzeige
(auf meinem P133 einige Sekunden). Es gibt dafuer wesentlich bessere OPTs, z.B.
OPT_accounting oder OPT_TrafficLog, die dann den Traffic auch noch nach Hosts u.a. filtern koennen.

TIMELOG_DO_DEBUG       - 'yes' oder 'no', default 'no'
->Gibt beim Start zusaetzliche Debug-Angaben aus, nicht fuer den normalen Betrieb noetig.

Danach den Router updaten und natuerlich neustarten.


Voraussetzungen
---------------
TimeLog benoetigt je nach Konfiguration weitere optionale Pakete:

- In jedem Fall wird Imond (damit auch OPT_ISDN oder OPT_DSL) benoetigt
  Ausserdem muss das Logging des Imond aktiviert sein
  (s. IMOND_LOG='yes' in der config/base.txt)
  
- Empfohlen wird 'sort' aus OPT_TOOLS, damit geht die Berechnung der
  Verbindungsdaten etwas zuegiger, aber es ist nicht zwingend erfoderlich.
  
- Zum Darstellen der Daten im Browser, den Mini-Webserver httpd:
  OPT_HTTPD      http://www.fli4l.de/

- Zum Darstellen der Onlinezeit des aktuellen Tags auf einem LCD:
  OPT_LCD      http://www.fli4l.de/


Mini-FAQ
--------

Q: Wie kann ich meine Verbindungsdaten dauerhaft speichern?
A: Wichtig ist, dass die Imond.log gesichert wird. Dazu in der
   config/base.txt die Variable IMOND_LOGDIR bei einer Disketteninstalltion
   z.B. auf '/boot' setzen, dann wird die Logdatei auf die Diskette geschrieben,
   oder bei einer Festplatteninstalltion dort einen Pfad waehlen, der auf der Festplatte
   liegt, sonst sind nach jedem Router-Neustart alle Verbindungsdaten weg.

Q: Wie kann ich die Verbindungsdaten zuruecksetzen?
A: Da gibt es zwei Moeglichkeiten:
   a) entweder per Hand die imond.log loeschen oder
   b) im Mini-HTTPD unter "Connections" ganz unten auf "RESET" klicken.

Q: Wie lautet der Befehl zur Anzeige ueber Telnet oder SSH?
A: timelog.sh, die genaue Benutzung des Befehls erfaehrt man durch Aufrufen ohne Argumente.

Q: Ich habe teilweise am Tag mehr als 24h Online-Zeit, wie kann das sein?
A: Das passiert genau dann, wenn eine Verbindung die Datumsgrenze ueberschreitet.
   Imond loggt dann die Verbindung komplett zum vorherigen Tag. D.h. der Tag, der
   mehr als 24h Online-Zeit hat, beinhaltet noch Onlinezeit vom naechsten Tag.


Bekannte Fehler:
----------------
- In der Tagesansicht(Daten & Grafik) kann es vorkommen, dass eine Verbindung, die die Datumsgrenze
  ueberschritten hat, an beiden Tagen aufgelistet wird. (gefixt?)
- Im Januar hat der letzte Monat immer 0-Werte.
- In der Tagesansicht stimmen die Traffic-Werte nicht

==========================================================================
Grosser Dank geht an Michael Wenger, der mir sehr bei dem Parsen der Imond-Logdatei
geholfen hat(sed und regulaere Ausdruecke).
Ausserdem danke ich Frank Lanitz (fraehngk@gmx.net), der mir bei einigen Scripten
geholfen hat, und fleissiger Tester ist.
==========================================================================
Die Veroeffentlichung dieses Programms erfolgt OHNE IRGENDEINE GARANTIE, sogar ohne
die implizite Garantie der MARKTREIFE oder der VERWENDBARKEIT FUER EINEN BESTIMMTEN
ZWECK.
==========================================================================
Enrico Troeger                 troeger@fh-coburg.de
http://mysite.fh-coburg.de/~troeger/fli4l/
-----------------------------------------------------------------------------------
