Monitoring
– from [SCG 1 2107] –
The health check service allows administrators to check and monitor the availability and performance of an SCG instance and its internal components (backend, controller, Mongo controller, OpenVPN…) A health check request provides the overall status and the status of individual services as a result.
By default, the service is not active, but must first be started under Monitoring > Health check.
The health check is initially secured via an automatically generated token.
| 1 |
Activate health check |
|
| 2 |
Optional: Define individual password |
|
| 3 |
First save configuration, then click for a test request |
|
| 4 |
Output: Overall status and status of each component |
|
Upon request, the system generates status information in [JSON] format on all relevant components.
-
Status 0 means: No errors.
-
If the overall status is 0, all components are running.
-
The time stamp specifies from when a component is up / down.
Calling the health check service
For a call, an HTTP GET is executed on the health check URL with the configured token given with it.
Example with curl:
curl ‘https://<SCG URL>/healthcheck‘ -H ‘Connection: keep-alive’ -H ‘Authorization: Bearer <token>’ -H ‘Accept: application/json, text/plain’ --insecure
The following parameters are used:
| Parameter |
Description |
<SCG URL> |
URL of your Scout Cloud Gateway |
<token> |
Token or password as defined in the SCG WebAdmin Interface under Configuration > Monitoring
|
--insecure |
Needs to be specified if you use a Self-Signed certificate |
For example, if Open VPN is not running, the result is as follows:
{
"status": 1,
"backend": {
"status": 0,
"since": "Tue 2021-10-19 12:21:24 UTC; 1 weeks 2 days ago",
"message": "OK"
},
"controller": {
"status": 0,
"since": "Tue 2021-10-19 13:30:21 UTC; 1 weeks 2 days ago",
"message": "OK"
},
"mongod": {
"status": 0,
"since": "Tue 2021-10-19 12:20:58 UTC; 1 weeks 2 days ago",
"message": "OK"
},
"nginx": {
"status": 0,
"since": "Tue 2021-10-19 12:20:56 UTC; 1 weeks 2 days ago",
"message": "OK"
},
"openvpn": {
"status": 3,
"since": "Wed 2021-10-20 07:08:52 UTC; 1 weeks 1 days ago",
"message": "ERROR"
}
}
The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.
DIESER DIENST KANN ÜBERSETZUNGEN ENTHALTEN, DIE VON GOOGLE BEREITGESTELLT WERDEN. GOOGLE LEHNT JEDE AUSDRÜCKLICHE ODER STILLSCHWEIGENDE GEWÄHRLEISTUNG IN BEZUG AUF DIE ÜBERSETZUNGEN AB, EINSCHLIESSLICH JEGLICHER GEWÄHRLEISTUNG DER GENAUIGKEIT, ZUVERLÄSSIGKEIT UND JEGLICHER STILLSCHWEIGENDEN GEWÄHRLEISTUNG DER MARKTGÄNGIGKEIT, DER EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND DER NICHTVERLETZUNG VON RECHTEN DRITTER.
CE SERVICE PEUT CONTENIR DES TRADUCTIONS FOURNIES PAR GOOGLE. GOOGLE EXCLUT TOUTE GARANTIE RELATIVE AUX TRADUCTIONS, EXPRESSE OU IMPLICITE, Y COMPRIS TOUTE GARANTIE D'EXACTITUDE, DE FIABILITÉ ET TOUTE GARANTIE IMPLICITE DE QUALITÉ MARCHANDE, D'ADÉQUATION À UN USAGE PARTICULIER ET D'ABSENCE DE CONTREFAÇON.
ESTE SERVICIO PUEDE CONTENER TRADUCCIONES CON TECNOLOGÍA DE GOOGLE. GOOGLE RENUNCIA A TODAS LAS GARANTÍAS RELACIONADAS CON LAS TRADUCCIONES, TANTO IMPLÍCITAS COMO EXPLÍCITAS, INCLUIDAS LAS GARANTÍAS DE EXACTITUD, FIABILIDAD Y OTRAS GARANTÍAS IMPLÍCITAS DE COMERCIABILIDAD, IDONEIDAD PARA UN FIN EN PARTICULAR Y AUSENCIA DE INFRACCIÓN DE DERECHOS.
本服务可能包含由 Google 提供技术支持的翻译。Google 对这些翻译内容不做任何明示或暗示的保证，包括对准确性、可靠性的任何保证以及对适销性、特定用途的适用性和非侵权性的任何暗示保证。
このサービスには、Google が提供する翻訳が含まれている可能性があります。Google は翻訳について、明示的か黙示的かを問わず、精度と信頼性に関するあらゆる保証、および商品性、特定目的への適合性、第三者の権利を侵害しないことに関するあらゆる黙示的保証を含め、一切保証しません。
ESTE SERVIÇO PODE CONTER TRADUÇÕES FORNECIDAS PELO GOOGLE. O GOOGLE SE EXIME DE TODAS AS GARANTIAS RELACIONADAS COM AS TRADUÇÕES, EXPRESSAS OU IMPLÍCITAS, INCLUINDO QUALQUER GARANTIA DE PRECISÃO, CONFIABILIDADE E QUALQUER GARANTIA IMPLÍCITA DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM PROPÓSITO ESPECÍFICO E NÃO INFRAÇÃO.
