ComputerScienceHouse / ComputerScienceHouse/conditional
Add Healthcheck route
- Ngôn ngữ chính
- Python
- Star
- 12
- Fork
- 39
- Merge trung bình
- 1 ngày 13 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
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.
```json
{
"ldap": {
"status": true,
"server": "stone.csh.rit.edu"
},
"database": {
"status": true,
"server": "mysql.csh.rit.edu"
}
}
```
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Không có tệp hoặc bài kiểm thử nào được nêu tên. Hãy bắt đầu bằng việc xác định cấu trúc route Flask hiện có và các entry point của kết nối LDAP và MySQL, sau đó triển khai hành vi GET /api/v1/healthcheck đã được chỉ định; công việc được xem là hoàn tất khi các phản hồi JSON không yêu cầu xác thực phân biệt được trạng thái khỏe mạnh, lỗi chỉ xảy ra với LDAP, lỗi chỉ xảy ra với cơ sở dữ liệu và lỗi kết hợp bằng các khoảng mã trạng thái được yêu cầu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- flask, mysql, python
- Lĩnh vực
- api, backend, observability
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100