Development monitoring

[0oM4R]

Description

This package provides service monitoring; currently, check if the service is alive

ServiceMonitor class

• checkServiceAliveness : accepts array of IServiceAliveness and
  Creates an instance of ServiceMonitor.

  • services - An array of services to monitor.
  • interval - The interval, in minutes, between monitoring checks (default is 2 minutes)
  • retries - The number of retries in case a service is determined to be down (default is 2 retries).
  • retryInterval - The interval, in seconds, between retries (default is 2 seconds).
    This class have three public functions
  1. monitorService : Monitors the services at a regular interval and returns a function to exit and disconnect the monitoring.
  2. pingService: check the liveness of the services and disconnect
  3. disconnect: disconnect the services that have disconnect handler

ILivenessChecker Interface

each instance of the classes that implements ILivenessChecker interface have its own logic to create the connection and
check the service's aliveness

Evenets

we expose an instance of MonitorEventEmitter that make emitting events more easier

Changes

added new package monitoring

Related Issues

• Health check all of the 3rd party services #1469

Checklist

• Tests included
• Build pass
• Documentation
• Code format and docstrings
• Screenshots/Video attached (needed for UI changes)

[xmonader]

I don't uderstand why we didn't do it like this

class ServiceMonitor {

constructor(services: Array<IService>, interval) {
    ...
}
private checkLivenessOnce {

}
private checkHealthOnce {

}
monitor() {
    withInterval do your checkLivenessOnce and checkHealthOnce 
}

}

[mohamedamer453]

• Graphql module is not exported in index.ts and thus it cannot be used.

  

[mohamedamer453]

Would be great if a check for graphql was added to the example.

[AhmedHanafy725]

I am afraid about disconnecting the clients cause it's only one static instance per url on the client, so if it will be used in the dashboard it might disconnect the client while deploying something.

[AhmedHanafy725]

any package's name added to this sdk should start with @threefold/

[0oM4R]

i notice the license also is missing, which license should we use ?

[AhmedHanafy725]

no need to add this package if you are using tfchain client

[AhmedHanafy725]

why are we using TFClient here? it requires a mnemonic and a keypair type. Instead, we can use the queryClient which requires only the url