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

Evaluate and implement comprehensive API monitoring

Đang mở
#3,816 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
api, devops

Hướng nghiên cứu

Bắt đầu bằng việc lập danh mục các thao tác API của PolicyEngine được nêu trong issue và xem xét các kiểm tra cấp máy chủ hiện có, bao gồm độ bao phủ nhóm route từ #2155. So sánh các tùy chọn giám sát tùy chỉnh, self-hosted và hosted với các yêu cầu được liệt kê, sau đó ghi lại quyết định, độ bao phủ endpoint, việc triển khai, thông báo, hướng dẫn vận hành và các kiểm tra được giữ lại hoặc hoãn lại.

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

Mô tả

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.
Ngôn ngữ chính
Python
Star
18
Fork
33
Merge trung bình
1 ngày 4 giờ
Pull request đã merge (30 ngày)
21

Hướng dẫn đóng góp

Mở 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 PolicyEngine/policyengine-api

Tất cả issue của PolicyEngine/policyengine-api

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.