| ... |
... |
@@ -167,3 +167,39 @@ |
| 167 |
167 |
check_command check_jmx4perl!http://fc-test/jolokia/!de.xima.fc:type=MSMonitor,qualifier=formcycle!fs_connected!--path=localhost --string --critical 'false' |
| 168 |
168 |
} |
| 169 |
169 |
{{/code}} |
|
170 |
+ |
|
171 |
+== Frontend server monitoring URL == |
|
172 |
+ |
|
173 |
+{{version major="7" minor="1" /}} This feature is available since {{formcycle/}} version 7.1. |
|
174 |
+ |
|
175 |
+You can also use the following URL to monitor the status of the frontend server (available only on the master server): |
|
176 |
+ |
|
177 |
+{{code language="text"}} |
|
178 |
+ https://<domain>/<context>/monitor/fs/connection |
|
179 |
+{{/code}} |
|
180 |
+ |
|
181 |
+Due to security concerns, this URL is disabled by default. To enable it, you need to configure the [[application properties>>doc:Formcycle.SystemSettings.ConfigFiles.ApplicationProperties]] //monitoring.enabled// and //monitoring.allowed.hosts// according to your needs. |
|
182 |
+ |
|
183 |
+For example, when the {{formcycle/}} server can be reached via the domain //demo.company.org// via the context //formcycle//, the URL becomes //https://demo.company.org/formcycle/monitor/fs/connection//. |
|
184 |
+ |
|
185 |
+To identify the frontend server, you must either specify the name of the system frontend server via the parameter //name//, or its internal database ID via the parameter //id//: |
|
186 |
+ |
|
187 |
+{{code language="text"}} |
|
188 |
+ https://<domain>/<context>/monitor/fs/connection?name=MyFrontendServer |
|
189 |
+ https://<domain>/<context>/monitor/fs/connection?id=5963 |
|
190 |
+{{/code}} |
|
191 |
+ |
|
192 |
+Then you can make use of the following monitoring options: |
|
193 |
+ |
|
194 |
+* {{code language="plain"}}https://<domain>/<context>/monitor/fs/connection?name=<Name>{{/code}} |
|
195 |
+ |
|
196 |
+Checks whether the given frontend server is connected to the master server. Returns the HTTP status code //200// if connected, and //500// otherwise. |
|
197 |
+ |
|
198 |
+* {{code language="plain"}}https://<domain>/<context>/monitor/fs/connection?name=<Name>&action=connect{{/code}} |
|
199 |
+ |
|
200 |
+Attempts to establish a connection to the given frontend server. When the frontend server is already connected to the master server, no action is taken. Returns the HTTP status code //200// if the frontend server was already connected to the master or when the connection could be established successfully. Otherwise, returns the status code //500// when the connection could not be established. |
|
201 |
+ |
|
202 |
+* {{code language="plain"}}https://<domain>/<context>/monitor/fs/connection?name=<Name>&action=connect&force=true{{/code}} |
|
203 |
+ |
|
204 |
+Attempts to establish a connection to the given frontend server. When the frontend server is already connected to the master server, cuts the connection and attempts to reconnect to the frontend server. Returns the HTTP status code //200// when the connection could be estabslished successfully, and //500// when the connection could not be established. |
|
205 |
+ |
