{"id":18583529,"url":"https://github.com/maxdome/mxd-healthcheck","last_synced_at":"2025-05-16T05:09:46.019Z","repository":{"id":57305950,"uuid":"61203130","full_name":"maxdome/mxd-healthcheck","owner":"maxdome","description":"Provide healthcheck routes for load balancers and debugging","archived":false,"fork":false,"pushed_at":"2017-12-11T09:47:33.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-17T09:52:23.701Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxdome.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-15T11:33:05.000Z","updated_at":"2017-02-23T16:52:50.000Z","dependencies_parsed_at":"2022-09-06T19:40:27.441Z","dependency_job_id":null,"html_url":"https://github.com/maxdome/mxd-healthcheck","commit_stats":null,"previous_names":["maxdome/healthcheck"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxdome%2Fmxd-healthcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxdome%2Fmxd-healthcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxdome%2Fmxd-healthcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxdome%2Fmxd-healthcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxdome","download_url":"https://codeload.github.com/maxdome/mxd-healthcheck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254471049,"owners_count":22076587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T00:23:26.349Z","updated_at":"2025-05-16T05:09:46.001Z","avatar_url":"https://github.com/maxdome.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Example\n\n```\nconst { checkhelper, healthcheck } = require('mxd-healthcheck')(config, app);\n\nconst services = {};\nhealthcheck(services);\n```\n\n\n# Services\n\nList of check functions for the external services\n\n```\nconst service = (callback) =\u003e {\n  if (/* check if the external dependency is available like needed */) {\n    callback();\n  } else {\n    callback(/* reason why the external dependency is not OK */);\n  }\n}\n```\n\n\n# checkhelpers\n\nCheck functions for some common external services\n\n## BBE (= MMW)\n\n```\nconst service = checkhelper.bbe(/* connection config */);\n```\n\n## Healthcheck App (= Bifrost, Heimdall, Skidbladnir)\n\n```\nconst service = checkhelper.healthcheckApp(/* connection config */);\n```\n\n## Interfacemanager (= MMW-Proxy, = API)\n\n```\nconst service = checkhelper.interfacemanager(/* connection config */);\n```\n\n## Redis\n\n```\nconst service = checkhelper.redis(client, { read: true, write: true });\n```\n\n\n# Routes\n\n* `/health/app`: response only the status of the app without checking the external services\n* `/health/details`: response the reason instead of `ERROR` for the external serives\n* `/health/summary`: response only the status of the external services with `OK` and `ERROR` \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxdome%2Fmxd-healthcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxdome%2Fmxd-healthcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxdome%2Fmxd-healthcheck/lists"}