Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add Healthcheck Route

Đang mở
  • Có gì không ổn?
#215 1 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
38/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, sqlalchemy
Lĩnh vực
api, backend, databases, security

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.

Mô tả

good first issue python

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

{
    "ldap": true,
    "database": true
}

Return the json no matter what the status code is.
Even better would be

{
    "ldap": {
        "status": true,
        "server": "stone.csh.rit.edu"
    },
    "database": {
        "status": true,
        "server": "mysql.csh.rit.edu"
    },
}
Ngôn ngữ chính
Python
Star
25
Fork
33
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

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/packet

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

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.