Wenn Sie in Ihrer Crowd-Installation auf Fehlersuche sind, ist es oft hilfreich die Ebene der Information, die von Ihrem Crowd Server bereitgestellt wird, zu ändern, um mehr Informationen, Nachrichten und Warnungen als sonst zu sehen. Diese Seite beschreibt wie Sie:
- Die Einstellungen anpassen, die Crowds Protokollierung beeinflussen.
- Das Performance-Profiling aktivieren.
Mit aktiviertem Performance-Profiling zeigt Ihre System-Ausgabekonsole Einträge über die Zeit (in Millisekunden), die für jede Crowd-Aktion benötigt wurde. Dies hilft Ihnen bei der Diagnose von Performance-Problemen. Die daraus resultierenden Ausgaben werden groß sein, deshalb sollten Sie es nicht über lange Perioden aktiviert lassen.
Sie können sich ein Beispiel der Performance-Profiling Ausgabe hier ansehen.
Zusammenfassung der Protokollierungsebenen
Crowd verwendet Apaches log4j Protokollierungsdienst. Die Menge an Informationen, die in die Logdatei geschrieben wird, wird von der Protokollierungsebene bestimmt. Den Typ der Nachrichtenausgabe auf der jeweiligen Ebene sehen Sie hier:
| Level | Nachrichtentyp, der in das Log geschrieben wird |
|---|---|
| DEBUG | Wird nur zur Problembehandlung von SSO-Problemen verwendet. Das sind Details auf niedriger Ebene, die die meisten Leute nicht wissen müssen. BEACHTEN SIE: Wegen dieser Einstellung könnten Benutzerpasswörter protokolliert werden. |
| INFO | Informative Nachrichten über das was Crowd tut. Normalerweise nicht interessant. |
| WARN | Warnungen darüber, dass etwas schief gelaufen ist oder andere Nachrichten, die ein Systemadministrator möglicherweise gerne wissen würde. Das sind Zustände, abgesehen von den Fehlermeldungen selbst, die womöglich darauf hindeuten, dass das System suboptimal läuft. |
| ERROR | Sind Indikatoren dafür, dass etwas in Crowd schief gegangen ist. Die Person, die für die Konfiguration von Crowd verantwortlich ist, sollte benachrichtigt werden. |
| FATAL | Sind Indikatoren dafür, dass etwas dermaßen schief gegangen ist, dass sich das System nicht wiederherstellen kann. |
| ALL | Alle möglichen Protokoll-Nachrichten. |
Die Crowd Logdatei finden
Wenn Sie Atlassians Support ein Problem schildern werden Sie möglicherweise um die Zusendung der atlassian-crowd.log Datei gebeten. Der Ablageort dieser Datei variiert je nach Ihrem Crowd Installationstyp. Sie finden die Crowd Logdatei wie unten beschrieben, vorausgesetzt Sie haben den Ablageort der Logdatei nicht geändert.
| Installationstyp | Ablageort der Logdatei |
|---|---|
| Crowds standalone Edition | Crowd 2.0.3 und ältere Versionen: Im Root-Verzeichnis Ihrer Crowd-Applikation, z. B. atlassian-crowd-2.0.0/atlassian-crowd.log Crowd 2.0.4 und neuere Versionen: Im Crowd-Applikation Home Verzeichnis, z. B. Crowd-Home-Directory/logs/atlassian-crowd.log |
| Crowds Standalone als Windows-Service | C:\Windows\system32\atlassian-crowd.log |
| Crowd WAR Edition | Das Verzeichnis, aus welchem Sie den Applikationsserver starten, z. B. apache-tomcat-6.0.16/bin/atlassian-crowd.log |
Die Protokollierungseinstellungen ändern
Sie können die Protokollierungseinstellungen auf zwei verschiedenen Arten ändern:
- Stellen Sie die Protokollierungsebenen bei Runtime via der Administrationskonsole ein, wie unten beschrieben. Ihre Änderungen werden erst beim nächsten Neustart von Crowd wirksam.
- Editieren Sie die Log-Konfigurationsdatei, wie im Abschnitt über die erweiterte Log-Konfiguration unten. Ihre Änderungen werden beim nächsten Start von Crowd wirksam, dies gilt auch für alle nachfolgenden Sitzungen.
Crowd Data Center
Für Crowd Data Center müssen Sie die Log-Einstellungen jedes Knotens ändern.
Konfiguration der Log-Einstellungen und des Performance-Profilings über die Administrationskonsole
Sie können die Konfigurationsdatei direkt editieren, falls notwendig.
Wenn Sie die Log-Einstellungen über die Administrationskonsole ändern, werden die Änderungen nicht in die log4j.properties Datei geschrieben und deshalb bei der nächsten Pausierung von Crowd verworfen. Außerdem können nicht alle Protokollierungseigenschaften über die Administrationskonsole geändert werden. Um die Protokollierung zu konfigurieren, die nicht unten aufgeführt wird oder um die Log-Einstellungen dauerhaft zu ändern, müssen Sie Crowd anhalten und dann die Log-Konfigurationsdatei editieren.
Die "Logging & Profiling" Seite zeigt Ihnen an, ob das Performance-Profiling gerade aktiv oder inaktiv ist und zusätzlich dazu eine Liste aller aktuell definierten Logger. Auf dieser Seite können Sie:
- Das Performance-Profiling aktivieren/deaktivieren.
Mit aktiviertem Performance-Profiling wird Ihre System-Ausgabekonsole jeweils einen Eintrag mit der Dauer (in Millisekunden) für die Fertigstellung jeder Crowd-Aktion anzeigen. Das hilft Ihnen bei der Diagnose von Performance-Problemen. Der daraus resultierende Output wird groß sein, aus diesem Grund sollten Sie es nicht für lange Zeiträume aktiviert lassen.
Sie können sich einen beispielhaften Output des Performance-Profilings hier ansehen. - Legen Sie das Logging-Level für jede Klasse oder jeden Package-Namen fest, oder setzen Sie die Logging-Levels auf die Standardeinstellung zurück.
Lesen Sie sich den obigen Abschnitt über die Protokollierungsebenen durch. Jegliche Änderungen, die auf diese Weise vorgenommen werden, beschränken sich nur auf die aktuell laufende Crowd-Sitzung.
So konfigurieren Sie das Profiling und die Protokollierung:
- Loggen Sie sich in Crowds Administrationskonsole ein.
- Klicken Sie in der Navigationsleiste oben auf den "Administration" Tab.
- Klicken Sie im Menü links auf "Logging & Profiling".
- Die "Logging and Profiling" Seite erscheint. Die Seite hat folgende Abschnitte:
- "Performance Profiling" — Klicken Sie auf den "Enable Profiling" Button um das Profiling zu aktivieren, oder klicken Sie auf "Disable Profiling" um es zu deaktivieren. (Sie werden nur einen der beiden Buttons sehen.)
- "Log4j Logging" — Dieser Abschnitt zeigt die aktuell aktiven Logger in Ihrer Crowd-Instanz.
- Sie können die Logging-Ebene ändern, indem Sie einen Wert aus der "New Level" Dropdown-Liste auswählen. Oben finden Sie eine Definition aller Ebenen. Sie können für weitere Informationen die Apache Dokumentation lesen.
- Sie können auf den "Revert to Default" Button klicken, wenn Sie die Logging-Ebenen zurück zu den Standardwerten Ihrer Crowd-Installation setzen wollen.
- Klicken Sie auf den "Update Logging" Button um jegliche Änderungen an der "Log4j Logging" Sektion abzuspeichern.
Screenshot: Ändern der Log-Ebenen und des Profilings.
Beschreibung der Logger:
| Logger | Beschreibung |
|---|---|
| com.atlassian.crowd | Das ist der übergeordnete Logger der Crowd Package-Logger. Jeder untergeordnete Logger, der keine Ebene zu sich zugewiesen hat, erbt die Ebene seines übergeordneten Loggers. Der Logger sollte nur dann auf DEBUG gesetzt sein, wenn Sie nach SSO-Problemen suchen. |
| com.atlassian.crowd....XFireFaultLoggingMethodHandler | Kann hilfreich sein, wenn ein Crowd SOAP-Dienst Fehler ausgegeben wird. Bei der Fehlerbehebung des Crowd SOAP-Dienstes ist es am besten, wenn DEBUG für alle drei XFire-Klassen gleichzeitig aktiviert ist. |
| com.atlassian.crowd....XFireOutLoggingMethodHandler | Der Crowd Server gibt die eingehenden SOAP-Request Methoden und Parameter aus. Dies ist nützlich, wenn Sie in Ihren Applikationen Fehler beheben oder den Traffic einer integrierten Applikation beobachten. |
| com.atlassian.crowd....XFireInLoggingMethodHandler | Der Crowd Server gibt die ausgehenden SOAP-Request Methoden und Parameter aus. Dies ist nützlichen, wenn Sie in Ihren Applikationen Fehler beheben oder den Traffic einer integrierten Applikation beobachten. |
| com.atlassian.crowd.license | Ist nützlich für die Behebung von bestimmten Lizenzproblemen in Crowd. |
| com.atlassian.crowd.startup | Dies kann hilfreich sein, wenn Sie Fehler beim Starten von Crowd beheben. |
| root | Das ist der Root der Logger-Hierarchie, d. h. er ist allen Loggern übergeordnet. Die zugewiesene Ebene des Roots wird die Standard-Ebene für alle Logger, in denen keine Ebene definiert wurde und die diese auch nicht von übergeordneten Loggern geerbt haben. |
Erweiterte Log-Konfiguration
Terminologie: In log4j ist "logger" eine bekannte Entität. Logger-Namen werden nach Groß- und Kleinschreibung unterschieden und sie folgen einem hierarchischen Namensstandard. Beispielsweise ist der Logger namens com.foo dem Logger namens com.foo.Bar. übergeordnet.
Die Log-Konfigurationsdatei finden
Crowds Logging-Verhalten ist in der folgenden Einstellungsdatei definiert:
- Bei Crowd-Installationen: {
CROWD-INSTALL}/crowd-webapp/WEB-INF/classes/log4j.properties Bei WAR-Installationen: {
CROWD-WAR-INSTALL}/WEB-INF/classes/log4j.properties
Diese Datei ist eine Standard log4j Konfigurationsdatei, wie in der Apache log4j Dokumentation beschrieben.
Die Log-Konfigurationsdatei editieren
So konfigurieren Sie die Logging-Ebenen und weitere Einstellungen dauerhaft:
- Stoppen Sie Crowd.
- Öffnen Sie die log4j.properties Datei mit einem Texteditor aus dem oben beschriebenen Ablageort.
- Passen Sie die Output-Ebene auf die benötigte Prioritätsebene an, wie im obigen Abschnitt über die Ebenen beschrieben.
- Speichern Sie die log4j.properties Datei.
- Starten Sie Crowd neu, um die neuen Log-Einstellungen wirksam zu machen.
Wenn Sie ein Server-Problem feststellen sollten, müssen Sie Crowds Package Logging wie folgt anpassen:
log4j.logger.com.atlassian.crowd=DEBUG
Änderung des Ablageorts der Crowd Log-Datei
Terminologie: In log4j wird der Output-Ablageort "appender" genannt.
So ändern Sie den Ablageort der Crowd Log-Datei:
- Stoppen Sie Crowd.
- Öffnen Sie mit einem Texteditor die log4j.properties Datei aus dem Ablageort, der oben beschrieben wird.
- Suchen Sie nach dem org.apache.log4j.RollingFileAppender Eintrag im "Log File Locations" Abschnitt der Datei. Dieser Appender steuert den Standard Logging-Ablageort, wie oben beschrieben.
- Editieren Sie die folgende Zeile und ersetzen Sie atlassian-crowd.log mit dem vollständigen Pfad und Dateinamen für den benötigten Ablageort:
log4j.appender.filelog.File=atlassian-crowd.log. - Speichern Sie die log4j.properties Datei.
- Starten Sie Crowd neu, damit die Änderungen wirksam werden.
Anpassung der Log-Einstellungen für CrowdID
Die Crowd Administrationskonsole gibt Ihnen keinen Zugriff auf die CrowdID Log-Einstellungen. Um die Logging-Ebenen des CrowdID OpenID Servers anzupassen, müssen Sie die Konfigurationsdatei an diesem Ort editieren:
Für Crowd-Installationen von CrowdID: {
CROWDID-INSTALL}/crowd-openidserver-webapp/WEB-INF/classes/log4j.properties- Für WAR-Installationen: {
CROWDID-WAR-INSTALL}/WEB-INF/classes/log4j.properties
Crowd Dokumentation Übersicht: