ComputerScienceHouse / ComputerScienceHouse/packet

Add Healthcheck Route

Đang mở
#215 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
good first issue python
Ngôn ngữ chính
Python
Star
25
Fork
33
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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 packet is up

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
```json
{
"ldap": true,
"database": true
}
```
Return the json no matter what the status code is.
Even better would be
```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

Bắt đầu bằng cách xác định phần đăng ký route của Flask và các helper kết nối cơ sở dữ liệu và LDAP hiện có. Thêm GET /api/v1/healthcheck, trả về JSON cho mọi kết quả, với các phản hồi 5XX riêng biệt khi LDAP, cơ sở dữ liệu hoặc cả hai bị lỗi, và xác minh rằng phản hồi khi khỏe mạnh báo cáo cả hai dependency.

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, sqlalchemy
Lĩnh vực
api, backend, databases, security
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
38/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.