Changes for page Monitoring

From version < 3.2 >
edited by awa
on 20.05.2019, 10:02
To version < 6.1 >
edited by sas
on 01.06.2021, 14:00
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.awa
1 +XWiki.sas
Content
... ... @@ -11,77 +11,81 @@
11 11  ; Master-Server
12 12  : de.xima.fc:type=MSMonitor,qualifier=<contextName>
13 13  
14 -The context name is the context name of the applications. It is necessary for supporting parallel installations of {{formcycle/}} on a server. By default, the context name is the name of {{formcycle/}}'s WAR file, but it can be changed by [[modifying the context name parameter>>doc:Tomcat Einstellungen]].
14 +The context name is the context name of the applications. It is necessary for supporting parallel installations of {{formcycle/}} on a server. By default, the context name is the name of {{formcycle/}}'s WAR file, but it can be changed by modifying the context name parameter //XFC_CONTEXT_NAME// within the //web.xml//.
15 15  
16 -When starting the server, the current context name is logged. You may need to modify the [[logging settings>>doc:LogginMenue]] to see the name. There are different monitoring attributes available for each bean, which are listed below.
16 +When starting the server, the current context name is logged. You may need to modify the [[logging settings>>doc:.UserInterface.Logging]] to see the name. There are different monitoring attributes available for each bean, which are listed below.
17 17  
18 -{{table caption="Overview of the settings for MSMonitor (master server)" dataTypeAlpha="0" preSort="0-asc"}}
18 +{{table dataTypeAlpha="0" preSort="0-asc" caption="Overview of the settings for MSMonitor (master server)"}}
19 19  |=Key|=Description|=Possible options
20 -|running|Whether the {{mserver/}} has been started successfully.|true ~| false
21 -|db_connected|Whether the {{mserver/}} could establish a connection to the database.| true ~| false
22 -|fs_connected|A map of the names of all {{fserver number="plural"/}} and whether they are connected to this {{mserver/}}|<serverName> : true ~| false
23 -|fs_active|A map of the names of all {{fserver number="plural"/}} and whether this {{mserver/}} should attempt to establish a connection to that server automatically.|<serverName> : true ~| false
24 -|fs_status|A map of the names of all {{fserver number="plural"/}} and the connection status of that server.|<serverName> : CONNECTED ~| NOT_CONNECTED ~| ERROR ~| RECONNECTING ~| DISCONNECTING ~| CONNECTING ~| AUTHENTICATING ~| WAIT_FOR_CONNECTION
20 +|running|Whether the {{mserver/}} has been started successfully.|true/false
21 +|db_connected|Whether the {{mserver/}} could establish a connection to the database.|true/false
22 +|fs_connected|A map of the names of all {{fserver number="plural"/}} and whether they are connected to this master server|__Key:__ <serverName>
23 +__Return value:__ true/false
24 +|fs_active|A map of the names of all {{fserver number="plural"/}} and whether this master server should attempt to establish a connection to that server automatically.|__Key:__ <serverName>
25 +__Return value:__ true/false
26 +|fs_status|A map of the names of all {{fserver number="plural"/}} and the connection status of that server.|__Key:__ <serverName>
27 +__Return values:__ CONNECTED, NOT_CONNECTED, ERROR, RECONNECTING, DISCONNECTING , CONNECTING, AUTHENTICATING, WAIT_FOR_CONNECTION
25 25  |fs_disconnected_count|The number of {{fserver number="plural"/}} not connected to this {{mserver/}}|A non-negative number.
26 26  |fs_connected_count|The number of {{fserver number="plural"/}} connected to this {{mserver/}}|A non-negative number.
30 +|failed_login_count|For each login name, the login cache contains how many times a user made a failed login attempt with that login name. This is the number of login names in that cache.|A non-negative number.
31 +|connect_frontendserver_by_name|Triggers a connection to the frontend server by name.|__Key:__ <serverName>, true/false to trigger reconnect always (no matter if there is a connection)
32 +__Return value:__ true/false
33 +|connect_frontendserver_by_id|Triggert eine Verbindung zum Frontend-Servers per ID an.|__Key:__ <serverName>, true/false to trigger reconnect always (no matter if there is a connection)
34 +__Return value:__ true/false
27 27  {{/table}}
28 28  
29 -{{table caption="Overview of the settings for FSMonitor (frontend server)" dataTypeAlpha="0" preSort="0-asc"}}
37 +{{table dataTypeAlpha="0" preSort="0-asc" caption="Overview of the settings for FSMonitor (frontend server)"}}
30 30  |=Key|=Description|=Possible options
31 -|running|Whether the {{fserver/}} has been started successfully.|true ~| false
32 -|connected|Whether this {{fserver/}} is connected to a {{mserver/}}.|true ~| false
33 -|status|The connection status of this {{fserver/}}.|CONNECTED ~| NOT_CONNECTED ~| ERROR ~| RECONNECTING ~| DISCONNECTING ~| CONNECTING ~| AUTHENTICATING ~| WAIT_FOR_CONNECTION
39 +|running|Whether the {{fserver/}} has been started successfully.|true, false
40 +|connected|Whether this {{fserver/}} is connected to a {{mserver/}}.|true, false
41 +|failed_login_count|For each login name, the login cache contains how many times a user made a failed login attempt with that login name. This is the number of login names in that cache.|A non-negative number.
42 +|status|The connection status of this {{fserver/}}.|CONNECTED, NOT_CONNECTED, ERROR, RECONNECTING, DISCONNECTING, CONNECTING, AUTHENTICATING, WAIT_FOR_CONNECTION
43 +|restart|xxx|None
34 34  {{/table}}
35 35  
36 36  == JSON REST API ==
37 37  
38 -The monitoring beans can also be accessed via a JSON REST API. This is done as follows:
48 +The JSON interface has been removed since version 6.0.0 in favor of a separate Jolokia installation. The beans used for monitoring are still available. The JSON interface of the monitoring allowed read-only access and could only be called via the application server (localhost/127.0.0.1). If this is wanted, the access would have to be configured within the Jolokia application, more information can be found [[here>>https://jolokia.org/reference/html/security.html#d0e3128||rel="noopener noreferrer" target="_blank"]].
39 39  
50 +A possible call, after installation of Jolokia, looks like the following:
51 +
40 40  {{info}}
41 -http://localhost/formcycle/monitoring/read/de.xima.fc:type=MSMonitor,qualifier=formcycle
53 +[[http:~~/~~/localhost/jolokia/read/de.xima.fc:type=MSMonitor,qualifier=formcycle>>http://localhost/jolokia/read/de.xima.fc:type=MSMonitor,qualifier=formcycle]]
42 42  {{/info}}
43 43  
44 -=== JSON response ===
56 +(% class="wikigeneratedid" id="HJSONresponse" %)
57 +JSON response:
45 45  
46 46  {{code language="JSON"}}
47 47  {
48 -"timestamp":1440603508,
49 -"status":200,
50 -"request":{
51 - "mbean":"de.xima.fc:qualifier=formcycle,type=MSMonitor",
52 - "type":"read"
53 -},
54 -"value":{
55 - "fs_active":{
56 - "sas":true,
57 - "localhost":false,
58 - "mko":true
59 - },
60 - "fs_connected":{
61 - "sas":false,
62 - "localhost":false,
63 - "mko":false
64 - },
65 - "db_connected":true,"fs_status":{
66 - "sas":"ERROR",
67 - "localhost":"NOT_CONNECTED",
68 - "mko":"ERROR"
69 - },
70 - "fs_disconnected_count":3,
71 - "fs_connected_count":0,
72 - "running":true
73 - }
61 + "request": {
62 + "mbean": "de.xima.fc:qualifier=formcycle,type=MSMonitor",
63 + "type": "read"
64 + },
65 + "value": {
66 + "running": true,
67 + "failed_login_count": 0,
68 + "fs_active": {
69 + "localhost": true
70 + },
71 + "db_connected": true,
72 + "fs_connected_count": 1,
73 + "fs_connected": {
74 + "localhost": true
75 + },
76 + "fs_disconnected_count": 0,
77 + "fs_status": {
78 + "localhost": "CONNECTED"
79 + }
80 + },
81 + "timestamp": 1579186291,
82 + "status": 200
74 74  }
75 75  {{/code}}
76 76  
77 -=== URL ===
86 +(% class="wikigeneratedid" %)
87 +More information about the integration of the framework [[Jolokia>>url:https://jolokia.org/||rel="__blank"]] and a more detailed documentation can be found [[here>>https://jolokia.org/reference/html/||rel="noopener noreferrer" target="_blank"]].
78 78  
79 -The monitoring servlet is available as the sub resource {{code}}monitoring{{/code}} of the application context URL, eg. {{code}}http://localhost/formcycle/{{/code}}. This servlet processes the monitoring bean and provides the monitoring info as JSON. The servlet makes use of the framework [[Jolokia>>url:https://jolokia.org/||rel="__blank"]]. Further servlet options provided by Jolokia are described on their [[documentation pages>url:https://jolokia.org/reference/html/||rel="__blank"]].
80 -
81 -{{warning}}
82 -The JSON REST API only allow read-access, but no write-access. It is available only for the application server, eg. {{code}}localhost/127.0.0.1{{/code}}.
83 -{{/warning}}
84 -
85 85  == Nagios integration ==
86 86  
87 87  The Nagios monitoring application may be used for reading and showing monitoring info as well by using the JSON REST API described above. This requires the Nagios plugin [[jmx4perl>>url:http://search.cpan.org/~~roland/jmx4perl/||rel="__blank"]] to be installed. A detailed installation instruction can be found on [[their website>>url:https://jolokia.org/tutorial.html||rel="__blank"]]. This allows querying the JSON REST API with the corresponding commands.
... ... @@ -93,7 +93,7 @@
93 93  {{/info}}
94 94  
95 95  {{panel title="Command" fullwidth="true" initial="hidden" triggerable="true"}}
96 -{{code}}
100 +{{code language="none"}}
97 97  define command{
98 98   command_name check_jmx4perl
99 99   command_line check_jmx4perl --url $ARG1$ --mbean $ARG2$ --attribute $ARG3$ $ARG4$
... ... @@ -102,9 +102,9 @@
102 102  {{/panel}}
103 103  
104 104  {{panel title="Service definitions" fullwidth="true" initial="hidden" triggerable="true"}}
105 -Querying the number of {{fserver number="plurar"/}} not connected to this {{mserver/}}. When there are any disconnected servers, a warning will be displayed. When there is more than one disconnected server, Nagios will treat this warning as critical.
109 +Querying the number of {{fserver number="plurar"/}} not connected to this {{mserver/}}. When there are any disconnected servers, a warning will be displayed. When there is more than one disconnected server, Nagios will treat this warning as critical.<br>
106 106  <br>
107 -{{code}}
111 +{{code language="none"}}
108 108  define service{
109 109   use generic-service
110 110   host_name localhost
... ... @@ -115,7 +115,7 @@
115 115  {{/panel}}
116 116  
117 117  {{panel title="Querying the database connection status of the {{mserver/~}~}" fullwidth="true" initial="hidden" triggerable="true"}}
118 -{{code}}
122 +{{code language="none"}}
119 119  define service{
120 120   use generic-service
121 121   host_name localhost
... ... @@ -126,7 +126,7 @@
126 126  {{/panel}}
127 127  
128 128  {{panel title="Querying whether the {{fserver/~}~} localhost is connected to the {{mserver/~}~}" fullwidth="true" initial="hidden" triggerable="true"}}
129 -{{code}}
133 +{{code language="none"}}
130 130  define service{
131 131   use generic-service
132 132   host_name localhost
... ... @@ -137,7 +137,7 @@
137 137  {{/panel}}
138 138  
139 139  {{panel title="Querying the {{fserver/~}~} whether it is connected to a {{mserver/~}~}" fullwidth="true" initial="hidden" triggerable="true"}}
140 -{{code}}
144 +{{code language="none"}}
141 141  define service{
142 142   use generic-service
143 143   host_name localhost
... ... @@ -163,7 +163,7 @@
163 163  
164 164  When Jolokia is run parallel to {{formcycle/}}, the connection to the {{fserver/}} //localhost// must be modified as follows:
165 165  
166 -{{code}}
170 +{{code language="none"}}
167 167  define service{
168 168   use generic-service
169 169   host_name fc-test
... ... @@ -171,4 +171,3 @@
171 171   check_command check_jmx4perl!http://fc-test/jolokia/!de.xima.fc:type=MSMonitor,qualifier=formcycle!fs_connected!--path=localhost --string --critical 'false'
172 172  }
173 173  {{/code}}
174 -{{/table}}

Navigation

Copyright 2000-2024