Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

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

Content

...	...	@@ -6,43 +6,41 @@
6	6
7	7	The beans are registered under the following names:
8	8
9		-; Frontend-Server
10		-: de.xima.fc:type=FSMonitor,qualifier=<contextName>
11		-; Master-Server
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 //XFC_CONTEXT_NAME// within the //web.xml//.
	10	+* {{litem title="{{fserver/~}~}"}}de.xima.fc:type=FSMonitor,qualifier=<contextName> {{/litem}}
	11	+* {{litem title="{{mserver/~}~}"}} de.xima.fc:type=MSMonitor,qualifier=<contextName> {{/litem}}
15	15
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.
	13	+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]].
17	17
18		-{{table caption="Overview of the settings for MSMonitor (master server)" dataTypeAlpha="0" preSort="0-asc"}}
	15	+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	+
	17	+=== {{mserver/}} (MSMonitor) ===
	18	+
	19	+{{table caption="Overview of the settings for MSMonitor" dataTypeAlpha="0" preSort="0-asc"}}
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 master server|<serverName> : true, false
23		-|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.|<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
	21	+|running|Whether the {{mserver/}} has been started successfully.|true ~| false
	22	+|db_connected|Whether the {{mserver/}} could establish a connection to the database.| true ~| false
	23	+|fs_connected|A map of the names of all {{fserver number="plural"/}} and whether they are connected to this {{mserver/}}|<serverName> : true ~| false
	24	+|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
	25	+|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
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.
27		-|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.
28	28	{{/table}}
29	29
30		-{{table caption="Overview of the settings for FSMonitor (frontend server)" dataTypeAlpha="0" preSort="0-asc"}}
	30	+=== {{fserver/}} (FSMonitor) ===
	31	+
	32	+{{table caption="Overview of the settings for FSMonitor" dataTypeAlpha="0" preSort="0-asc"}}
31	31	|=Key|=Description|=Possible options
32		-|running|Whether the {{fserver/}} has been started successfully.|true, false
33		-|connected|Whether this {{fserver/}} is connected to a {{mserver/}}.|true, false
34		-|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.
35		-|status|The connection status of this {{fserver/}}.|CONNECTED, NOT_CONNECTED, ERROR, RECONNECTING, DISCONNECTING, CONNECTING, AUTHENTICATING, WAIT_FOR_CONNECTION
36		-{{/table}}
	34	+|running|Whether the {{fserver/}} has been started successfully.|true ~| false
	35	+|connected|Whether this {{fserver/}} is connected to a {{mserver/}}.|true ~| false
	36	+|status|The connection status of this {{fserver/}}.|CONNECTED ~| NOT_CONNECTED ~| ERROR ~| RECONNECTING ~| DISCONNECTING ~| CONNECTING ~| AUTHENTICATING ~| WAIT_FOR_CONNECTION
37	37
38	38	== JSON REST API ==
39	39
40		-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"]].
	40	+The monitoring beans can also be accessed via a JSON REST API. It can be accessed as follows:
41	41
42		-A possible call, after installation of Jolokia, looks like the following:
43		-
44	44	{{info}}
45		-[[http:~~/~~/localhost/jolokia/read/de.xima.fc:type=MSMonitor,qualifier=formcycle>>http://localhost/jolokia/read/de.xima.fc:type=MSMonitor,qualifier=formcycle]]
	43	+http://localhost/formcycle/monitoring/read/de.xima.fc:type=MSMonitor,qualifier=formcycle
46	46	{{/info}}
47	47
48	48	=== JSON response ===
...	...	@@ -49,34 +49,43 @@
49	49
50	50	{{code language="JSON"}}
51	51	{
52		- "request": {
53		- "mbean": "de.xima.fc:qualifier=formcycle,type=MSMonitor",
54		- "type": "read"
55		- },
56		- "value": {
57		- "running": true,
58		- "failed_login_count": 0,
59		- "fs_active": {
60		- "localhost": true
61		- },
62		- "db_connected": true,
63		- "fs_connected_count": 1,
64		- "fs_connected": {
65		- "localhost": true
66		- },
67		- "fs_disconnected_count": 0,
68		- "fs_status": {
69		- "localhost": "CONNECTED"
70		- }
71		- },
72		- "timestamp": 1579186291,
73		- "status": 200
	50	+"timestamp":1440603508,
	51	+"status":200,
	52	+"request":{
	53	+ "mbean":"de.xima.fc:qualifier=formcycle,type=MSMonitor",
	54	+ "type":"read"
	55	+},
	56	+"value":{
	57	+ "fs_active":{
	58	+ "sas":true,
	59	+ "localhost":false,
	60	+ "mko":true
	61	+ },
	62	+ "fs_connected":{
	63	+ "sas":false,
	64	+ "localhost":false,
	65	+ "mko":false
	66	+ },
	67	+ "db_connected":true,"fs_status":{
	68	+ "sas":"ERROR",
	69	+ "localhost":"NOT_CONNECTED",
	70	+ "mko":"ERROR"
	71	+ },
	72	+ "fs_disconnected_count":3,
	73	+ "fs_connected_count":0,
	74	+ "running":true
	75	+ }
74	74	}
75	75	{{/code}}
76	76
77		-(% class="wikigeneratedid" %)
78		-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"]].
	79	+=== URL ===
79	79
	81	+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"]].
	82	+
	83	+{{warning}}
	84	+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}}.
	85	+{{/warning}}
	86	+
80	80	== Nagios integration ==
81	81
82	82	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.
...	...	@@ -98,7 +98,7 @@
98	98
99	99	{{panel title="Service definitions" fullwidth="true" initial="hidden" triggerable="true"}}
100	100	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.
101		-<br>
	108	+
102	102	{{code}}
103	103	define service{
104	104	use generic-service
...	...	@@ -166,3 +166,4 @@
166	166	check_command check_jmx4perl!http://fc-test/jolokia/!de.xima.fc:type=MSMonitor,qualifier=formcycle!fs_connected!--path=localhost --string --critical 'false'
167	167	}
168	168	{{/code}}
	176	+{{/table}}