Créer et gérer des rapports personnalisés

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Les rapports personnalisés vous permettent d'explorer des métriques spécifiques de l'API et de choisir les données exactes à afficher. Vous pouvez créer un rapport personnalisé à l'aide de l'une des métriques et dimensions intégrées à Apigee.

Il existe deux types de rapports personnalisés :

  • Rapports en temps réel (également appelés rapports synchrones) : lorsque vous spécifiez les paramètres de rapport dans l'interface utilisateur d'Apigee, les rapports en temps réel s'affichent dans l'interface en quelques minutes.
  • Jobs de création de rapports (également appelés rapports asynchrones) : pour les jobs de création de rapports, vous demandez le rapport et récupérez les résultats ultérieurement.

Consultez la section Rapports en temps réel ou jobs de création de rapports.

Disponibilité des rapports personnalisés

Si vous êtes client Apigee avec abonnement, l'accès à Apigee API Analytics et à la fonctionnalité de rapport personnalisé sont inclus dans vos droits d'abonnement et activés automatiquement pour chacun de vos environnements Apigee.

Si vous êtes un client facturé à l'usage, vous devez activer Apigee API Analytics en tant que module complémentaire payant pour accéder aux données analytiques et générer des rapports personnalisés. Pour en savoir plus sur l'activation du module complémentaire Apigee API Analytics pour vos environnements Apigee intermédiaires ou complets, consultez la page Gérer le module complémentaire Apigee API Analytics.

Si vous ne savez pas si vous utilisez une organisation Apigee avec abonnement ou en paiement à l'usage, contactez l'administrateur de votre organisation Apigee.

À propos des rapports personnalisés

Lors de la création d'un rapport personnalisé, vous sélectionnez les données que vous souhaitez afficher (métriques), vous les regroupez de manière significative (dimensions) et vous limitez éventuellement les données renvoyées en fonction de caractéristiques spécifiques des données (filtres).

Vous pouvez également définir le type de graphique affiché dans le rapport personnalisé sous forme de graphique à colonnes ou en courbes. Les images suivantes montrent des exemples de graphique pour les métriques de transactions par seconde regroupées par dimension de proxy d'API:

  • Colonne - Chaque proxy d'API est représenté par une colonne différente :

    Graphique à colonnes personnalisé

  • Ligne - Chaque API est représentée par une ligne différente :

    Graphique en courbes personnalisé

Définir des métriques et des dimensions

Les métriques que vous choisissez pour votre rapport personnalisé spécifient les données que vous essayez de mesurer. Les métriques courantes incluent:
  • Transactions par seconde
  • Temps de réponse
  • Erreurs liées aux règles

En plus des métriques et des dimensions standards, vous pouvez également créer des rapports personnalisés pour les données personnalisées que vous collectez avec la règle DataCapture. Consultez la section Collecter des données personnalisées avec la règle DataCapture.

Certaines métriques vous permettent de définir une fonction d'agrégation à exécuter sur la métrique. Par exemple, vous pouvez utiliser les fonctions d'agrégation suivantes avec la métrique de temps de réponse :

  • avg : renvoie le temps de réponse moyen.
  • min : renvoie le temps de réponse minimum.
  • max : renvoie le temps de réponse maximum.
  • sum : renvoie la somme de tous les temps de réponse.

Les métriques ne prennent pas toutes en charge toutes les fonctions d'agrégation. La documentation sur les métriques contient un tableau spécifiant le nom de la métrique et la fonction (sum, avg, min, max) prise en charge par la métrique.

La dimension spécifie comment regrouper les données de métriques. Par exemple, vous souhaitez créer un rapport personnalisé illustrant la métrique de temps de réponse. Vous pouvez utiliser des dimensions pour regrouper les données de métriques par produit d'API, proxy d'API ou adresse e-mail de développeur afin d'obtenir les éléments suivants :

  • Temps de réponse par produit d'API
  • Temps de réponse par proxy d'API
  • Temps de réponse par e-mail de développeur

La façon dont la dimension s'affiche dans le graphique du rapport personnalisé dépend du type de graphique:

  • Colonne : chaque colonne correspond à une valeur de dimension différente.
  • Ligne : chaque ligne du graphique correspond à une valeur de dimension différente et l'axe des abscisses représente le temps.

Définir des filtres

Un filtre vous permet de limiter les données de métriques affichées dans le rapport personnalisé en définissant des caractéristiques spécifiques sur les données de métriques à renvoyer. Par exemple, vous pouvez créer un filtre afin d'afficher uniquement les données de métriques associées à un temps de réponse supérieur à une valeur donnée ou correspondant à un nom spécifique de proxy d'API.

Vous pouvez créer des filtres complexes à l'aide d'une syntaxe conditionnelle et d'opérateurs tels que eq, ne, gt, lt, etc.

Exemples de rapports personnalisés

Dans le type de rapport personnalisé le plus simple, vous devez spécifier une seule métrique et une seule dimension. Par exemple, vous définissez un rapport personnalisé avec les paramètres suivants :

  • type = colonne
  • métrique = transactions moyennes par seconde
  • dimension = proxy d'API

Le rapport personnalisé contient un graphique à colonnes avec les données de la métrique "Nombre moyen de transactions par seconde" regroupées par variable de proxy d'API:

rapport personnalisé (tps)

Vous pouvez ajouter plusieurs métriques à un rapport personnalisé. Par exemple, vous définissez un rapport personnalisé avec deux métriques :

  • type = colonne
  • métrique = transactions moyennes par seconde
  • métrique = erreurs de règles
  • dimension = proxy d'API

Le rapport personnalisé contient un graphique distinct pour chaque métrique:

Rapport personnalisé à deux métriques

Vous pouvez ajouter plusieurs dimensions à un rapport personnalisé. Par exemple, vous définissez un rapport personnalisé avec les paramètres suivants, incluant deux métriques et deux dimensions :

  • type = colonne
  • métrique = transactions moyennes par seconde
  • métrique = erreurs de règles
  • dimension = proxy d'API
  • dimension = verbe de requête

Rapport "Temps réel" ou jobs de création de rapports

Apigee Analytics vous permet d'exécuter un rapport en temps réel ou un job de création de rapport.

  • Pour les rapports en temps réel, vous demandez le rapport et il s'affiche dès que le serveur d'analyse fournit une réponse. Toutefois, étant donné qu'un rapport peut nécessiter le traitement d'une grande quantité de données (par exemple, des centaines de Go), un rapport en temps réel peut échouer en raison d'un dépassement de délai.

    La durée maximale d'un rapport en temps réel est de 92 jours. Si vous sélectionnez une période plus longue, le rapport est exécuté en tant que tâche de création de rapport.

    Pour en savoir plus, consultez la section Exécuter un rapport personnalisé.

  • Pour un job de création de rapport, vous demandez le rapport et récupérez les résultats ultérieurement. Voici quelques situations dans lesquelles un job de création de rapports peut être une bonne alternative :

    • Analyse et création de rapports couvrant de grands intervalles de temps
    • Analyse des données avec diverses dimensions de regroupement et d'autres contraintes qui ajoutent de la complexité à la requête
    • Gestion des requêtes lorsque vous constatez que les volumes de données ont considérablement augmenté pour certains utilisateurs ou organisations

    Vous pouvez également exécuter un job de création de rapport à l'aide de l'API, comme décrit dans la section Utiliser l'API de création de rapports personnalisés asynchrones. Consultez la section Afficher les jobs de rapport.

Ouvrir la page Rapports personnalisés

Apigee dans la console Cloud

Pour ouvrir la page Rapports personnalisés, procédez comme suit :

  1. Ouvrez l'interface utilisateur d'Apigee dans la console Cloud.
  2. Sélectionnez Analytics > Rapports personnalisés.

La page Rapports personnalisés s'affiche, comme illustré ci-dessous.

Tableau de bord des rapports personnalisés

La page "Rapports personnalisés" comporte deux onglets :

  • Rapports : affiche des rapports "Temps réel".
  • Jobs de rapport : affiche les jobs de rapport.

Consultez la section Rapports "Temps réel" ou jobs de création de rapports.

Ces deux onglets affichent la liste des rapports ou des jobs de création de rapports déjà créés. Pour afficher un rapport ou un job de création de rapports, cliquez sur le nom du rapport. Consultez la section Générer un rapport pour obtenir un exemple.

Rapports

L'onglet Rapports affiche les informations suivantes sur chaque rapport:

  • Nom à afficher : nom du rapport.
  • Dimensions : dimensions incluses dans le rapport.
  • Métriques : métriques et fonctions d'agrégation (telles que sum) incluses dans le rapport.
  • Dernière modification : date et heure de la dernière exécution du rapport.

Jobs de création de rapports

L'onglet Jobs de création de rapports affiche les informations suivantes sur chaque job :

  • Nom du rapport : le nom du rapport.
  • Heure de début (UTC) : heure de début du job de création de rapports.
  • Heure de fin (UTC) : heure de fin du job de création de rapports.
  • État : état du job de création de rapports, qui peut être en cours d'exécution, terminée ou expirée.
  • Date d'envoi : date et heure d'envoi du job de création de rapports.

La page Rapports personnalisés vous permet d'effectuer les opérations suivantes :

Apigee classique

Pour ouvrir la page Rapports personnalisés, procédez comme suit :

  1. Connectez-vous à l'UI Apigee.
  2. Sélectionnez Analyze > Custom Reports > Reports (Analyser > Rapports personnalisés > Rapports).

La page des rapports personnalisés affiche tous les rapports personnalisés créés pour votre organisation, comme illustré dans la figure suivante :

Tableau de bord des rapports personnalisés

Comme le montre cette figure, la page des rapports personnalisés vous permet d'effectuer les opérations suivantes :

  • Afficher la liste de tous les rapports personnalisés.
  • Ajouter un rapport personnalisé.
  • Cliquez sur le nom d'un rapport personnalisé dans la liste pour l'exécuter. Le rapport est exécuté par défaut sur la base des données collectées au cours de la dernière heure et les données sont affichées dans le tableau de bord du rapport personnalisé. Consultez la section Explorer le tableau de bord des rapports personnalisés.
  • Effectuez une recherche dans la liste des rapports personnalisés en entrant tout ou partie d'une chaîne pertinente dans la zone de recherche. La chaîne est recherchée dans tous les champs affichés.
  • Supprimer un rapport personnalisé.

Explorer le tableau de bord des rapports personnalisés

Le tableau de bord des rapports personnalisés affiche les résultats de votre rapport personnalisé pour une période donnée, y compris le graphique à colonnes ou en courbes de la métrique spécifiée :

Tableau de bord des rapports personnalisés

Le tableau de bord des rapports personnalisés vous permet d'effectuer les opérations suivantes :

  • Afficher les données de rapport personnalisé pour la période sélectionnée.
  • Sélectionner l'environnement pour lequel vous souhaitez afficher les données de rapport personnalisées.
  • Sélectionnez une dimension spécifique pour filtrer les données du rapport personnalisé. Cette zone est activée uniquement lorsque vous spécifiez plusieurs dimensions dans le rapport.
  • Sélectionner la vue Graphique ou Tableau.

  • Analyser une métrique en sélectionnant l'icône Icône Analyse de rapport personnalisé. dans la ligne du tableau de la métrique associée. Vous pouvez afficher les anomalies et les comparer à une période précédente ou à d'autres métriques.
  • Exécuter le rapport personnalisé en cliquant sur la période et en la définissant.
  • Télécharger le rapport personnalisé sous forme de fichier CSV. Le fichier est nommé comme suit : metric.csv. Par exemple : Average_of_total_response_time.csv.
  • Modifier le rapport personnalisé.

Créer un rapport personnalisé

Cette section explique comment créer un rapport personnalisé.

Apigee dans la console Cloud

Sur la page "Rapports personnalisés", vous pouvez créer un rapport "Temps réel" ou un job de création de rapports. Pour ce faire :

  1. Ouvrez la page Rapports personnalisés.
  2. Cliquez sur + Créer.
    • Pour créer un rapport "Temps réel", sélectionnez Rapport personnalisé.
    • Pour créer un job de création de rapports, sélectionnez Job de création de rapports personnalisée.
  3. Dans la section Basique, saisissez les informations suivantes :
    • Nom du rapport : nom du rapport.
    • Pour un rapport "Temps réel" uniquement, vous pouvez également saisir une Description (facultatif).
  4. Les sections suivantes varient selon que vous créez un rapport "Temps réel" ou un job de création de rapports :
    • Pour les rapports "Temps réel" uniquement :

      Après Type de graphique, sélectionnez le style de graphique pour présenter vos données :

      • Colonne : l'axe des abscisses représente les groupes désignés par des dimensions.
      • Ligne : l'axe des ordonnées représente le temps.

    • Pour les jobs de création de rapports uniquement :
      • Détails du rapport : dans le champ Environnement, sélectionnez l'environnement dans lequel vous souhaitez exécuter le rapport. Notez que pour les rapports "Temps réel", vous pouvez sélectionner l'environnement sur la page du rapport, après son exécution.
      • Plage de dates du rapport : sélectionnez l'heure de début et l'heure de fin du rapport.

        Remarque : La plage de dates maximale pour un job de création de rapports est de 365 jours.

  5. Dans la section Métriques :
    1. Sélectionnez la métrique que vous souhaitez analyser.
    2. Sélectionnez une fonction d'agrégation pour afficher la somme, la moyenne, la valeur minimale ou la valeur maximale.
    3. Cliquez sur OK.

    Remarque : En plus des métriques et des dimensions standards, vous pouvez également sélectionner des métriques ou des dimensions correspondant aux données personnalisées collectées avec la règle DataCapture.

  6. Dans le champ Dimensions, sélectionnez une dimension, telle que "Proxy", pour limiter l'ensemble de données utilisé pour générer les rapports. Vous pouvez ajouter des dimensions supplémentaires pour limiter davantage les données.
  7. Dans la section Filtre, vous pouvez affiner davantage les données affichées en ajoutant des filtres à la définition de votre rapport. Par exemple, vous pouvez ajouter un filtre excluant les données du proxy d'API météo ou du développeur jane@example.com.

    Tout d'abord, cliquez sur Ajouter un filtre pour ouvrir la section Nouveau filtre.

    1. Sélectionnez le nom de l'entité que vous souhaitez filtrer, qui peut être une métrique ou une dimension.
    2. Sélectionnez un opérateur tel que = ou !=, ainsi qu'une Valeur.
    3. Saisissez une valeur pour la métrique ou la dimension.
    4. Cliquez sur OK pour ajouter le filtre.
  8. Cliquez sur Enregistrer pour enregistrer le rapport.

Apigee classique

Pour ajouter un rapport personnalisé, procédez comme suit :

  1. Ouvrez la page Rapports personnalisés.
  2. Cliquez sur + Rapport personnalisé.
  3. Dans la section "Basique", saisissez les informations suivantes :
    Champ Description
    Nom du rapport Le nom du rapport.
    Description du rapport La description du rapport.
    Type de graphique Sélectionnez le style de graphique à utiliser pour présenter vos données d'analyse personnalisées.
    • Colonne : l'axe des abscisses représente les groupes désignés par des dimensions.
    • Ligne : l'axe des ordonnées représente le temps.
  4. Dans la section "Métriques" :
    1. Cliquez sur l'icône Icône Plus. de Métriques.
    2. Sélectionnez la métrique que vous souhaitez analyser.
    3. Sélectionnez une fonction d'agrégation pour afficher la somme, la moyenne, la valeur minimale ou la valeur maximale.
    4. Cliquez sur Enregistrer.
    5. Cliquez sur l'icône Icône Plus pour ajouter des métriques.

    Remarque : En plus des métriques et des dimensions standards, vous pouvez également sélectionner des métriques ou des dimensions correspondant aux données personnalisées collectées avec la règle DataCapture.

  5. Dans la section Dimensions, cliquez sur Icône Plus et sélectionnez une dimension, telle que "Proxy", pour limiter l'ensemble de données utilisé pour générer les rapports. Vous pouvez ajouter des dimensions supplémentaires pour limiter davantage les données.
  6. Dans la section Filtre, affinez les données affichées en ajoutant des filtres à la définition de votre rapport. Par exemple, vous pouvez ajouter un filtre excluant les données du proxy d'API météo ou du développeur jane@example.com.

    1. Cliquez sur Icône Plus et sélectionnez le nom de l'entité que vous souhaitez filtrer, un opérateur tel que = ou !=, et une valeur.
    2. Cliquez sur Ajouter pour enregistrer le filtre.
    3. Cliquez sur Icône Plus pour ajouter d'autres filtres, puis sélectionnez un connecteur AND (et) ou OR (ou).
  7. Cliquez sur Enregistrer pour enregistrer le rapport.

Générer un rapport

Apigee dans la console Cloud

Pour exécuter un rapport "Temps réel", procédez comme suit :

  1. Ouvrez la page Rapports personnalisés.
  2. Dans l'onglet Rapports, sélectionnez le rapport à exécuter.

Lorsque le rapport est prêt, il s'affiche comme illustré ci-dessous.

Rapport personnalisé affiché.

Le rapport affiche un graphique des données et un tableau récapitulatif.

Sur la page du rapport, vous pouvez sélectionner les options suivantes :

  • Environnement : l'environnement dans lequel exécuter le rapport.
  • Une période pour le rapport.
  • Dimension : une dimension pour le rapport. Vous ne pouvez afficher qu'une seule dimension à la fois.
  • Valeur : une valeur spécifique pour la dimension, ou Toutes pour afficher toutes les valeurs.

Vous pouvez également choisir les options suivantes en haut de la page du rapport :

  • Modifier : modifiez les détails du rapport.
  • Exporter : téléchargez les données du rapport dans un fichier CSV.
  • Envoyer le job : envoyez le rapport en tant que job de création de rapport. Lorsque vous cliquez sur Envoyer le job, une boîte de dialogue s'ouvre et vous indique les options décrites dans la section Créer un rapport personnalisé. Une fois les options saisies, cliquez sur Créer pour créer le job de création de rapport.

Pour en savoir plus sur les jobs de création de rapports, consultez la section Afficher les jobs de création de rapports.

Apigee classique

Pour exécuter un rapport personnalisé pour une période spécifique :

  1. Accédez à la page Rapports personnalisés.
  2. Sélectionnez le rapport à exécuter. Par défaut, le rapport affiche les données de l'heure précédente.

    Remarque : si l'exécution du rapport prend plus de 60 secondes, il sera automatiquement converti en rapport en temps réel.

  3. Pour exécuter le rapport pour une autre période, procédez comme suit :

    1. Cliquez sur la période située en haut du rapport pour ouvrir la fenêtre contextuelle Sélection de la période du rapport personnalisé.
    2. Sélectionnez l'une des options ci-dessous :
      • Une période prédéfinie, telle que Dernière heure, Hier ou 7 derniers jours.
      • Une période personnalisée. Pour cela, sélectionnez une date et une heure de début/fin, ou utilisez le calendrier pour sélectionner les dates de début et de fin. Cliquez sur UTC pour utiliser le temps universel coordonné (UTC).

    3. Pour exécuter le rapport, sélectionnez l'une des options suivantes :
      • Appliquer pour exécuter le rapport. Les résultats seront affichés dans le tableau de bord du rapport personnalisé une fois l'exécution terminée.

      • Envoyer le job pour exécuter le rapport en tant que job de création de rapports. La boîte de dialogue suivante s'affiche :

        Soumettre le rapport asynchrone

        Cliquez sur View Status (Afficher l'état) dans la boîte de dialogue pour afficher l'état du job de création de rapports.

Afficher un job de création de rapport

Apigee dans la console Cloud

Pour afficher un job de création de rapport, sélectionnez l'onglet Jobs de création de rapports en haut de la page "Rapports personnalisés".

L'onglet Tâches de création de rapports s'affiche, comme illustré ci-dessous :

Report Jobs (Tâches de création de rapports)

La page "Report Jobs" vous permet d'effectuer les opérations suivantes :

  • Afficher tous les jobs de création de rapports envoyées au cours des sept derniers jours.

  • Sélectionner l'environnement pour lequel vous souhaitez afficher les jobs de création de rapports.

  • Effectuer une recherche dans la liste des rapports personnalisés en entrant tout ou partie d'une chaîne pertinente dans la zone de recherche : la chaîne est recherchée dans tous les champs affichés.

Pour afficher le rapport personnalisé, assurez-vous que son état indique "terminé". Cliquez ensuite sur le nom du rapport pour l'afficher.

Apigee classique

Pour afficher les jobs de création de rapports, sélectionnez l'une des options suivantes :

  • Cliquez sur Afficher le statut dans la boîte de dialogue Report Submitted as Background Job (Rapport soumis en tâche de fond).
  • Dans la barre de navigation de gauche, sélectionnez Analyze > Custom Reports > Report Jobs (Analyser > Rapports personnalisés > Tâches de création de rapports).

La page "Report Jobs" (Tâches de création de rapports) s'affiche, comme illustré dans la figure suivante :

Report Jobs (Tâches de création de rapports)

La page "Report Jobs" vous permet d'effectuer les opérations suivantes :

  • Afficher tous les résultats des jobs de création de rapports qui ont été soumis au cours des 7 derniers jours.

  • Sélectionner l'environnement pour lequel vous souhaitez afficher les jobs de création de rapports.

  • Pour afficher le rapport personnalisé, assurez-vous que son état indique "terminé". Déplacez ensuite la souris sur la ligne correspondant au rapport. Une icône Afficher le rapport et une icône Télécharger le rapport s'affichent. Sélectionnez l'icône Afficher le rapport pour afficher le rapport.

  • Téléchargez le rapport personnalisé.

Modifier un rapport personnalisé

Apigee dans la console Cloud

Pour modifier un rapport personnalisé :

  1. Ouvrez la page Rapports personnalisés.
  2. Cliquez sur le menu à trois points sous Actions.
  3. Sélectionnez Modifier. La boîte de dialogue Modifier le rapport personnalisé s'ouvre. Vous pouvez modifier les options du rapport. Les options sont décrites dans la section Créer un rapport personnalisé.
  4. Cliquez sur Mettre à jour pour enregistrer vos modifications.

Apigee classique

Pour modifier un rapport personnalisé :

  1. Ouvrez la page Rapports personnalisés.
  2. Placez le curseur de la souris sur le nom du rapport que vous souhaitez modifier. Les icônes de modification Icône de modification et de suppression Icône de suppression apparaissent sur le côté droit de la page.
  3. Cliquez sur l'icône de modification.
  4. Modifiez les détails du rapport personnalisé.
  5. Cliquez sur Enregistrer.

Vous êtes alors redirigé vers les résultats du rapport personnalisé.

Supprimer un rapport personnalisé

Apigee dans la console Cloud

  1. Ouvrez la page Rapports personnalisés.
  2. Cliquez sur le menu à trois points sous Actions.
  3. Cliquez sur Supprimer pour supprimer le rapport.

Apigee classique

Pour supprimer un rapport personnalisé :

  1. Ouvrez la page Rapports personnalisés.
  2. Placez le curseur de la souris sur le nom du rapport que vous souhaitez modifier. Les icônes de modification Icône de modification et de suppression Icône de suppression apparaissent sur le côté droit de la page.
  3. Cliquez sur l'icône de suppression pour supprimer le rapport.