Microservice status monitoring: The web application should display the status of all OpenCRVS microservices. It should indicate whether each microservice is running or down.

[euanmillar]

Must react to local and deployed environments as Kibana isnt running locally.

Should display information about environment:

• Thumbs up or down for all our microservices. If any are down, then the instruction is to go to Kibana to check logs

• Should also show status information about our dependencies: specifically Kibana, Elasticsearch, Influx, Minio and MongoDB

• See our component library for design inspiration. When your stack is running locally, visit http://localhost:6060

• [x] Bootstrap a package called "healthcheck" - NextJS Typescript app using our component library: https://github.com/opencrvs/opencrvs-core/pull/4673

• [x] Amend the healthcheck to work for every microservice; it's currently lacking "documents", "config" & "webhooks". Extend the gateway healthCheck handler, SERVICES_TO_CHECK prop to include 3 more services. “webhooks”, “config” and “documents” microservices are not listed. Health check “ping” route and handler may need to be written for these 3 services.

• [x] Amend the /ping endpoint for each service to return the current git hash / version tag from an environment variable

• [ ] Amend the /ping endpoint for each service to return the status of any related dependency. Refer to this diagram:

• [x] Amend all microservices and Farajaland repo in docker-composes to have an environment variable for the git hash / version tag being deployed.
• [ ] Amend the gateway /ping service to return a payload like this. The reason why the endpoints aren't pinged directly by Next.js, is that the Next.js application can later be externally deployed. The /ping endpoint can be renamed to /health

  
  GET gateway.opencrvs.org/api/health

If everythings ok = status 200 Otherwise = status 500

{ dependencies: { mongo: { status: 'ok', response: { something: 'here' } }, elasticsearch: { status: 'error', logs: '................................................NOT WORKING..................', response: { something: 'here' } }, influxdb: {} } services: { metrics: { image: 'opencrvs_metrics:2342342', status: 'ok', response: { environment: 'PRODUCTION' | 'DEV', qa: true, something: 'here' }
} } }

[euanmillar]

Hey @asaphirabaruta @shemalucien I’m using Zenhub in GitHub, click this link to join my workspace and see other features available in GitHub or download the Zenhub extension and sign up with your GitHub account. Posted using Zenhub