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

Evaluate and implement comprehensive API monitoring

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
活発
技術スタック
python
領域
api, devops

調査の方向性

まず、issue に記載されている PolicyEngine API の操作を洗い出し、#2155 の route-group のカバレッジを含め、既存のホストレベルのチェックを確認します。列挙された要件に照らして、カスタム、セルフホスト、ホステッドの監視オプションを比較し、その後、判断、エンドポイントのカバレッジ、実装、通知、運用ガイダンス、および維持するチェックまたは先送りするチェックを文書化します。

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

説明

Problem

PolicyEngine needs functional monitoring across substantially more API behavior than the Better Stack free tier can cover. Existing host-level checks do not detect failures limited to particular route groups, and realistic calculation monitoring may require authenticated requests, response validation, and polling asynchronous operations.

Adding paid Better Stack coverage immediately would commit us to a service and recurring cost before we have compared it with an internally operated solution or other hosted products.

This issue supersedes #2155 and should preserve its required coverage while broadening the work to include option evaluation and platform design.

Objective

Evaluate and implement a cost-effective monitoring approach for PolicyEngine APIs. The selected approach may be:

  • a small custom service operated by PolicyEngine;
  • an existing self-hosted monitoring product; or
  • a paid hosted monitoring service, including Better Stack, if its cost and capabilities are the best fit.

Do not select an implementation until the alternatives have been compared against explicit requirements.

Investigation

  1. Inventory the API endpoints and complete user operations that need monitoring, including metadata, household, policy, user-profile, household-calculation, economy, and budget-window behavior.
  2. Define request frequency, acceptable response time, failure conditions, environments, and required geographic coverage.
  3. Determine requirements for:
    • public and authenticated requests;
    • safe test data and credential storage;
    • multi-request and asynchronous operations;
    • response status, content, and schema validation;
    • Slack failure and recovery notifications, including duplicate suppression;
    • execution history, latency reporting, and diagnostic evidence;
    • configuration stored in version control;
    • maintenance ownership, security updates, reliability, and data retention.
  4. Compare custom, self-hosted, and hosted approaches. Document expected recurring cost, implementation effort, operational burden, service limits, and vendor dependence.
  5. Prototype the leading candidates where documentation alone does not establish whether they satisfy the requirements.

Implementation

After recording the decision, implement the selected approach and migrate or supplement the existing checks. Monitoring should exercise representative successful operations with safe inputs rather than only checking API root responses.

Completion criteria

  • The requirements and endpoint coverage inventory are documented.
  • The alternatives and their expected costs and maintenance requirements are compared in writing.
  • The selected approach and reasons for selecting it are documented.
  • Required public, authenticated, and asynchronous API operations can be checked where applicable.
  • Failures and recoveries produce actionable Slack notifications without excessive duplicate messages.
  • Monitor definitions, credentials guidance, operating instructions, and ownership are documented.
  • Existing checks are retained, migrated, or deliberately removed with the reason recorded.
  • The route-group coverage previously tracked in #2155 is implemented or explicitly deferred in follow-up issues.
主要言語
Python
スター
18
フォーク
33
平均マージ
1日 4時間
マージ済み PR(30日)
21

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

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

はじめの一歩

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

PolicyEngine/policyengine-api のほかの issue

PolicyEngine/policyengine-api の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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