Add Healthcheck route

Đang mở
#261 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
flask, mysql, python
Lĩnh vực
api, backend, observability

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.

Mô tả

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"
    }
}
Ngôn ngữ chính
Python
Star
12
Fork
40
Merge trung bình
1 ngày 13 giờ
Pull request đã merge (30 ngày)
1

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

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ComputerScienceHouse/conditional

Tất cả issue của ComputerScienceHouse/conditional

Issue tương tự

Thêm issue về Python

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.