Änderungen von Dokument Monitoring

Von Version 1.1

bearbeitet von gru
am 20.01.2021, 16:20

Änderungskommentar: Imported from XAR

Auf Version 5.1

bearbeitet von sas
am 22.11.2022, 16:03

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.gru
++XWiki.sas

Inhalt

@@ -11,21 +11,25 @@
  Der //qualifier// ist hierbei für eine Parallel-Installation der entsprechenden Server notwendig und entspricht dem Kontext-Namen der Anwendung. Dieser ist hierbei standardmäßig der Namen der war-Datei, kann jedoch über den Kontext-Parameter //XFC_CONTEXT_NAME// innerhalb der //web.xml// angepasst werden. Ebenfalls wird während des Starts des entsprechenden Servers der konkret verwendete Name ausgeloggt. Hierfür kann es notwendig sein, die [[Logging-Einstellungen>>doc:.UserInterface.Logging]] anzupassen. Jede Bean besitzt zudem unterschiedliche Monitoring-Attribute, welche in folgenden Übersichten dargestellt sind:
--{{table caption="Übersicht über die Eigenschaften des MSMonitor (Master-Server)" dataTypeAlpha="0" preSort="0-asc"}}
++{{table dataTypeAlpha="0" preSort="0-asc" caption="Übersicht über die Eigenschaften des MSMonitor (Master-Server)"}}
  |= Attribut|=Bedeutung|= Mögliche Werte
  |running|Gibt an, ob der {{mserver/}} aktiv ist|true,false
  |db_connected|Gibt an, ob der {{mserver/}} erfolgreich eine Datenbankverbindung herstellen konnte.|true,false
--|fs_connected|Repräsentiert eine Map mit den Namen aller {{fserver case="nom" number="plural"/}} als Schlüssel und als Wert, ob diese mit dem {{mserver case="dat"/}} verbunden sind.|__Schlüssel:__ <Frontend-Server-Name>
--__Wert:__ true,false
--|fs_active|Repräsentiert eine Map mit den Namen aller {{fserver case="nom" number="plural"/}} als Schlüssel und als Wert ob diese automatisch verbunden werden soll.|__Schlüssel:__ <Frontend-Server-Name>
--__Wert:__ true,false
--|fs_status|Repräsentiert eine Map mit den Namen aller {{fserver case="nom" number="plural"/}} als Schlüssel und dem konkreten Verbindungsstatus als Wert.|__Schlüssel:__ <Frontend-Server-Name>
--__Wert:__ CONNECTED,NOT_CONNECTED,ERROR,
++|fs_connected|Repräsentiert eine Map mit den Namen aller {{fserver case="nom" number="plural"/}} als Schlüssel und als Wert, ob diese mit dem {{mserver case="dat"/}} verbunden sind.|__Schlüssel__: <Frontend-Server-Name>
++__Wert__: true,false
++|fs_active|Repräsentiert eine Map mit den Namen aller {{fserver case="nom" number="plural"/}} als Schlüssel und als Wert ob diese automatisch verbunden werden soll.|__Schlüssel__: <Frontend-Server-Name>
++__Wert__: true,false
++|fs_status|Repräsentiert eine Map mit den Namen aller {{fserver case="nom" number="plural"/}} als Schlüssel und dem konkreten Verbindungsstatus als Wert.|__Schlüssel__: <Frontend-Server-Name>
++__Wert__: CONNECTED,NOT_CONNECTED,ERROR,
  RECONNECTING,DISCONNECTING,CONNECTING,
  AUTHENTICATING, WAIT_FOR_CONNECTION
  |fs_disconnected_count| Gibt die Anzahl der nicht verbundenen {{fserver case="nom" number="plural"/}} an.|Zahlen größer/gleich 0
  |fs_connected_count| Gibt die Anzahl der verbundenen {{fserver case="nom" number="plural"/}} an.|Zahlen größer/gleich 0
--|failed_login_count|Gibt die Anzahl der aktuell registrierten fehlerhaften Login-Versuche aus, also wie viele Login-Name sich Cache für die fehlerhaften Versuche befinden.|Eine Zahl größer oder gleich 0.
++|failed_login_count|Gibt die Anzahl der aktuell registrierten fehlerhaften Login-Versuche aus, also wie viele Login-Name sich Cache für die fehlerhaften Versuche befinden.|Eine Zahl größer oder gleich 0
++|connect_frontendserver_by_name|Triggert eine Verbindung zum Frontend-Servers per Name an.|__Schlüssel__: <Frontend-Server-Name>, true/false um Reconnect immer anzustoßen (egal ob Verbindung besteht)
++__Rückgabewert__: true/false
++|connect_frontendserver_by_id|Triggert eine Verbindung zum Frontend-Servers per ID an.|__Schlüssel__: <Frontend-Server-ID>, true/false um Reconnect immer anzustoßen (egal ob Verbindung besteht)
++__Rückgabewert__: true/false
  {{/table}}
  {{table dataTypeAlpha="0" preSort="0-asc" fullwidth="true" caption="Übersicht über die Eigenschaften des FSMonitor (frontend-Server)"}}
@@ -36,11 +36,12 @@
  RECONNECTING,DISCONNECTING,CONNECTING,
  AUTHENTICATING, WAIT_FOR_CONNECTION
  |failed_login_count|Gibt die Anzahl der aktuell registrierten fehlerhaften Login-Versuche aus, also wie viele Login-Name sich Cache für die fehlerhaften Versuche befinden.|Eine Zahl größer oder gleich 0.
++|restart|Triggert einen Neustart des Frontend-Servers an.|Keine
  {{/table}}
  == JSON-REST-Schnittstelle ==
--Die JSON-Schnittstelle ist seit Version 6.0.0 zu Gunsten einer separaten Jolokia-Installation entfernt worden. Die für das Monitoring verwendeten Beans sind nachwievor verfügbar. Die JSON-Schnittstelle des Monitorings erlaubte nur lesende Zugriff und war nur über den Anwendungsserver aufrufbar (localhost/127.0.0.1). Falls dies gewünscht ist müsste der Zugriff innerhalb der Jolokia Anwendung konfiguriert werden, weiter Infomationen finden Sie [[hier>>https://jolokia.org/reference/html/security.html#d0e3128||rel=" noopener noreferrer" target="_blank"]].
++Die JSON-Schnittstelle ist seit Version 6.0.0 zu Gunsten einer separaten Jolokia-Installation entfernt worden. Die für das Monitoring verwendeten Beans sind nachwievor verfügbar. Die JSON-Schnittstelle des Monitorings erlaubte nur lesende Zugriff und war nur über den Anwendungsserver aufrufbar (localhost/127.0.0.1). Falls dies gewünscht ist müsste der Zugriff innerhalb der Jolokia Anwendung konfiguriert werden, weiter Infomationen finden Sie [[hier>>https://jolokia.org/reference/html/security.html#d0e3128||rel="noopener noreferrer" target="_blank"]].
  Ein möglicher Aufruf, nach erfolgter Installation von Jolokia, sieht hierbei zum Beispiel wie folgt aus:
@@ -162,3 +162,38 @@
   check_command        check_jmx4perl!http://fc-test/jolokia/!de.xima.fc:type=MSMonitor,qualifier=formcycle!fs_connected!--path=localhost --string --critical 'false'
  }
  {{/code}}
++
++== Frontend-Server-Monitoring-URL ==
++
++{{version major="7" minor="1"/}} Die Funktionalität steht ab {{formcycle/}} 7.1 zur Verfügung.
++
++Es steht auch eine URL zur Verfügung, über die ein Monitoring des Frontend-Servers möglich ist. Diese ist nur auf dem Master-Server verfügbar und lautet:
++
++{{code language="text"}}
++  https://<domain>/<context>/monitor/fs/connection
++{{/code}}
++
++Aus Sicherheitsgründen ist diese URL standardmäßig deaktiviert. Zum Aktivieren müssen die [[Anwendungseinstellungen>>doc:Formcycle.SystemSettings.ConfigFiles.ApplicationProperties]] //monitoring.enabled// und //monitoring.allowed.hosts// entsprechend konfiguriert werden.
++
++Läuft der {{formcycle/}}-Server als etwa unter der Domain //demo.firma.de// im Kontext //formcycle//, dann lautet die URL //https://demo.firma.de/formcycle/monitor/fs/connection//.//
++
++Als Parameter muss immer entweder der Name des System-Frontend-Servers über den Parameter //name// oder die interne Datenbank-ID über den Parameter //id// angegeben werden:
++
++{{code language="text"}}
++  https://<domain>/<context>/monitor/fs/connection?name=MeinFrontendServer
++  https://<domain>/<context>/monitor/fs/connection?id=5963
++{{/code}}
++
++Folgende Möglichkeiten zum Monitoring stehen zur Verfügung:
++
++* {{code language="plain"}}https://<domain>/<context>/monitor/fs/connection?name=<Name>{{/code}}
++
++Prüft, ob eine Verbindung mit dem Frontend-Server besteht. Liefert den HTTP-Statuscode //200// zurück, falls eine Verbindung besteht, ansonsten //500//.
++
++* {{code language="plain"}}https://<domain>/<context>/monitor/fs/connection?name=<Name>&action=connect{{/code}}
++
++Versucht, eine Verbindung zum Frontend-Server herzustellen. Besteht bereits eine Verbindung, wird nichts getan. Liefert den HTTP-Statuscode //200// zurück, wenn bereits eine Verbindung besteht oder die Verbindung erfolgreich hergestellt werden konnte. Falls der Verbindungsaufbau fehlgeschlagen ist, wird der HTTP-Statuscode //500// zurückgeliefert.
++
++* {{code language="plain"}}https://<domain>/<context>/monitor/fs/connection?name=<Name>&action=connect&force=true{{/code}}
++
++Versucht, eine Verbindung zum Frontend-Server herzustellen. Besteht bereits eine Verbindung, wird die Verbindung getrennt und versucht, erneut eine Verbindung aufzubauen. Liefert den HTTP-Statuscode //200// zurück, wenn Verbindung erfolgreich hergestellt werden konnte. Falls der Verbindungsaufbau fehlgeschlagen ist, wird der HTTP-Statuscode //500// zurückgeliefert.