Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Add Healthcheck route

オープン
#43 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
30/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
mysql, python
領域
api, backend, databases, infrastructure

調査の方向性

まず、GET /api/v1/healthcheck の API エントリポイントと、既存のデータベース、LDAP、Proxmox への接続経路を特定します。未認証の JSON レスポンスで各サービスを報告し、LDAP とデータベースの両方に接続できた場合にのみ 200 を返し、LDAP、データベース、またはその両方が失敗した場合にはそれぞれ異なる 5XX レスポンスを使用すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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
    },
}
主要言語
Python
スター
31
フォーク
25
平均マージ
3時間 59分
マージ済み PR（30日）
2

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ComputerScienceHouse/proxstar のほかの issue

ComputerScienceHouse/proxstar の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。