Accès à l'analyse dans l'interface utilisateur d'API Manager

Comment afficher, analyser et exporter vos données d'analyse à partir de l'interface utilisateur d'API Manager.

Les données d'analyse sont affichées dans les tableaux de bord dans l'interface utilisateur d' API Manager . Les tableaux de bord sont sectorisés au niveau de l'organisation de type fournisseur, du catalogue et de l'espace.

La possibilité d'accéder aux données d'analyse au niveau d'un catalogue ou d'un espace dépend des rôles et des droits qui vous ont été affectés. Pour plus d'informations sur les catalogues et les espaces, voir Travail avec les catalogues et Utilisation de la syndication dans API Connect.

Pour accéder au tableau de bord analytique du catalogue, suivez les étapes suivantes :

Dans l'interface utilisateur API Manager, sélectionnez Gestion dans le panneau de navigation.
Dans la liste des catalogues disponibles dans le tableau de bord API Manager , sélectionnez le catalogue requis.
Facultatif : Si les espaces sont activés et que vous souhaitez voir les analyses au niveau d'un espace, alors.. :
1. Cliquez sur l'onglet Espaces .
2. Sélectionnez l'espace à afficher.
Cliquez sur l'onglet Analytics.

Tableaux de bord d'analyse

Les tableaux de bord d'analyse de l'interface utilisateur API Manager affichent les données d'événement d'API dans les portées de l'organisation de type fournisseur, du catalogue et de l'espace.

Les tableaux de bord relatifs à l'organisation du fournisseur sont accessibles à partir de l'icône d'analyse " dans le panneau de navigation. Vue du catalogue d'analyse

Les tableaux de bord de portée espace sont accessibles à partir de l'onglet Analyse lors de l'affichage de l'espace.

Les tableaux de bord suivants sont disponibles :

Récapitulatif: Informations d'un coup d'oeil sur les volumes d'appel, les temps d'attente et le moment où ces appels se produisent.
Consommation: nombre total d'appels d'API dans votre cloud. Requis pour les licences basées sur la consommation.
API: Tout ce que vous devez savoir sur les API qui sont appelées et celles qui ne le sont pas.
Produits : quels produits sont les plus populaires au total et au fil du temps.
Consommateurs: Déterminez les organisations de type consommateur qui font le plus d'appels d'API au total et au fil du temps.
Applications: les applications qui sont responsables de la plupart des appels d'API au total et au fil du temps.
Utilisation de l'intelligence artificielle: Suivi du nombre de jetons d'intelligence artificielle et de l'utilisation du modèle pour voir comment les services d'intelligence artificielle sont utilisés.
Statut : Informations critiques sur les appels API réussis et échoués, indiquant les taux de réussite et d'échec au fil du temps ainsi qu'une répartition des codes de réponse d' HTTP.
Temps d'attente: temps nécessaire aux API pour renvoyer une réponse et changement de temps d'attente dans le temps.
Transfert de données: Tout sur les contenus de demande et de réponse. API, consommateurs et applications à l'origine des contenus de demande et de réponse les plus volumineux.
Informations client: Qui appelle vos API et à partir de quels terminaux.
Remarque: seules les adresses IP accessibles sur Internet peuvent être résolues en un emplacement géographique. Les adresses IP internes sont ignorées.
Opérations de passerelle: appelez les informations de volume et de temps d'attente pour chaque passerelle dans chaque service de passerelle. Ces informations peuvent être utilisées pour déterminer si la charge est répartie de manière uniforme ou si une passerelle est peu performante.

Chaque graphique d'un tableau de bord peut être exporté en tant qu'image PNG ou JPG. Les données source de chaque graphique peuvent être exportées sous forme de fichier JSON ou CSV. Pour exporter un graphique, cliquez sur Actions en haut à droite: Exemple de graphique circulaire d'analyse

Il est également possible d'agrandir le graphique en plein écran en cliquant sur Icône d'analyse en plein écran . Pour afficher les données source sous forme de tableau, cliquez sur Icône de table d'analyse .

Vue de reconnaissance

Par défaut, l'onglet Tableaux de bord s'affiche. Pour afficher vos données d'événement d'API sous forme de tableau, sélectionnez Discover:

Vue de reconnaissance d'analyse Le nombre maximum d'événements API accessibles depuis l'interface utilisateur est de 10 000. Le nombre maximal d'enregistrements d'événement pouvant être affichés par page dans la vue Discover est 200.

Vous pouvez personnaliser les colonnes affichées dans la section Filtres . Vous pouvez trier le tableau par ordre croissant ou décroissant en cliquant sur les en-têtes de colonne.

Vous pouvez basculer le graphique chronologique sur un axe des Y logarithmique et exporter les données du graphique en cliquant sur Actions dans la partie supérieure droite du graphique:

Menu Exporter les données du graphique et passer à la chronologie

Vous pouvez exporter les données d'événement d'API à partir de la table en cliquant sur Actions en haut à droite de la table:

Options du menu d'exportation des données analytiques

Remarque : lorsque vous sélectionnez Exporter en CSV ou Exporter en JSON pour exporter à partir de la vue Découvrir, seules les données affichées sur la page actuelle des résultats sont exportées. Pour exporter les données de toutes les pages, sélectionnez Données complètes au format CSV ou Données complètes au format JSON. Vous pouvez également exporter toutes vos données analytiques à l'aide de l' interface CLI du kit d'outils. Pour plus d'informations, voir Exporter vos données analytiques.

HTTP Si vous voyez des événements OPTIONS inattendus dans la vue Discover, ces événements sont dus à des requêtes CORS provenant d'outils de test API basés sur un navigateur. Pour plus d'informations sur les outils de test et l'appel OPTIONS, voir Test d'une API.

Filtrage des données affichées

Vous pouvez filtrer les données affichées dans les tableaux de bord et la vue Discover en définissant des filtres (également appelés requêtes). Développez la section Filtres pour afficher, définir et appliquer des requêtes à vos données affichées:

Paramètres des filtres d'analyse

Vous pouvez sauvegarder et partager les requêtes que vous définissez:

Les requêtes partagées sont visibles par tous les utilisateurs de la même portée. Ils ne sont pas visibles pour les utilisateurs d'une portée différente. Par exemple, une requête partagée par les utilisateurs de l'interface utilisateur Cloud Manager n'est pas visible par un utilisateur de l'interface utilisateur API Manager . Dans l'interface utilisateur d' API Manager , une requête créée au niveau de la portée du catalogue n'est pas visible par les utilisateurs qui visualisent les données d'analyse au niveau de la portée de l'organisation de type fournisseur.
Les autres utilisateurs ne peuvent pas éditer ou supprimer des requêtes que vous partagez, mais ils peuvent créer une requête en double qu'ils peuvent éditer et partager.
Toutes les requêtes ont un nom et une description facultative. Il n'est pas nécessaire que le nom soit unique.

Les requêtes sauvegardées peuvent être exportées en tant que chaînes à utiliser dans les requêtes de l'API REST et de l' interface de ligne de commande du kit d'outils , par exemple:

Option de menu de requête de copie d'analyse

copie la chaîne suivante dans le presse-papiers :

timeframe=last7days

Définir une requête par défaut dans l'analyse

Vous pouvez désormais définir une requête par défaut qui est automatiquement appliquée lorsque vous visitez les pages Tableau de bord ou Découvrir dans Analytics. La requête par défaut est configurée par utilisateur et par périmètre (organisation, catalogue ou espace).

Remarque :

Seules les requêtes partagées peuvent être définies comme requêtes par défaut.
Chaque champ d'application peut avoir une requête par défaut par utilisateur. Une requête par défaut différente peut être définie pour chaque catalogue et chaque espace.

Assurez-vous que la requête que vous souhaitez définir par défaut est enregistrée.
Pour partager la requête enregistrée, procédez comme suit.
- Cliquez sur l'onglet Enregistré.
- Dans le menu des options, cliquez sur Partager.
- Dans la fenêtre Requête de partage, cliquez sur Partager.
Cliquez sur l'onglet Partagés.
Dans le menu des options, cliquez sur Définir comme requête par défaut.
Dans la fenêtre Requête par défaut, cliquez sur Défaut.
Pour appliquer immédiatement la requête par défaut. Cliquez sur Appliquer. La requête par défaut est appliquée immédiatement à tous les utilisateurs de cette portée. Si vous ne cliquez pas sur Appliquer après avoir défini la requête par défaut, celle-ci sera automatiquement appliquée lors de votre prochaine visite dans les onglets Tableau de bord ou Découvrir.

Vue Rapports

La vue des rapports affiche des données récapitulatives à long terme plutôt que des événements API individuels. Vue des rapports d'analyse

Remarque: La vue reports a été introduite dans v10.0.6et n'inclut pas les données générées avant la mise à niveau vers v10.0.6.

Les tendances du volume d'appels indiquent les API les plus actives et les moins actives, le nombre total d'appels API réussis et échoués, le nombre total d'octets envoyés et reçus, ainsi que les totaux en fonction de l'étendue. Vignette des tendances des volumes d'appels d'analyse

Les tendances en matière de consommation indiquent le nombre de consommateurs, d'abonnements et de demandes au fil du temps : Vignette des tendances des consommateurs d'analyse

Le rapport sur la consommation montre les tendances à long terme des appels API traités par les passerelles, ce qui est essentiel pour obtenir des informations sur les licences basées sur la consommation. rapport_de_consommation

Les produits inactifs affichent les produits qui n'ont pas d'abonnement et les produits qui n'ont pas de trafic. Mosaïque des produits inactifs d'analyse

Les organisations de consommateurs inactives indiquent les organisations de consommateurs qui n'ont pas d'applications, d'abonnements, de trafic récent ou pas de trafic du tout. Vignette des organisations de type consommateur inactives d'analyse

Les produits obsolètes affichent les produits qui sont obsolètes mais qui reçoivent encore du trafic. Rapport sur les produits obsolètes

La section des classements du volume d'appels API montre les classements pour les API, les produits, les plans, les applications, les organisations de consommateurs, les services de passerelle et la répartition par catalogue. Cliquez dans la colonne du nom pour voir les données de chaque élément. Table de classement des volumes d'appel d'analyse