Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Introduction

This article describes how the CoreOne services can be monitored.

Usage

This information can be used for normal system monitoring as well as for load balancing and high availability functions. This should help our customers who would like monitor by theirself the application. Please do not forget to duplicate the monitoring system on all nodes if the application is deployed in a high availability deployment scenario. This System monitoring recommendations is not including a rudimentary server monitoring like CPU, RAM or disk usage. This is of course also recommended.

Components you should monitor

Windows Services

We recommend to monitor the state of the following Windows Services:

  • World Wide Web Publishsing Service (IIS)

  • CoreOne Suite

  • CoreOne Suite System Connector

  • MySQL

App Pools and Sites

Please monitor the state of all App Pools and Sites starting with CoreOne*

Health Check functions

The following functions can be called like normal HTTP GET call:

Service

URL

Answer OK

Answer ERROR

What is being tested?

Description

CoreOne Authentication Services

https://${authenticationUrl}/health

HTTP 200

HTTP 500

HTTP 404

  • Database Connection

  • Application Service API

  • Discovery Document


CoreOne Authentication Services

https://${authenticationUrl}/health/details

HTTP 200


HTTP 200 

HTTP 404

HTTP 500


  • Database Connection

  • Application Service API

  • Internal Services

Gives a 200 answer with a detailed list of which subsystems work and which do not. The 200 also appears when subsystems are not available. The content is intended for graphical assessment by system administrators.

The 404 and 500 message appears if, for example, .NET Core hosting is missing on the system.

CoreOne Authentication Services

https://${authenticationUrl}/health/authenticationservice

HTTP 200

HTTP 500

HTTP 404

  • Database Connection

  • Internal Services

This checks the same connections as the /health/details but without the API-Connection.

This is used to check the connection from the Backend- to the Auth-Server.

CoreOne Web Service

https://${webUrl}/health

HTTP 200

HTTP 500

HTTP 404

  • Application Service Health

  • Application Service API

  • Authentication Service Health


CoreOne Web Service

https://${webUrl}/health/details

HTTP 200

HTTP 200 

HTTP 404

HTTP 500

  • Application Service Health

  • Application Service API

  • Authentication Service Health

Gives a 200 answer with a detailed list of which subsystems work and which do not. The 200 also appears when subsystems are not available. The content is intended for graphical assessment by system administrators.

The 404 and 500 message appears if, for example, .NET Core hosting is missing on the system.

CoreOne Self-Service Portal

https://${portalUrl}/health

HTTP 200

HTTP 500

HTTP 404

  • Authentication Service API

  • Application Service Health

CoreOne Self-Service Portal

https://${portalUrl}/health/details

HTTP 200

HTTP 200 

HTTP 404

HTTP 500

  • Authentication Service API

  • Application Service Health

CoreOne Application Services

http://${applicationUrl}:7000/health

HTTP 200

HTTP 500

HTTP 404

  • Service is up and running (Implies Database Connectivity)


CoreOne Application Interface

https://${applicationUrl}:8000/api/Health

HTTP 200

HTTP 500

HTTP 404

  • Validates the access token (Implies that the Authentication Servier is running)

CoreOne Database Services

We recommend to monitor the database instance you are using for the CoreOne Database Services. Depending on the database you use, the parameters to monitor may vary. Here is an example list of metrics to track for an MySQL database:

...

We also recommend to observe the Backup Process of MySQL. You could check the file size of the backup and the timestamp.

Errors in Logs & Tasks

We recommend to observe the Log’s for Errors. A corrupt import or if you delete objects in a target system, can generate a lot of errors and affect the performance. An overview of Log-Files can be found here: Logs

...

Please get in touch with us, if you want to observe the tasks- and log_log-Table with a read only user.

Appendix

Some monitoring systems are not able to check all these components directly. You can use workarounds like Powershell and Windows Task Scheduler to create a monitoring-text-file. Then you can check this text file content (please do not forget to check the age of the text-file with the monitoring - this way you make sure, the values are up to date). If you need assistance with that, we are happy to help you.

Please also make sure to keep a documentation of what to do, if the monitoring check state is not in a accepted condition.

Detailed monitoring

The health checks listed above only provide information about whether the relevant Services are available, started and operational. The checks do not provide any information about internal processes, pending processes or the like.

...