Log - Programmschnittstelle (API)

Log – Protokollierung

	$spooler_log->debug( line )	Debug-Meldung (Level -1)

	$spooler_log->debug1( line )	Debug-Meldung (Level -1)

	$spooler_log->debug2( line )	Debug-Meldung (Level -2)

	$spooler_log->debug3( line )	Debug-Meldung (Level -3)

	$spooler_log->debug4( line )	Debug-Meldung (Level -4)

	$spooler_log->debug5( line )	Debug-Meldung (Level -5)

	$spooler_log->debug6( line )	Debug-Meldung (Level -6)

	$spooler_log->debug7( line )	Debug-Meldung (Level -7)

	$spooler_log->debug8( line )	Debug-Meldung (Level -8)

	$spooler_log->debug9( line )	Debug-Meldung (Level -9)

	$spooler_log->error( line )	Fehlermeldung (Level 1)

String	$spooler_log->filename	Dateiname des Protokolls

	$spooler_log->info( line )	Informationsmeldung (Level 0)

String	$spooler_log->last( level )	Letzte Ausgabe des angegebenen Levels

String	$spooler_log->last_error_line	Die zuletzt mit Level 2 (error) ausgegebene Zeile

	$spooler_log->LetProperty( 'level', int )	Protokollausgaben beschränken
int	$spooler_log->level

	$spooler_log->log( level, line )

	$spooler_log->log_file( path )	Protokolliert den Inhalt der Datei

	$spooler_log->LetProperty( 'mail', Mail )	Im `Mail`-Objekt können Sie Einstellungen zur eMail vornehmen
Mail	$spooler_log->mail

	$spooler_log->LetProperty( 'mail_it', Boolean )	Versand erzwingen

	$spooler_log->LetProperty( 'mail_on_error', Boolean )	Mit Fehler beendete Task verschickt eMail
Boolean	$spooler_log->mail_on_error

	$spooler_log->LetProperty( 'mail_on_process', int )	Task mit spooler_process() verschickt eMail
int	$spooler_log->mail_on_process

	$spooler_log->LetProperty( 'mail_on_success', Boolean )	Erfolgreich gelaufende Task verschickt eMail
Boolean	$spooler_log->mail_on_success

	$spooler_log->LetProperty( 'mail_on_warning', Boolean )	Wenn eine Warnung oder ein Fehler ausgegeben worden ist, wird am Task-Ende eine eMail verschickt
Boolean	$spooler_log->mail_on_warning

	$spooler_log->LetProperty( 'new_filename', String )	Neuer Dateiname fürs Protokoll
String	$spooler_log->new_filename

	$spooler_log->start_new_file()	Nur fürs Hauptprotokoll: Schließt das bisherige und beginnt ein neues Protokoll

	$spooler_log->warn( line )	Warnung (Level 2)

Beispiel

$spooler_log->info( "Something for the Log" );

$spooler_log->LetProperty( 'mail_on_warning', 1 );
$spooler_log->mail->LetProperty( 'from'  , 'scheduler@company.com' );
$spooler_log->mail->LetProperty( 'to     , 'admin@company.com' );
$spooler_log->mail->LetProperty( 'subject, 'ended' );

In einem Job oder im Scheduler-Skript stellt spooler_log die hier beschriebenen Methoden bereit.

eMail-Versand

Am Ende einer Task kann der Scheduler das Task-Protokoll per eMail versenden. In es versendet werden soll, geben diese Eigenschaften an:

Nur das Ende der Task, nicht das Ende einer Auftragsausführung (also spooler_process()) führt zum eMail-Versand. Siehe aber Task.end().

Log.mail stellt ein Mail-Objekt bereit, das die Adressierung übernimmt.

debug

Debug-Meldung (Level -1)

$spooler_log->debug( String line )

Parameter

line

debug1

Debug-Meldung (Level -1)

$spooler_log->debug1( String line )

Parameter

line

debug2

Debug-Meldung (Level -2)

$spooler_log->debug2( String line )

Parameter

line

debug3

Debug-Meldung (Level -3)

$spooler_log->debug3( String line )

Parameter

line

debug4

Debug-Meldung (Level -4)

$spooler_log->debug4( String line )

Parameter

line

debug5

Debug-Meldung (Level -5)

$spooler_log->debug5( String line )

Parameter

line

debug6

Debug-Meldung (Level -6)

$spooler_log->debug6( String line )

Parameter

line

debug7

Debug-Meldung (Level -7)

$spooler_log->debug7( String line )

Parameter

line

debug8

Debug-Meldung (Level -8)

$spooler_log->debug8( String line )

Parameter

line

debug9

Debug-Meldung (Level -9)

$spooler_log->debug9( String line )

Parameter

line

error

Fehlermeldung (Level 1)

$spooler_log->error( String line )

Wenn die Fehlermeldung ins Task-Protokoll (spooler_log) geschrieben wird und nicht <job stop_on_error="no"> eingestellt ist, stoppt der Job nach Ende der Task.

Parameter

line

filename

Dateiname des Protokolls

String

$spooler_log->filename

info

Informationsmeldung (Level 0)

$spooler_log->info( String line )

Parameter

line

last

Letzte Ausgabe des angegebenen Levels

String

$spooler_log->last( int|String level )

Parameter

level

last_error_line

Die zuletzt mit Level 2 (error) ausgegebene Zeile

String

$spooler_log->last_error_line

level

Protokollausgaben beschränken

	$spooler_log->LetProperty( 'level', int )
int	$spooler_log->level

Legt fest, ab welcher Stufe der Job Scheduler Protokollzeilen ausgibt. Jede Protokollzeile ist auf einer der folgenden Stufen: error, warn, info, debug1 bis debug9 (debug1 ist dasselbe wie debug).

Nur Meldungen ab dem Level werden ausgegeben.

Dabei bedeutet die numerische Angabe:

-9 bis -2:	`debug9` bis `debug2`
-1:	`debug`
0:	`info`
1:	`warn`
2:	`error`

Das XML-Element	`<log_level>`	wird damit überschrieben
Die Option	`-log-level`	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `log_level=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `log_level=…`)	wird damit überschrieben

Nur Meldungen ab dem Level werden ausgegeben.

Dabei bedeutet die numerische Angabe:

-9 bis -2:	`debug9` bis `debug2`
-1:	`debug`
0:	`info`
1:	`warn`
2:	`error`

Parameter

int

log

$spooler_log->log( int level, String line )

Parameter

level
line

log_file

Protokolliert den Inhalt der Datei

$spooler_log->log_file( String path )

Protokolliert den Inhalt der Datei mit Level 0 (info). Ein Fehler beim Zugriff auf die Datei wird als Warnung protokolliert.

Bei Ausführung auf einem entfernten Rechner mit <process_class remote_scheduler="…"> wird die Datei vom Dateisystem des Schedulers, nicht der Task, gelesen.

Parameter

path

mail

Im Mail-Objekt können Sie Einstellungen zur eMail vornehmen

	$spooler_log->LetProperty( 'mail', `Mail` )
`Mail`	$spooler_log->mail

Parameter

Mail

Rückgabe

Mail

mail_it

Versand erzwingen

$spooler_log->LetProperty( 'mail_it', Boolean )

Bei true wird das Protokoll bei Task-Ende verschickt unabhängig von den Einstellungen Log.mail_on_error, Log.mail_on_warning, Log.mail_on_success, Log.mail_on_process und Log.mail_on_error.

Parameter

Boolean

mail_on_error

Mit Fehler beendete Task verschickt eMail

	$spooler_log->LetProperty( 'mail_on_error', Boolean )
Boolean	$spooler_log->mail_on_error

Das XML-Element	`<mail_on_error>`	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `mail_on_error=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `mail_on_error=…`)	wird damit überschrieben

Parameter

Boolean

mail_on_process

Task mit spooler_process() verschickt eMail

	$spooler_log->LetProperty( 'mail_on_process', int )
int	$spooler_log->mail_on_process

Veranlasst den Versand des Task-Protokolls, wenn die Task wenigstens die angegebene Anzahl Schritte, also Aufrufe von spooler_process(), ausgeführt hat. Weil Nicht-API-Tasks keine Schritte haben, zählt der Scheduler für sie immer einen Schritt.

Das XML-Element	`<mail_on_process>`	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `mail_on_process=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `mail_on_process=…`)	wird damit überschrieben

Parameter

int

mail_on_success

Erfolgreich gelaufende Task verschickt eMail

	$spooler_log->LetProperty( 'mail_on_success', Boolean )
Boolean	$spooler_log->mail_on_success

Das XML-Element	`<mail_on_success>`	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `mail_on_success=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `mail_on_success=…`)	wird damit überschrieben

Parameter

Boolean

mail_on_warning

Wenn eine Warnung oder ein Fehler ausgegeben worden ist, wird am Task-Ende eine eMail verschickt

	$spooler_log->LetProperty( 'mail_on_warning', Boolean )
Boolean	$spooler_log->mail_on_warning

Das XML-Element	`<mail_on_warning>`	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `mail_on_warning=…`)	wird damit überschrieben

Parameter

Boolean

new_filename

Neuer Dateiname fürs Protokoll

	$spooler_log->LetProperty( 'new_filename', String )
String	$spooler_log->new_filename

Setzt den Dateinamen fürs Protokoll. Wenn das Protokoll geschlossen wird, kopiert der Scheduler es in diese Datei. Die Datei steht dann der Anwendung zur Verfügung.

Parameter

String

start_new_file

Nur fürs Hauptprotokoll: Schließt das bisherige und beginnt ein neues Protokoll

$spooler_log->start_new_file()

warn

Warnung (Level 2)

$spooler_log->warn( String line )

Parameter

line

Software- und Organisations-Service GmbH

Zuletzt geändert von Joacim Zschimmer, 2008-05-26