Publié initialement le 10 février 2020
La journalisation des limites de débit de l’API est maintenant en place depuis octobre 2019. Depuis lors, nous surveillons les journaux de limite de débit qui ont été générés. Nous avons également passé du temps à rencontrer de nombreux clients et partenaires pour discuter des données du journal. Ce qui suit est un résumé de la façon dont nous nous sommes adaptés en fonction de ce que nous avons appris.
En-têtes de réponse de l’API
Pour les sites Brightspace avec la limitation de débit API activée, chaque appel d’API Brightspace inclut désormais 3 données supplémentaires dans son en-tête de réponse :
X-Rate-Limit-Remaining - le nombre restant de crédits disponibles dans la minute en cours.
Remarque : Cette valeur n’est significative que sur les sites Brightspace sur les sites où la limitation de débit API est activée
X-Rate-Limit-Reset - fournit au développeur le temps, en secondes, jusqu’à ce que son compartiment se réinitialise.
X-Request-Cost - informe le développeur du nombre de crédits que coûte l’itinéraire actuel de l’API.
Pour certaines solutions, ces valeurs d’en-tête peuvent fournir un moyen d’éviter que chacun ne dépasse le seuil de limite de débit.
Activation de la limitation de débit pour les sites non en production - 9 mars 2020
Afin de fournir à tout le monde l’accès à un environnement Brightspace qui a limitation de débit activé, nous prévoyons de le faire sur tous Non-production Brightspace Sites le 9 mars 2020. Cela permettra à tous les clients et partenaires d’accéder à un site où ils peuvent :
- Créer un scénario de test où ils peuvent réellement dépasser un seuil de limite de débit et générer une erreur 429.
- Testez et utilisez le X-Rate-Limit-Remaining valeur d’en-tête de réponse (car cette valeur n’est significative que sur les sites où la limitation de débit API est activée).
IMPORTANT - Si vous ne souhaitez pas que la limitation de débit soit activée pour l’un de vos sites Brightspace non en production, veuillez contacter votre TAM D2L et/ou CSM avant le 9 mars.
Activer la journalisation incrémentielle - 2 mars 2020
Certains commentaires que nous avons reçus à plusieurs reprises indiquent que vous voulez savoir si et quand votre application API se rapproche de la valeur seuil de limitation de débit. Pour répondre à cette demande, nous avons ajouté une nouvelle fonctionnalité de « journalisation incrémentielle » à notre solution de limitation de débit. Notre plan est d’activer la journalisation incrémentielle le 2 mars 2020.
La journalisation incrémentielle générera des journaux de limite de débit lorsqu’une application API utilise plus de 30 000 crédits en une minute. Des journaux supplémentaires seront générés lorsque cette application API dépassera un multiple de 10 000 au-dessus du niveau de crédit initial de 30 000.
Par exemple, si une application API utilise 72 000 crédits en une minute, notre fonction de journalisation incrémentielle générera 5 journaux uniques : le premier lorsque l’application dépassera 30 000 crédits, le suivant lorsque l’application aura dépassé 40 000 crédits, le 3e pour 50 000 crédits, le 4e à 60 000 crédits et le dernier journal pour avoir dépassé 70 000 crédits.
La journalisation incrémentielle fournit deux points de données importants :
- Elle nous permet de déterminer quelles applications API « se rapprochent » du seuil de 50 000 crédits par minute.
- Pour les applications qui dépassent la limite de 50 000 crédits, la journalisation incrémentielle nous informe de la distance par rapport au seuil atteint par l’application.
Activation de la limitation de débit - Lundi, 8 juin 2020
Avant la publication de cet article, nous avions communiqué que nous activerions la limitation de débit en mai 2020. Sur la base de vos commentaires, nous avons décidé de reporter la date de mise en service au lundi 8 juin 2020 (pour tous les sites de production). La rétroaction générale était que mai est souvent un mois chargé pour la récupération des données de Brightspace via l’API.
Comme indiqué précédemment, si vous avez des préoccupations concernant l’activation de la limitation de débit de l’API, veuillez informer votre TAM D2L et/ou CSM. Incluez l’application API qui vous préoccupe ainsi que la raison pour laquelle vous ne souhaitez pas que la limitation de débit soit activée en juin.