Add Healthcheck route

未关闭
#261 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
flask, mysql, python
领域
api, backend, observability

调研方向

未指定文件或测试。首先定位现有的 Flask 路由结构以及 LDAP 和 MySQL 连接的入口点，然后实现指定的 GET /api/v1/healthcheck 行为；当未经身份验证的 JSON 响应能够使用所要求的状态码范围区分健康状态、仅 LDAP 故障、仅数据库故障和组合故障时，即表示完成。

由索引模型根据 Issue 内容生成。

描述

good first issue

This is a route that connects to the database, connects to ldap, and returns a json blob stating whether or not it can connect.

This should allow us to more reasonably monitor on whether or not conditional is in working order. The route should not be behind auth so datadog can hit it

How I want this to work

GET /api/v1/healthcheck

That would return 200 only when both ldap and the database connect correctly, and a 5XX range response when they don't. Different 5XX code for ldap down, sql down and both down. Return the json no matter what the status code is.

{
    "ldap": {
        "status": true,
        "server": "stone.csh.rit.edu"
    },
    "database": {
        "status": true,
        "server": "mysql.csh.rit.edu"
    }
}
主要语言
Python
星标
12
派生
40
平均合并
1 天 2 小时
30 天内合并 PR
2

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

ComputerScienceHouse/conditional 的其他 Issue

查看 ComputerScienceHouse/conditional 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。