telefonicaid / telefonicaid/iotagent-node-lib
[Improvemet] Add to healthcheck route the state of dependant services
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 62
- Forks
- 90
- Avg merge
- 2h 35m
- Merged PRs (30d)
- 1
Description
Component
Feature enhancement
Is your feature request related to a problem? Please describe
Right now, /iot/about does not provides any information regarding the status of the service.
Healthechek just verifies if status code 200 is returned, but it is possible the IoTA is still waiting for the MQTT broker or the IoTA Manager.
This is specially important during the startup or after a platform reboot.
Describe the solution you'd like
I propose a JSON response offering information about dependant seriveces. I.E:
{
"mongo":"ok",
"iotamanager":"ok",
"mqtt":"nok"
}
CC: @mrutid @rg2011
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the /iot/about healthcheck route and trace how its current HTTP 200 response is produced. Identify the existing checks or integrations for Mongo, IoT Agent Manager, and MQTT, then define the response status for each dependency; done means the route reports their states during startup or after a reboot.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100