Cette page a été traduite par l'API Cloud Translation.

Créer des rapports personnalisés

Vous consultez la documentation Apigee Edge.
Consulter la documentation d'Apigee X en savoir plus

Les rapports personnalisés vous permettent d'explorer des métriques spécifiques de l'API et d'afficher les données exactes que vous souhaitez voir. À partir des tableaux de bord de surveillance d'API, vous pouvez créer un rapport personnalisé avec le filtre et les métriques prédéfinis en fonction des conditions configurées au moment de la création. En outre, un ensemble de dimensions et métriques par défaut est configuré dans le rapport pour vous.

Créez un rapport personnalisé basé sur votre contexte

Créez rapidement des rapports personnalisés en fonction de votre contexte, comme résumé dans le tableau suivant. Sur la page Rapports personnalisés, les rapports personnalisés créés à l'aide de l'API Monitoring sont nommés de manière unique (par défaut), comme indiqué dans le tableau. Vous pouvez changer le nom lorsque vous modifiez le rapport personnalisé.

Contexte du rapport personnalisé	Convention d'attribution de noms par défaut pour les rapports personnalisés
Tableau de bord récent	`API Monitoring Recent Generated`
Tableau de bord de la chronologie	`API Monitoring Timeline Generated`
Examiner le tableau de bord	`API Monitoring Investigate Generated`
Condition d'alerte	`API Monitoring Generated: alert-name`

Dimension et métriques par défaut

Le rapport personnalisé comprendra les dimensions et les métriques répertoriées dans le tableau suivant pour tous les rapports générés par API Monitoring, par défaut.

Composant	Valeurs par défaut
Dimensions	URI de la requête
Métriques	Temps de réponse total Temps de réponse cible Erreurs de proxy Erreurs de cible

Modifier le rapport personnalisé

Comme indiqué dans la section précédente, un ensemble prédéfini de dimensions et métriques par défaut d'API Monitoring est préconfiguré dans des rapports personnalisés. Une fois qu'il est créé, vous pouvez modifier le rapport personnalisé pour ajouter ou supprimer des mesures et des dimensions, selon vos besoins. Par exemple, vous pouvez limiter votre enquête à un jeton d'accès, une application de développeur, un proxy d'API ou un ID de demande en particulier.

Dans le rapport personnalisé suivant, vous ajoutez la dimension Gateway Flow ID prédéfinie, où Gateway Flow ID contient l'UUID unique de chaque requête API envoyée à Edge. Notez que le rapport utilise déjà la dimension Request URI:

L'exemple suivant ajoute la dimension Client ID au rapport personnalisé. La dimension Client ID contient la clé client (clé API) du développeur effectuant l'appel d'API, qu'elle soit transmise dans la requête en tant que clé API ou incluse dans un jeton OAuth:

Le rapport personnalisé contient des informations sur toutes les valeurs Client ID. L'exemple suivant ajoute un filtre afin que vous puissiez créer un rapport personnalisé pour un Client ID spécifique:

Pour plus d'informations sur toutes les dimensions et métriques prédéfinies que vous pouvez ajouter à un rapport, consultez Référence des métriques, dimensions et filtres Analytics.

Dans l'exemple suivant, vous ajoutez un filtre à un rapport personnalisé qui capture les métriques et les dimensions par défaut pour le code d'erreur policies.ratelimit.QuotaViolation et les codes d'état 5xx:

Pour plus d'informations sur la modification d'un rapport personnalisé, voir Gérer les rapports personnalisés.

Exemple: utiliser des rapports personnalisés pour diagnostiquer les problèmes de déploiement

Associez la stratégie StatisticsCollecteor à vos proxys d'API pour collecter des données d'analyse personnalisées, telles que l'ID utilisateur ou produit, le prix, l'action REST, la version cible, l'URL cible et la longueur du message. Les données peuvent provenir de variables de flux prédéfinies par Apigee, d'en-têtes de requête, de paramètres de requête ou de variables personnalisées que vous définissez.

Par exemple, les requêtes adressées à votre proxy d'API incluent des en-têtes pour l'ID produit, l'ID utilisateur et la version du serveur cible. Cette demande peut se présenter sous la forme suivante:

curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi

Vous pouvez ensuite utiliser les informations des en-têtes pour faciliter le diagnostic des problèmes d'exécution avec votre proxy d'API.

Pour créer un rapport personnalisé pour ces en-têtes:

Ajoutez la règle StatisticsCollecteor à votre API pour capturer la valeur des en-têtes personnalisés:

<StatisticsCollector name="publishPurchaseDetails">
  <Statistics>
    <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic>
    <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic>
    <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic>
  </Statistics>
</StatisticsCollector>

Déployez votre proxy et prévoyez un délai d'accès.

REMARQUE
Il faut environ 30 minutes pour qu'une nouvelle dimension personnalisée soit ajoutée à la base de données une fois que la règle StatisticsCollector a été appelée pour la première fois dans chaque environnement. Par exemple, si un proxy StatisticsCollector est appelé dans l'environnement test, les données de cette dimension personnalisée commencent à être disponibles dans l'environnement test dans les 30 minutes qui suivent. La dimension personnalisée s'affiche dans la liste déroulante des dimensions dans les rapports personnalisés.

Si ce proxy StatisticsCollector est appelé depuis l'environnement prod, il faut environ 30 minutes avant que les données de cette dimension personnalisée ne soient disponibles dans l'environnement prod. Par la suite, les données sont disponibles après le même intervalle de temps que les autres dimensions.
Cliquez sur Analyser > Surveillance des API > Récent dans l'interface utilisateur Edge pour afficher les problèmes liés à votre API. Notez que vous obtenez des erreurs 4xx et 5xx pour le proxy myapi:
Sélectionnez la ligne du proxy myapi pour afficher plus de détails dans le volet de droite du tableau de bord récent.
Dans le volet de droite du tableau de bord Récent, sélectionnez > Afficher dans Enquêter pour accéder au tableau de bord Enquêter:
Filtrez le tableau de bord Investigate par le proxy myapi, puis affichez le Code d'état dans le graphique supérieur. Notez que vous obtenez des erreurs 403 et 501:
Dans l'interface utilisateur Edge, sélectionnez Analytics > Rapports personnalisés > Rapports pour créer un rapport personnalisé qui inclut les valeurs de ces mesures personnalisées en tant que dimension.

Remarque: Vous pouvez également créer un rapport personnalisé directement à partir des tableaux de bord Récent, Chronologie et Enquêter. Toutefois, ces rapports n'incluront pas par défaut vos données d'analyse personnalisées, mais vous pouvez les ajouter.
Sélectionnez + Rapport personnalisé pour créer un rapport personnalisé nommé myapi_errors.
Sélectionnez Proxy errors (Erreurs de proxy) pour la métrique, puis définissez Aggregate Function (Fonction d'agrégation) sur Sum (Somme). Vous pouvez ajouter d'autres métriques si vous le souhaitez.
Sélectionnez la dimension prédéfinie Code d'état des réponses, puis ajoutez les trois statistiques personnalisées prodid, targetersion et userid aux dimensions:
Définissez le filtre pour n'inclure que les données du proxy d'API myapi (apiproxy eq 'myapi'):
Enregistrez le rapport.
Générez le rapport pour les dernières 24 heures. Lorsque le rapport s'ouvre pour la première fois, un graphique des erreurs HTTP 403 et 501 s'affiche:
Sous Récapitulatif, cliquez sur 403 ou 510 pour voir le produit à l'origine des erreurs. Par exemple, vous sélectionnez 403:
Cliquez sur un ID produit sous Résumé pour afficher les erreurs par version cible (alpha ou bêta):
Cliquez sur une version cible sous Résumé pour afficher les erreurs par utilisateur: