Changes for page Monitoring

From version < 2.1 >

edited by gru
on 15.03.2019, 15:28

To version < 9.1

edited by sas
on 01.06.2021, 14:03

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1
          +1,1 @@
--$services.localization.render("PT.Main.Monitoring")
++Monitoring

Author

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

Content

@@ -6,84
          +6,86 @@
  The beans are registered under the following names:
++; Frontend-Server
++: de.xima.fc:type=FSMonitor,qualifier=<contextName>
++; Master-Server
++: de.xima.fc:type=MSMonitor,qualifier=<contextName>
--* {{litem title="{{fserver/~}~}"}}de.xima.fc:type=FSMonitor,qualifier=<contextName> {{/litem}}
--* {{litem title="{{mserver/~}~}"}} de.xima.fc:type=MSMonitor,qualifier=<contextName> {{/litem}}
++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//.
--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]].
++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.
--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.
++{{table dataTypeAlpha="0" preSort="0-asc" caption="Overview of the settings for MSMonitor (master server)"}}
++|=Attribute|=Description|=Possible options
++|running|Whether the {{mserver/}} has been started successfully.|true/false
++|db_connected|Whether the {{mserver/}} could establish a connection to the database.|true/false
++|fs_connected|A map of the names of all {{fserver number="plural"/}} and whether they are connected to this master server|__Key:__ <serverName>
++__Return value:__ true/false
++|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>
++__Return value:__ true/false
++|fs_status|A map of the names of all {{fserver number="plural"/}} and the connection status of that server.|__Key:__ <serverName>
++__Return values:__ CONNECTED, NOT_CONNECTED, ERROR, RECONNECTING, DISCONNECTING , CONNECTING, AUTHENTICATING, WAIT_FOR_CONNECTION
++|fs_disconnected_count|The number of {{fserver number="plural"/}} not connected to this {{mserver/}}|A non-negative number
++|fs_connected_count|The number of {{fserver number="plural"/}} connected to this {{mserver/}}|A non-negative number
++|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
++|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)
++__Return value:__ true/false
++|connect_frontendserver_by_id|Triggers a connection to the frontend server by id.|__Key:__ <serverName>, true/false to trigger reconnect always (no matter if there is a connection)
++__Return value:__ true/false
++{{/table}}
--=== {{mserver/}} (MSMonitor) ===
--
--{{table caption="Overview of the settings for MSMonitor" dataTypeAlpha="0" preSort="0-asc"}}
--|=Key|=Description|=Possible options
--|running|Whether the {{mserver/}} has been started successfully.|true ~| false
--|db_connected|Whether the {{mserver/}} could establish a connection to the database.| true ~| false
--|fs_connected|A map of the names of all {{fserver number="plural"/}} and whether they are connected to this {{mserver/}}|<serverName> : true ~| false
--|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
--|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
--|fs_disconnected_count|The number of {{fserver number="plural"/}} not connected to this {{mserver/}}|A non-negative number.
--|fs_connected_count|The number of {{fserver number="plural"/}} connected to this {{mserver/}}|A non-negative number.
++{{table dataTypeAlpha="0" preSort="0-asc" caption="Overview of the settings for FSMonitor (frontend server)"}}
++|=Attribute|=Description|=Possible options
++|running|Whether the {{fserver/}} has been started successfully.|true/false
++|connected|Whether this {{fserver/}} is connected to a {{mserver/}}.|true/false
++|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
++|status|The connection status of this {{fserver/}}.|CONNECTED, NOT_CONNECTED, ERROR, RECONNECTING, DISCONNECTING, CONNECTING, AUTHENTICATING, WAIT_FOR_CONNECTION
++|restart|Triggers a restart of the frontend server.|None
  {{/table}}
--=== {{fserver/}} (FSMonitor) ===
--
--{{table caption="Overview of the settings for FSMonitor" dataTypeAlpha="0" preSort="0-asc"}}
--|=Key|=Description|=Possible options
--|running|Whether the {{fserver/}} has been started successfully.|true ~| false
--|connected|Whether this {{fserver/}} is connected to a {{mserver/}}.|true ~| false
--|status|The connection status of this {{fserver/}}.|CONNECTED ~| NOT_CONNECTED ~| ERROR ~| RECONNECTING ~| DISCONNECTING ~| CONNECTING ~| AUTHENTICATING ~| WAIT_FOR_CONNECTION
--
  == JSON REST API ==
--The monitoring beans can also be accessed via a JSON REST API. It can be accessed as follows:
++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"]].
++A possible call, after installation of Jolokia, looks like the following:
++
  {{info}}
--http://localhost/formcycle/monitoring/read/de.xima.fc:type=MSMonitor,qualifier=formcycle
++[[http:~~/~~/localhost/jolokia/read/de.xima.fc:type=MSMonitor,qualifier=formcycle>>http://localhost/jolokia/read/de.xima.fc:type=MSMonitor,qualifier=formcycle]]
  {{/info}}
--=== JSON response ===
++(% class="wikigeneratedid" id="HJSONresponse" %)
++JSON response:
  {{code language="JSON"}}
  {
--"timestamp":1440603508,
--"status":200,
--"request":{
--   "mbean":"de.xima.fc:qualifier=formcycle,type=MSMonitor",
--   "type":"read"
--},
--"value":{
--   "fs_active":{
--      "sas":true,
--      "localhost":false,
--      "mko":true
--   },
--   "fs_connected":{
--      "sas":false,
--      "localhost":false,
--      "mko":false
--   },
--   "db_connected":true,"fs_status":{
--      "sas":"ERROR",
--      "localhost":"NOT_CONNECTED",
--      "mko":"ERROR"
--   },
--   "fs_disconnected_count":3,
--   "fs_connected_count":0,
--   "running":true
--   }
++  "request": {
++    "mbean": "de.xima.fc:qualifier=formcycle,type=MSMonitor",
++    "type": "read"
++  },
++  "value": {
++    "running": true,
++    "failed_login_count": 0,
++    "fs_active": {
++      "localhost": true
++    },
++    "db_connected": true,
++    "fs_connected_count": 1,
++    "fs_connected": {
++      "localhost": true
++    },
++    "fs_disconnected_count": 0,
++    "fs_status": {
++      "localhost": "CONNECTED"
++    }
++  },
++  "timestamp": 1579186291,
++  "status": 200
  }
  {{/code}}
--=== URL ===
++(% class="wikigeneratedid" %)
++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"]].
--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"]].
--
--{{warning}}
--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}}.
--{{/warning}}
--
  == Nagios integration ==
  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.
@@ -95,7
          +95,7 @@
  {{/info}}
  {{panel title="Command" fullwidth="true" initial="hidden" triggerable="true"}}
--{{code}}
++{{code language="none"}}
  define command{
   command_name          check_jmx4perl
   command_line          check_jmx4perl --url $ARG1$ --mbean $ARG2$ --attribute $ARG3$ $ARG4$
@@ -104,9
          +104,9 @@
  {{/panel}}
  {{panel title="Service definitions" fullwidth="true" initial="hidden" triggerable="true"}}
--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.
--
--{{code}}
++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>
++<br>
++{{code language="none"}}
  define service{
   use                  generic-service
   host_name            localhost
@@ -117,7
          +117,7 @@
  {{/panel}}
  {{panel title="Querying the database connection status of the {{mserver/~}~}" fullwidth="true" initial="hidden" triggerable="true"}}
--{{code}}
++{{code language="none"}}
  define service{
   use                  generic-service
   host_name            localhost
@@ -128,7
          +128,7 @@
  {{/panel}}
  {{panel title="Querying whether the {{fserver/~}~} localhost is connected to the {{mserver/~}~}" fullwidth="true" initial="hidden" triggerable="true"}}
--{{code}}
++{{code language="none"}}
  define service{
   use                  generic-service
   host_name            localhost
@@ -139,7
          +139,7 @@
  {{/panel}}
  {{panel title="Querying the {{fserver/~}~} whether it is connected to a {{mserver/~}~}" fullwidth="true" initial="hidden" triggerable="true"}}
--{{code}}
++{{code language="none"}}
  define service{
   use                  generic-service
   host_name            localhost
@@ -165,7
          +165,7 @@
  When Jolokia is run parallel to {{formcycle/}}, the connection to the {{fserver/}} //localhost// must be modified as follows:
--{{code}}
++{{code language="none"}}
  define service{
   use                  generic-service
   host_name            fc-test
@@ -173,4
          +173,3 @@
   check_command        check_jmx4perl!http://fc-test/jolokia/!de.xima.fc:type=MSMonitor,qualifier=formcycle!fs_connected!--path=localhost --string --critical 'false'
  }
  {{/code}}
--{{/table}}

Changes for page Monitoring

Summary

Details

Navigation