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ở
#43 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
30/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ệ
mysql, python
Lĩnh vực
api, backend, databases, infrastructure

Hướng nghiên cứu

Bắt đầu bằng cách xác định điểm vào API cho GET /api/v1/healthcheck và các đường dẫn kết nối cơ sở dữ liệu, LDAP và Proxmox hiện có. Hoàn thành có nghĩa là một phản hồi JSON không yêu cầu xác thực báo cáo từng dịch vụ, chỉ trả về 200 khi LDAP và cơ sở dữ liệu kết nối được, đồng thời sử dụng các phản hồi 5XX riêng biệt khi LDAP, cơ sở dữ liệu hoặc cả hai gặp lỗi.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

This should allow us to more reasonably monitor on whether or not proxtstar 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"
    },
    "proxmox": {
        "status": true
    },
}
Ngôn ngữ chính
Python
Star
31
Fork
25
Merge trung bình
3 giờ 59 phút
Pull request đã merge (30 ngày)
2

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

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

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.