github / github/app

Display API rate limiting details in health check

Đang mở
#2,470 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
2.1k
Fork
153
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

### Feature summary

Display GitHub API rate limiting (gh api rate_limit) details in the health check

### What problem are you trying to solve?

I hit GitHub API rate limits today which completely stopped me from working completely. The GitHub status page showed everything operational, but all my sessions were blocked due to "GitHub authorization needed". The built-in health check in the app reported that authorization was good for my account, which is weird. Trying to re-authorize my account always resulted in "failed to fetch user info after auth". I rebooted, same problem. I looked at the logs, and then saw that the call to fetch user info had failed due to API rate limiting.

If API rate limiting information had been displayed in the health check, I wouldn't have wasted time chasing the wrong problem. The rate limit info also includes the time at which the rate limit resets, so it's very useful to know if I just need to take a coffee break and for how long. It would also be useful to let me see if I'm using way too much API calls when I'm not supposed to.

### Proposed solution

Simply display the output from the gh api rate_limit command in the health check, that would certainly do the trick.

### Workflow impact

Critical - it stopped all my sessions and I couldn't get anything done.

### Installation context

_No response_

### Additional context

Image

Image

Image

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

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu từ health check tích hợp của app và theo dõi cách trạng thái ủy quyền GitHub được thu thập; sử dụng đầu ra của gh api rate_limit được mô tả trong issue làm tham chiếu. Được xem là hoàn tất khi health check hiển thị thông tin chi tiết về mức sử dụng rate limit và thời gian reset bên cạnh trạng thái ủy quyền, giúp thấy được các giới hạn khi chúng giải thích cho những yêu cầu GitHub thất bại.

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

Đánh giá

Công nghệ
github
Lĩnh vực
api, desktop
Loại issue
Tính năng
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
66/100

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.