github / github/app

Display API rate limiting details in health check

Abierto
#2,470 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Sin datos de lenguaje
Estrellas
2.1k
Forks
153
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

### 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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza por la comprobación de estado integrada de la aplicación y sigue cómo se recopila el estado de autorización de GitHub; utiliza como referencia la salida de gh api rate_limit descrita en la issue. Se considera terminado cuando la comprobación de estado muestra los detalles del uso del rate limit y de la hora de restablecimiento junto al estado de autorización, haciendo visibles los límites cuando explican las solicitudes fallidas a GitHub.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github
Área
api, desktop
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
66/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.