Accesso all'analisi nell'interfaccia utente di API Manager

Come visualizzare, analizzare ed esportare i dati di analisi dall'interfaccia utente di API Manager.

I dati di analisi vengono visualizzati nei dashboard nella IU API Manager . I dashboard si trovano nell'ambito dell'organizzazione provider, del catalogo e del livello spazio.

La capacità di accedere ai dati di analisi a livello di catalogo o di spazio dipende dai ruoli e dalle autorizzazioni assegnate. Per ulteriori informazioni sui cataloghi e sugli spazi, vedere Lavoro con i cataloghi e Utilizzo della syndication in API Connect.

Per accedere al cruscotto analitico con ambito catalogo, completare i seguenti passaggi:
  1. Nell'interfaccia utente di API Manager, selezionare Gestisci Icona Gestisci cataloghi nel pannello di navigazione.
  2. Dall'elenco di cataloghi disponibili nel dashboard API Manager , seleziona il catalogo richiesto.
  3. Facoltativo: se gli spazi sono abilitati e si desidera visualizzare l'analitica nell'ambito di uno spazio, è possibile farlo:
    1. Fare clic sulla scheda Spazi .
    2. Selezionare lo spazio che si desidera visualizzare.
  4. Fai clic sulla scheda "Analytics ".Vista catalogo analitiche

Draft comment: iainsoed@uk.ibm.com
Also talk about analytics for API troubleshooting in manager UI. Not really covered anywhere atm

Dashboard di analytics

I dashboard di analisi nell'IU API Manager mostrano i dati evento API negli ambiti dell'organizzazione provider, del catalogo e dello spazio.

È possibile accedere ai dashboard specifici per le organizzazioni di fornitori cliccando sull'icona " Icona Analisi Analisi" nel pannello di navigazione. Vista catalogo analitiche

Ai dashboard nell'ambito dello spazio si accede dalla scheda Analytics quando si visualizza lo spazio.

Sono disponibili i seguenti dashboard:
  • Riepilogo: informazioni generali sui volumi di chiamata, le latenze e quando si verificano tali chiamate.
  • Consumo: numero totale di chiamate API nel tuo cloud. Richiesto per la licenza basata sul consumo.
  • API: tutto ciò di cui hai bisogno per sapere quali API vengono richiamate e quali no.
  • Prodotti : quali sono i prodotti più popolari sia in totale che nel tempo.
    Draft comment: iainsoed@uk.ibm.com
    This dashboard doesn't mean much on the CMC, maybe will change in future: https://ibmapim.slack.com/archives/C016L7RA2RH/p1655806918287239?thread_ts=1655806509.463429&cid=C016L7RA2RH.
  • Utenti: determinare quali organizzazioni di consumatori stanno effettuando la maggior parte delle chiamate API in totale e nel tempo.
  • Applicazioni: quali applicazioni sono responsabili della maggior parte delle chiamate API sia in totale che nel tempo.
  • Utilizzo dell'IA: Tracciare il numero di token AI e l'utilizzo dei modelli per vedere come vengono utilizzati i servizi AI.
  • Stato : Informazioni critiche sui successi e gli insuccessi delle chiamate API, che mostrano le percentuali di successo e di insuccesso nel tempo insieme a un codice di risposta HTTP.
  • Latenza: quanto tempo impiegano le API per restituire una risposta e la modifica della latenza nel tempo.
  • Trasferimento dati: tutto sui payload di richiesta e risposta. Quali API, consumer e applicazioni sono responsabili dei payload di richieste e risposte di maggiori dimensioni.
  • Informazioni client: chi richiama le tue API e da quali dispositivi.
    Nota: solo gli indirizzi IP accessibili a Internet possono essere risolti in un'ubicazione geografica. Gli indirizzi IP interni vengono ignorati.
  • Operazioni gateway: richiama le informazioni sul volume e sulla latenza per ogni gateway in ogni servizio gateway. Queste informazioni possono essere utilizzate per determinare se il caricamento viene distribuito in modo uniforme o se un gateway ha prestazioni insufficienti.

Ogni grafico in un dashboard può essere esportato come immagine PNG o JPG. I dati di origine di ciascun grafico possono essere esportati in formato JSON o come file di testo ( CSV ). Per esportare un grafico, clicca su "Azioni" in alto a destra:Grafico a torta di esempio Analytics

È anche possibile ingrandire il grafico a schermo intero cliccando su Icona a schermo intero Analytics. Per visualizzare i dati di origine in formato tabellare, Icona tabella analiticaclicca qui.

Vista Rileva

Per default, viene visualizzata la scheda Dashboard . Per visualizzare i tuoi dati evento API in formato tabulare, seleziona Rileva:

Vista di rilevamento dell'analiticaIl numero massimo di eventi API a cui è possibile accedere dall'interfaccia utente è 10.000. Il numero massimo di record evento che possono essere visualizzati per pagina nella vista Rileva è 200.

È possibile personalizzare le colonne visualizzate nella sezione filtri . È possibile ordinare la tabella in ordine crescente o decrescente facendo clic sulle intestazioni delle colonne.

È possibile commutare il grafico della sequenza temporale su un asse y logaritmico ed esportare i dati per il grafico facendo clic su Azioni in alto a destra del grafico:

Menu Esporta dati del grafico e cambia sequenza temporale

Puoi esportare i dati evento API dalla tabella facendo clic su Azioni in alto a destra della tabella:

Opzioni di menu per l'esportazione dei dati di Analytics

Nota: quando si seleziona "Esporta come file. CSV " o "Esporta come JSON" per esportare dalla vista "Discover ", vengono esportati solo i dati visualizzati nella pagina corrente dei risultati. Per esportare i dati da tutte le pagine, seleziona "Dati completi in formato CSV " o "Dati completi in formato JSON". È inoltre possibile esportare tutti i dati di analisi utilizzando la CLI del toolkit. Per ulteriori informazioni, consulta la sezione "Esportazione dei dati di analisi".

Se nella vista "Discover " vengono visualizzati eventi " HTTP " inattesi, tali eventi sono dovuti a richieste " CORS " provenienti da strumenti di test delle API basati su browser. Per ulteriori informazioni sugli strumenti di test e sulla chiamata OPTIONS, vedi Verifica di un'API.

Filtro dei dati visualizzati

È possibile filtrare i dati visualizzati nella vista Dashboard e Rileva definendo i filtri (denominati anche query). Espandere la sezione Filtri per visualizzare, definire e applicare query ai dati visualizzati:

Impostazioni dei filtri di analisi

È possibile salvare e condividere le query definite:
  • Le query condivise sono visibili a tutti gli utenti nello stesso ambito. Non sono visibili agli utenti in un ambito diverso. Ad esempio, una query condivisa dagli utenti dell'IU Cloud Manager non è visibile per un utente dell'IU API Manager . All'interno dell'interfaccia utente di API Manager , una query creata nell'ambito del catalogo non è visibile agli utenti che stanno visualizzando i dati di analisi nell'ambito dell'organizzazione provider.
  • Altri utenti non possono modificare o eliminare le query condivise, ma possono creare una query duplicata, che possono modificare e condividere.
  • Tutte le query hanno un nome e una descrizione facoltativa. Il nome non deve essere univoco.

Le query salvate possono essere esportate come stringhe da utilizzare nelle query dell'API REST e della CLI del toolkit , ad esempio:

Opzione di menu Copia query analiticacopia la seguente stringa negli appunti:
timeframe=last7days

Impostare una query predefinita in analytics

È ora possibile impostare una query predefinita che viene applicata automaticamente quando si visitano le pagine Dashboard o Discover di Analytics. La query predefinita è configurata per utente e per ambito (organizzazione, catalogo o spazio).
Nota:
  • Solo le query condivise possono essere impostate come query predefinite.
  • Ogni ambito può avere una query predefinita per utente. È possibile impostare una query predefinita diversa per ogni catalogo e spazio.
  1. Assicurarsi che la query che si desidera impostare come predefinita sia salvata.
  2. Per condividere la query salvata, completare i seguenti passaggi.
    • Fare clic sulla scheda Salvati.
    • Dal menu delle opzioni, fare clic su Condividi.
    • Nella finestra Condividi query, fare clic su Condividi.
  3. Fare clic sulla scheda Condivisi.
  4. Dal menu delle opzioni, clicca su "Imposta come query predefinita ".Editanalytics_copy_query.png
  5. Nella finestra Query predefinita, fare clic su Predefinita.
  6. Per applicare immediatamente la query predefinita. Fare clic su Applica. La query predefinita viene applicata immediatamente a tutti gli utenti dell'ambito. Se non si fa clic su Applica dopo aver impostato la query predefinita, questa verrà applicata automaticamente alla successiva visita delle schede Dashboard o Discover.

Vista Report

La schermata dei report mostra dati riepilogativi a lungo termine anziché singoli eventi API.Vista Report analitici
Nota: la visualizzazione dei report è stata introdotta in v10.0.6e non include i dati generati prima dell'upgrade a v10.0.6.

L'andamento del volume delle chiamate mostra le API più e meno attive, il numero totale di chiamate API riuscite e fallite, il totale dei byte inviati e ricevuti e i totali suddivisi per ambito.Riquadro degli andamenti del volume delle chiamate di analisi

Le tendenze di consumo mostrano l'andamento nel tempo del numero di consumatori, degli abbonamenti e delle applicazioni: Riquadro degli andamenti dei consumatori di analisi

Il rapporto sul consumo illustra le tendenze a lungo termine relative alle chiamate API elaborate dai gateway, dati fondamentali per comprendere il funzionamento delle licenze basate sul consumo.rapporto_consumo

La sezione "Prodotti inattivi" mostra i prodotti che non hanno abbonamenti e quelli che non generano traffico.Riquadro Prodotti analitici inattivi

La voce "Organizzazioni dei consumatori inattive" indica le organizzazioni dei consumatori che non presentano richieste, abbonamenti, traffico recente o alcun traffico.Riquadro delle organizzazioni consumer inattive di Analytics

La sezione "Prodotti obsoleti" mostra i prodotti che sono stati ritirati dal mercato ma continuano a ricevere visite.Report prodotti obsoleti

La sezione delle classifiche del volume di chiamate API mostra le classifiche per API, Prodotti, Piani, Applicazioni, Organizzazioni di consumatori, Servizi gateway e Ripartizione per catalogo. Clicca sulla colonna del nome per visualizzare i dati relativi a ciascuna voce.Tabella leaderboard del volume di chiamate Analytics