Wiki-Quellcode von Monitoring

Zeige letzte Bearbeiter
1 {{content/}}
2
3 == Verfügbare Monitoring-Beans ==
4
5 {{formcycle/}} bietet für das Monitoring des Anwendungsstatus je Server-Typ eine entsprechende Monitoring-Bean an. Diese kann über JMX mit einem dazugehörigen Werkzeug (z.B. //JConsole//) angebunden und abgefragt werden. Die Namen unter der die entsprechenden Beans registriert sind lauten hierbei:
6
7 ; Frontend-Server
8 de.xima.fc:type=FSMonitor,qualifier=<Kontext-Name>
9 ; Master-Server
10 : de.xima.fc:type=MSMonitor,qualifier=<Kontext-Name>
11
12 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. Jede Bean besitzt zudem unterschiedliche Monitoring-Attribute welche in folgenden Übersichten dargstellt sind:
13
14 {{table caption="Übersicht über Eigenschaften MSMonitor (Master-Server)" dataTypeAlpha="0" preSort="0-asc"}}
15 |= Attribut|=Bedeutung|= Mögliche Werte
16 |running|Gibt an, ob der {{mserver/}} aktiv ist|true,false
17 |db_connected|Gibt an, ob der {{mserver/}} erfolgreich eine Datenbankverbindung herstellen konnte.|true,false
18 |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>
19 __Wert:__ true,false
20 |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>
21 __Wert:__ true,false
22 |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>
23 __Wert:__ CONNECTED,NOT_CONNECTED,ERROR,
24 RECONNECTING,DISCONNECTING,CONNECTING,
25 AUTHENTICATING, WAIT_FOR_CONNECTION
26 |fs_disconnected_count| Gibt die Anzahl der nicht verbundenen {{fserver case="nom" number="plural"/}} an.|Zahlen größer/gleich 0
27 |fs_connected_count| Gibt die Anzahl der verbundenen {{fserver case="nom" number="plural"/}} an.|Zahlen größer/gleich 0
28 {{/table}}
29
30 {{table dataTypeAlpha="0" preSort="0-asc" fullwidth="true" caption="Übersicht über die Eigenschaften des FSMonitor (frontend-Server)"}}
31 |=Attribut|=Bedeutung|=Mögliche Werte
32 |running|Gibt an, ob der {{fserver/}} erfolgreich gestartet wurde.|true,false
33 |connected|Gibt an, ob der {{fserver/}} mit einem {{mserver/}} verbunden ist.|true,false
34 |status|Gibt den konkreten Verbindungsstatus des {{fserver case="gen"/}} an.|CONNECTED,NOT_CONNECTED,ERROR,
35 RECONNECTING,DISCONNECTING,CONNECTING,
36 AUTHENTICATING, WAIT_FOR_CONNECTION
37 {{/table}}
38
39 == JSON-REST-Schnittstelle ==
40
41 Die für das Monitoring verwendeten Beans sind ebenfalls über eine bereitgestellte JSON-Schnittstelle aufrufbar. Ein möglicher Aufruf sieht hierbei zum Beispiel wie folgt aus:
42
43 {{info}}
44 http://localhost/formcycle/monitoring/read/de.xima.fc:type=MSMonitor,qualifier=formcycle
45 {{/info}}
46
47 JSON-Antwort:
48
49 {{code language="JSON"}}
50 {
51 "timestamp":1440603508,
52 "status":200,
53 "request":{
54 "mbean":"de.xima.fc:qualifier=formcycle,type=MSMonitor",
55 "type":"read"
56 },
57 "value":{
58 "fs_active":{
59 "sas":true,
60 "localhost":false,
61 "mko":true
62 },
63 "fs_connected":{
64 "sas":false,
65 "localhost":false,
66 "mko":false
67 },
68 "db_connected":true,"fs_status":{
69 "sas":"ERROR",
70 "localhost":"NOT_CONNECTED",
71 "mko":"ERROR"
72 },
73 "fs_disconnected_count":3,
74 "fs_connected_count":0,
75 "running":true
76 }
77 }
78 {{/code}}
79
80
81 Wie erkennbar ist, befindet sich unter dem Kontext der Anwendung das Servlet //../monitoring// welches die eigentliche Interpretation der Beans und deren Aufbereitung in JSON realisiert. Hierfür kommt das Framework [[Jolokia>>url:https://jolokia.org/||rel="__blank"]] zum Einsatz, sodass dieses Servlet entsprechend konfigurierbar und über verschiedene Aufrufe benutzbar ist. Eine genauere Dokumentation hierfür finden sie [[hier>>url:https://jolokia.org/reference/html/||rel="__blank"]].
82
83 {{warning}}
84 Es ist zu beachten, dass die JSON-Schnittstelle des Monitorings nur lesende Zugriffe erlaubt und nur über den Anwendungsserver aufrufbar ist! (localhost/127.0.0.1)
85 {{/warning}}
86
87
88 == Nagios-Anbindung ==
89
90 Eine Anbindung der Nagios-Monitoring-Anwendung erfolgt über die beschriebene JSON-Schnittstelle. Hierfür muss das Nagios-Plugin [[jmx4perl>>url:http://search.cpan.org/~~roland/jmx4perl/||rel="__blank"]] installiert werden. Dieses erlaubt es Nagios das JSON zu interpretieren und entsprechende Abfragen aufzubauen. Eine genauere Installations-Dokumentation hierfür finden Sie [[hier>>url:https://jolokia.org/tutorial.html||rel="__blank"]]. Anschließend ist es möglich mit dem entsprechenden command des Plugins die Abfragen an die JSON-Schnittstelle zu formulieren.
91
92 === Beispiele ===
93
94 {{warning}}
95 Folgende Beispiele funktionieren lediglich wenn Nagios auf dem selben Server wie die Anwendungen betrieben wird!
96 {{/warning}}
97
98 {{panel title="Command" fullwidth="true" initial="hidden" triggerable="true"}}
99 {{code}}
100 define command{
101 command_name check_jmx4perl
102 command_line check_jmx4perl --url $ARG1$ --mbean $ARG2$ --attribute $ARG3$ $ARG4$
103 }
104 {{/code}}
105 {{/panel}}
106
107 {{panel title="Service-Definitionen" fullwidth="true" initial="hidden" triggerable="true"}}
108 Abfrage der Anzahl der am {{mserver case="dat"/}} nicht verbundenen {{fserver number="plural"/}}. Ist diese größer/gleich 1, erfolgt eine Warnung. Ist diese ferner größer/gleich 2, wird diese als kritisch im Nagios interpretiert:
109
110 {{code}}
111 define service{
112 use generic-service
113 host_name localhost
114 service_description MS:FS-connected-count
115 check_command check_jmx4perl!http://localhost/formcycle/monitoring/!de.xima.fc:type=MSMonitor,qualifier=formcycle!fs_disconnected_count!--warning 1 --critical 2
116 }
117 {{/code}}
118 {{/panel}}
119
120 {{panel title="Abfrage des Datenbank-Verbindungsstatus des {{mserver case='gen'/~}~}" fullwidth="true" initial="hidden" triggerable="true"}}
121 {{code}}
122 define service{
123 use generic-service
124 host_name localhost
125 service_description MS:DB-connected
126 check_command check_jmx4perl!http://localhost/formcycle/monitoring/!de.xima.fc:type=MSMonitor,qualifier=formcycle!db_connected!--string --critical 'false'
127 }
128 {{/code}}
129 {{/panel}}
130
131 {{panel title="Abfrage, ob {{fserver/~}~} localhost mit {{mserver case='dat'/~}~} verbunden ist" fullwidth="true" initial="hidden" triggerable="true"}}
132 {{code}}
133 define service{
134 use generic-service
135 host_name localhost
136 service_description MS:FS-localhost
137 check_command check_jmx4perl!http://localhost/formcycle/monitoring/!de.xima.fc:type=MSMonitor,qualifier=formcycle!fs_connected!--path=localhost --string --critical 'false'
138 }
139 {{/code}}
140 {{/panel}}
141
142 {{panel title="Abfrage an {{fserver/~}~}, ob dieser erfolgreich mit einem {{mserver/~}~} verbunden ist" fullwidth="true" initial="hidden" triggerable="true"}}
143 {{code}}
144 define service{
145 use generic-service
146 host_name localhost
147 service_description FS:connected
148 check_command check_jmx4perl!http://localhost/frontend-server/monitoring/!de.xima.fc:type=FSMonitor,qualifier=frontend-server!connected!--string --critical 'false'
149 }
150 {{/code}}
151 {{/panel}}
152
153 === Betrieb von Nagios auf anderem Server ===
154
155 Da aus Sicherheitsgründen die Standardkonfiguration der JSON-Schnittstelle es nicht gestattet, von anderen IP-Adressen als die des lokalen Servers aufgerufen zu werden, ist ein Betrieb von Nagios auf einem anderen Server mit Mehraufwand verbunden. Neben den entsprechenden Lösungen über Routing oder das Verwenden eines Proxys, ist es ebenso möglich, diese Beschränkung konfigurativ zu behandeln. So ist es zum Beispiel möglich, dem Monitoring-Servlet in welchem diese Beschränkung stattfindet über den Parameter //policyLocation// den Pfad oder die URL zu einer entsprechenden Jolokia-Policy-Datei zu spezifizieren. Da es sich bei besagten Servlet lediglich um eine Fassade des Standard-Jolokia-Servlets handelt, wird dieser ebenso wie alle weiteren Parameter an dieses durchgereicht und es erfolgt eine entsprechende Konfiguration, siehe [[hier>>url:https://jolokia.org/reference/html/agents.html#agent-war-init-params||rel="__blank"]]).
156
157 Eine weitere Möglichkeit um die Anbindung von Nagios von einem anderen Server aus zu ermöglichen, ist der parallele Betrieb von Jolokia und {{formcycle/}} bzw. dem {{fserver case="dat"/}}. Hierfür stellt Jolokia bereits einen in einer eigenen Anwendung gepackten //JavaEE-Agent// zur Verfügung. ([[Dokumentation>>url:https://jolokia.org/reference/html/agents.html#agents-war||rel="__blank"]], [[Download>>url:https://jolokia.org/download.html||rel="__blank"]])
158
159 Dieser besitzt standardmäßig keine Limitierung von Lese-Operationen und Steueranweisungen und ist ebenso nicht bezüglich aufrufender Server bzw. IP-Adressen beschränkt. Da dies jedoch ein potentielles Sicherheitsrisiko darstellt, wird es ausdrücklich empfohlen, diese entsprechend der eigenen Server-Topologie und Anforderungen zu konfigurieren. Hierbei ist zum Beispiel anzuraten, den Zugriff lediglich auf den Nagios-Server zu beschränken. Eine ausführliche Dokumentation der Sicherheitsmechanismen von Jolokia finden Sie [[hier>>url:https://jolokia.org/reference/html/security.html||rel="__blank"]].
160
161 Entsprechend des Betriebs einer parallelen Jolokia-Installation ändert sich beispielhaft die Überprüfung der Verbindung zum {{fserver case="dat"/}} //localhost //wie folgt:
162
163 {{code}}
164 define service{
165 use generic-service
166 host_name fc-test
167 service_description MS:FS-localhost
168 check_command check_jmx4perl!http://fc-test/jolokia/!de.xima.fc:type=MSMonitor,qualifier=formcycle!fs_connected!--path=localhost --string --critical 'false'
169 }
170 {{/code}}

Navigation

Copyright 2000-2025