Skip to content

Monitoring

Monitoring the state of the Windows service

The sedex Client’s processes can be monitored or controlled at the operating system level, like any other Windows service.

Once a sedex Client has been installed as a Windows service, it can be monitored and controlled via the Windows Service Manager (Start, Stop, etc.).

Monitoring page

The sedex Client’s monitoring page provides information about the sedex Client’s current operational state. This page can be used by the system engineers to monitor the sedex Client.

The monitoring page can be accessed in two ways:

  1. Via the network using HTTP

    The sedex Client exposes the monitoring page via a network port which is configurable. See the configuration file of an installation to determine the port in use. Default value is 8000.

    Monitoring URL: http://<HOST>:<MONITORING_PORT>/monitoring

    Example: http://localhost:8000/monitoring

  2. Via the file system

    The sedex Client exposes the monitoring page via text file in the file system which is configurable. See the configuration file of an installation to determine where the monitoring page is written to. Default value is <sedex_home>\monitoring.

    Monitoring Path: <sedex_home>\monitoring\monitoring.txt

Example of the sedex Client’s monitoring page:

    #####################################
    ### sedex client monitoring       ###
    ### Status at 2023-08-11T08:42:31 ###
    #####################################
    adapter-uptime=00:01:01
    adapter-version=Adapter 7.0.x
    adapter-sedexId=1-123-1
    adapter-profile=small
    adapter-organisationCertificateExpirationDate=2025-04-20T14:09:05
    adapter-interfaceFoldersPresent=OK
    adapter-moveToWorkingFolder=OK
    adapter-connectionToSedexServer=OK
    adapter-lastConnectionCheck=2023-08-11T08:41:31
    adapter-writeAccessToDatabase=OK
    adapter-incoming-message-interface-default=file-system
    adapter-incoming-message-interface-number-of-rules-via-file-system=0
    adapter-incoming-message-interface-number-of-rules-via-rest-api=0
    adapter-incoming-message-interface-number-of-rules-with-errors=0
    adapter-messaging-rest-api-number-of-messages-in-virtual-inboxes-in-total=0
    adapter-messaging-rest-api-interface-enabled=true
    adapter-messaging-encryption-in-client-filesystem-enabled=true
    wsproxy-https-port=8443
    wsproxy-https-tls-certificate-subject=CN=sedex-wsproxy, O=sedex (www.sedex.ch)
    wsproxy-https-tls-certificate-issuer=CN=sedex-wsproxy, O=sedex (www.sedex.ch)
    wsproxy-https-tls-certificate-create-date=2023-08-11T08:41:33
    wsproxy-https-tls-certificate-expiry-date=2028-08-09T08:41:33
    wsproxy-https-tls-certificate-alternative-names=ip6-localhost,localhost,ubuntu
    wsproxy-https-tls-certificate-is-valid=true
    wsproxy-http-disabled=false
    wsproxy-http-port=8080
    wsproxy-uptime=00:00:56
    wsproxy-users-allow-anonymous=true
    wsproxy-user-configuration-number-error=0
    wsproxy-user-configuration-number-ok=0
    wsproxy-user-configuration-processed-at=2023-08-11T08:41:35
    wsproxy-version=WsProxy 7.0.x
    wsproxy-webservice-definitions-updated-at=2023-08-11T08:41:35
    wsproxy-webservice-definitions-expires-at=2023-08-18T08:41:35
    wsproxy-webservice-definitions-update-status=OK
    wsproxy-webservice-definitions-update-info=Updated successfully
    wsproxy-webservice-definitions-valid=true
    wsproxy-webservice-last-call=
    controller-uptime=00:01:00
    controller-version=Controller 7.0.x
    controller-updateCertificateExpirationDate=2024-06-04T14:45:29
    client-version=Sedex-Client 7.0.x
    monitor-lastCheckUp=2023-08-11T08:42:31
    #####################################
    ### WSProxy
    ###
    ### Webservice configuration
    ###
    #####################################
    wsproxy-webservice-CheckSedexWebService-address-http=
    http://localhost:8080/wsproxy/services/CheckSedexWebService
    wsproxy-webservice-CheckSedexWebService-address-https=
    https://localhost:8443/wsproxy/services/CheckSedexWebService
    wsproxy-webservice-CheckSedexWebService-users=anonymous, authenticated
    wsproxy-webservice-CheckSedexWebService-target=
    https://sedex-service.admin.ch:443/sedex-clientServices-ws/CheckSedexWebService
    [..]

Tips on how to use the Monitoring page:

  • Include regular automatic checks of the monitoring page in your automatic monitoring tool like Nagios, Icinga, Zabbix, etc.
  • The monitoring page is regenerated every 5 minutes by the sedex Client. The creation date is contained in both the header of the page and in the following key: monitor-lastCheckUp=2019-12-04T13:21:39
  • Before evaluating specific keys on this page, make sure that the page is up-to-date by making sure that the value of the key monitor-lastCheckUp is not older than e.g. 6 minutes.

  • It is recommended to include at least the following automatic checks in your monitoring:

    • adapter-connectionToSedexServer=OK

      → the sedex Client can connect to the sedex server

    • adapter-uptime=00:06:01

      → the sedex Adapter component (messaging) is running

    • wsproxy-uptime=00:05:55

      → the optional sedex Web Service Proxy is running

    • wsproxy-webservice-definitions-update-status=OK

      → the optional sedex Web Service Proxy can update its configuration

  • Depending on the situation it may be useful to check further keys/values.