Monitoraggio e risoluzione dei problemi

In questa pagina viene descritto come ottenere informazioni sugli errori che si sono verificati in importazioni di eventi utente e di cataloghi e altre operazioni API in Vertex AI Search for Retail.

Per assistenza sulla configurazione degli avvisi, vedi Configurare gli avvisi di Cloud Monitoring.

Introduzione

Fornire informazioni sul catalogo ed eventi utente accurati L'API è importante per ottenere risultati di massima qualità. Monitoraggio e Comprendere l'origine degli errori ti consente di trovare e correggere eventuali errori nel tuo sito.

Visualizza gli errori di integrazione aggregati

Per visualizzare gli errori aggregati generati dai processi di caricamento dei dati e richieste di previsione o di ricerca, utilizza lo strumento Monitoring .

Questa pagina mostra tutti gli errori dell'API Vertex AI Search for Retail. Puoi visualizzare gli errori relativi al catalogo dei prodotti, agli eventi utente, alle previsioni dei consigli, ai risultati di ricerca e ai modelli. Il sistema registra anche gli errori delle importazioni, ad esempio una riga con formato non corretto nel file Cloud Storage. Il sistema registra fino a 100 errori per file di importazione. Puoi definire il periodo di tempo per cui vengono visualizzati gli errori e filtrare in base al tipo di errore.

Puoi fare clic su un singolo errore per visualizzare i relativi log in Cloud Logging.

Puoi aprire i singoli log degli errori espandendo il log. Log degli errori fornito ulteriori dettagli sulla richiesta, inclusi i payload di richiesta e risposta e ai dettagli dell'errore. Queste informazioni possono aiutarti a determinare dove si trova la chiamata al metodo errata nel tuo sito.

Per gli errori JSON non validi, puoi ottenere ulteriori informazioni sul problema espandendo il campo status.

Visualizzare lo stato di un'operazione di integrazione specifica

Puoi visualizzare lo stato di una specifica operazione di integrazione nel Finestra Stato attività:

  1. Vai alla scheda Dati > nella console Search for Retail.

    Vai alla pagina Dati

  2. Fai clic su Stato dell'attività.

    La finestra Stato attività mostra lo stato delle operazioni a lunga esecuzione sul tuo catalogo di prodotti, sugli eventi utente e sui controlli.

    In questa finestra puoi esaminare gli errori per operazioni di integrazione specifiche.

  3. Fai clic su Visualizza log nella colonna Dettagli di qualsiasi operazione che presenta un errore per e controllare i propri file di log in Cloud Logging.

Visualizza i log in Cloud Logging

Per aprire i file di log direttamente in Cloud Logging, segui la procedura riportata di seguito. Per visualizzare i log, devi disporre del ruolo Visualizzatore log (roles/logging.viewer).

  1. Vai a Esplora log nella console Google Cloud. Vai a Esplora log

  2. Seleziona il progetto Vertex AI Search for Retail dal selettore di progetti.

  3. Fai clic sul menu a discesa Risorsa e seleziona API utilizzata > Cloud per la vendita al dettaglio.

Per ulteriori informazioni su Esplora log, consulta Visualizza i log utilizzando Esplora log.

Ad esempio, questo link apre i log per tutti gli errori di Vertex AI Search for Retail nella ultima ora:

Aprire i log di Vertex AI Search for Retail

Per configurare i log API da scrivere, consulta Configurare la registrazione.

Configura logging

Puoi configurare i log dei servizi da scrivere in Logging. La configurazione del logging consente di impostare i livelli di gravità a cui scrivere i log, attivare o disattivare il logging e ignorare le impostazioni di logging predefinite per servizi specifici.

Ogni richiesta API effettuata da un utente finale può generare una voce di logging. Una voce contiene informazioni come il metodo API, la data e l'ora dell'invocazione, il codice di risposta e i relativi corpi. La configurazione di logging di un progetto specifica i tipi di log generati dall'API che vengono scritti in Logging, con la possibilità di specificare in modo granulare le configurazioni di logging per servizi API specifici.

Per aggiornare le configurazioni di logging, devi avere l'editor di Vertex AI Search for Retail ruolo.

Puoi utilizzare la console o l'API LoggingConfig per configurare Logging.

Console

Per aggiornare le configurazioni di logging nella console, segui questi passaggi:

  1. Vai alla pagina Monitoring nella console di Search for Retail.

    Vai alla pagina Monitoring

  2. Fai clic su Configurazione di logging.

  3. Per impostare una configurazione di logging globale, seleziona un livello di logging. Se selezioni LOG_ALL, inserisci anche un frequenza di campionamento per i log riusciti.

  4. Per impostare una configurazione a livello di servizio, seleziona un servizio da aggiornare e il relativo livello di logging. Questa impostazione sostituisce la configurazione del logging globale.

curl

Per aggiornare le configurazioni di logging utilizzando l'API, utilizza la risorsa LoggingConfig. Consulta il riferimento all'API LoggingConfig.

  1. Per visualizzare la configurazione di logging corrente, utilizza loggingConfig.Get.

    curl -X GET \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://retail.googleapis.com/v2alpha/projects/PROJECT_ID/loggingConfig"
    
    • PROJECT_ID: l'ID del progetto.
  2. Per aggiornare la configurazione di registrazione, utilizza il metodo loggingConfig.Patch. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API LoggingConfig.

    Questo esempio utilizza loggingConfig.Patch per impostare la configurazione di logging globale su LOG_WARNINGS_AND_ABOVE. Imposta inoltre due configurazioni a livello di servizio: CatalogService è impostato su LOG_WARNINGS_AND_ABOVE e ControlService è impostato su LOG_ALL.

    curl -X PATCH \
      -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
      -H "Content-Type: application/json; charset=utf-8" \
      "https://retail.googleapis.com/v2alpha/projects/PROJECT_ID/loggingConfig" \
      --data '{
        "name": "projects/PROJECT_ID/loggingConfig",
        "default_log_generation_rule": {"logging_level": "LOG_ERRORS_AND_ABOVE"},
        "service_log_generation_rules": [
          {
            "service_name": "CatalogService",
            "log_generation_rule": {
              "logging_level": "LOG_WARNINGS_AND_ABOVE"
              }
          },
          {
            "service_name": "ControlService",
            "log_generation_rule": {
                "logging_level": "LOG_ALL", "info_log_sample_rate": "0.1"
                }
            }
          ]
        }'
    

Livelli di logging

In Logging vengono scritti solo i log con alcuni livelli di gravità. La le impostazioni a livello di logging determinano quali log generati da un metodo API vengono vengono scritte in Logging.

Se per un metodo API non è impostata alcuna configurazione del logging a livello di servizio, e l'impostazione a livello di logging.

L'impostazione predefinita del livello di logging è LOG_WARNINGS_AND_ABOVE.

Il campo logging_level accetta i seguenti valori:

  • LOGGING_DISABLED: nessun log scritto.
  • LOG_ERRORS_AND_ABOVE: registra solo gli errori.
  • LOG_WARNINGS_AND_ABOVE: registra solo gli errori e gli avvisi.
  • LOG_ALL: registra tutto, inclusi i log di successo come i log INFO.

Frequenza di campionamento per i log riusciti

Se imposti il livello di logging su LOG_ALL, ma non vuoi registrare ogni log riuscito, puoi specificare una frequenza di campionamento. Ad esempio, potresti decidere di monitorare periodicamente i log per verificare lo stato di esecuzione o visualizzare una percentuale di log riusciti. L'indicazione di una frequenza di campionamento è utile per farlo senza scrivere un volume elevato di INFO voci di log Logging, che può comportare costi più elevati per Logging.

Per specificare una frequenza di campionamento, imposta info_log_sample_rate su un valore in virgola mobile valido maggiore di 0 e minore o uguale a 1. La frequenza di campionamento determina probabilità che un log INFO venga scritto in Logging. Il valore predefinito è 1 (vengono scritti tutti i log INFO).

Configurazioni del livello di servizio

Puoi impostare le configurazioni del logging per servizi specifici. In questo modo viene sovrascritta l'impostazione di logging globale per il servizio in questione. Ad esempio, potresti avere l'implementazione globale di logging impostato su LOG_WARNINGS_AND_ABOVE, ma di impostare UserEventService livello di logging del servizio a LOG_ALL per permetterti di verificare integrazioni di eventi utente riuscite.

Utilizza l'oggetto ServiceLoggingLevel per impostare livelli di logging granulari.

Il campo service_name accetta i seguenti valori:

  • CompletionService
  • ControlService
  • MerchantCenterStreaming
  • ModelService
  • PredictionService
  • ProductService
  • ServingConfigService
  • UserEventService

Tipi di errore

Questa sezione fornisce le definizioni dei tipi di errore che possono essere visualizzati in log:

  • MISSING_FIELD: non è stato impostato il valore di un campo obbligatorio. Ad esempio, manca il titolo di un articolo del catalogo.
  • INVALID_TIMESTAMP: il timestamp non è valido, ad esempio è troppo lontano nel futuro o ha un formato errato.
  • FIELD_VALUE_TOO_SMALL: il valore nel campo è inferiore al valore richiesto minimum; ad esempio un prezzo negativo.
  • INCORRECT_JSON_FORMAT: il formato del valore JSON nella richiesta è errato, ad esempio manca una parentesi { .
  • INVALID_LANGUAGE_CODE: il formato del codice lingua non è corretto.
  • FIELD_VALUE_EXCEEDED: il valore nel campo è superiore a quanto consentito massimo.
  • INVALID_RESOURCE_ID: l'ID risorsa non è valido. ad esempio, una risorsa inesistente catalog_id nel nome della risorsa.
  • FIELD_SIZE_EXCEEDED: il numero di voci nel campo supera il limite massimo limite.
  • UNEXPECTED_FIELD: un campo che dovrebbe essere vuoto ha un valore; della Ad esempio, una transazione per un evento di visualizzazione della pagina dei dettagli.
  • INVALID_FORMAT: il formato del campo non è corretto, ad esempio non è valido stringa
  • RESOURCE_ALREADY_EXISTS: hai provato a creare una risorsa che esiste già. ad esempio un articolo di catalogo creato in precedenza.
  • INVALID_API_KEY: la chiave API non corrisponde al progetto nella tua richiesta.
  • INSUFFICIENT_PERMISSIONS: non disponi dell'autorizzazione per eseguire la richiesta. Questo errore è generalmente correlato all'assenza di un'autorizzazione IAM.
  • UNJOINED_WITH_CATALOG: la richiesta include un ID articolo di catalogo che non nel catalogo. Assicurati che il catalogo sia aggiornato.
  • BATCH_ERROR: la richiesta contiene più errori. ad esempio, un'importazione in linea con 10 elementi che non superano la convalida per diversi motivi.
  • INACTIVE_RECOMMENDATION_MODEL: hai eseguito query su un modello non attivo per il servizio.
  • ABUSIVE_ENTITY: l'ID visitatore o l'ID utente associato alla richiesta ha ha inviato un numero anomalo di eventi in un breve periodo di tempo.
  • FILTER_TOO_STRICT: il filtro per le richieste di previsione ha bloccato tutte le previsioni che consentono di analizzare i dati e visualizzare i risultati. Vengono restituiti gli articoli generici (non personalizzati) più apprezzati, a meno che la chiamata non abbia specificato strictFiltering come false, nel qual caso non viene restituito alcun articolo. Ecco alcuni motivi comuni per cui si verifica questo problema:

    • Stai specificando un tag filtro che non esiste nel tuo catalogo. L'aggiornamento di un tag filtro può richiedere fino a un giorno.
    • Il filtro è troppo limitato.

Visualizza le metriche di carico dei dati

Per monitorare l'importazione dei dati del catalogo e degli eventi utente nella console Google Cloud, segui questi passaggi:

  1. Visualizza le metriche degli errori per l'importazione dei dati del catalogo e degli eventi utente nella pagina Monitoraggio.

    Vai alla pagina Monitoraggio

  2. Una volta che il sistema di caricamento dei dati funziona correttamente, utilizza la Schede Catalogo ed Eventi nella pagina Dati per visualizzare dati aggregati informazioni sul tuo catalogo, visualizzare l'anteprima dei prodotti caricati e visualizzazioni delle metriche di integrazione degli eventi utente.

    Vai alla pagina Dati

  3. Per creare avvisi che ti informino se si verificano problemi con i dati segui le procedure descritte in Configurare gli avvisi di Cloud Monitoring.

Riepilogo dei dati di catalogo

Utilizza la scheda Catalogo nella pagina Dati per visualizzare statistiche sui dati di alto livello per ogni ramo del catalogo. Questa pagina mostra quanti prodotti hai importato, quanti prodotti sono disponibili e quando hai importato i prodotti per l'ultima volta ramo di catalogo.

Puoi anche visualizzare un'anteprima degli articoli del catalogo che hai caricato e filtrare in base ai campi del prodotto.

Puoi importare i dati in rami diversi per archiviarli e visualizzarne l'anteprima consigli o risultati di ricerca. Ad esempio: per prepararti alle festività, potresti caricare nuovi dati di catalogo in un ramo predefinito e assicurarsi che i risultati di Vertex AI Search for Retail siano generati correttamente prima di pubblicarli sul tuo sito web.

Statistiche sulla registrazione degli eventi utente

Nella scheda Evento puoi vedere per ogni tipo di evento utente quanti ne hai registrato, quanti di questi non sono stati associati a un prodotto (eventi non uniti) e in che modo i numeri sono diversi rispetto ai periodi precedenti. Puoi seleziona un periodo di tempo preimpostato o inserisci un intervallo di tempo personalizzato.

Il grafico delle metriche mostra gli eventi utente importati nel tempo, che puoi filtrare per tipo di evento utente.

Metriche sulla qualità dei dati

Nella pagina Qualità dei dati, puoi visualizzare le metriche che mostrano le percentuali di prodotti ed eventi utente che soddisfano gli standard consigliati di qualità dei dati per la ricerca. Utilizza questa pagina per valutare quali dati devi importare o aggiornare per migliorare la qualità dei risultati di ricerca e sbloccare i livelli di rendimento della ricerca.

Per ulteriori informazioni sui livelli delle prestazioni della ricerca e sul controllo della qualità per i tuoi dati, consulta Sbloccare i livelli di rendimento della ricerca.

Per un elenco di tutte le metriche relative alla qualità dei dati del catalogo, consulta Metriche sulla qualità dei dati del catalogo.

Per tutti i requisiti e i consigli relativi agli eventi utente per consigli e ricerca, consulta Requisiti e best practice per gli eventi utente.

Eventi non uniti

Quando un evento utente o una richiesta API si riferisce a un prodotto che non è stato caricato in Vertex AI Search for Retail, si tratta di un evento non unito. Utente non iscritto gli eventi continuano a essere registrati e le richieste non unite vengono gestite, ma nessuna delle due può essere utilizzate per migliorare ulteriormente il modello per previsioni future. Per questo motivo, devi assicurarti che la percentuale di eventi non registrati sia molto bassa sia per gli eventi dell'utente sia per le richieste di previsione.

Puoi visualizzare la percentuale di eventi utente non associati nella scheda Evento della pagina Dati.

Errori relativi all'API

Puoi vedere un grafico degli errori relativi all'API nel tempo, visualizzati in base al nome del metodo, facendo clic su Visualizza metriche dell'API nella barra dei pulsanti delle Pagina Monitoring.

Monitora l'attività del metodo API

Per visualizzare traffico, errori e latenza per metodo API, vai alla pagina Monitoring. Puoi selezionare un periodo di tempo preimpostato o inserire un intervallo di tempo personalizzato.

Per visualizzare ulteriori dettagli su ciascun grafico:

  • Sotto un grafico, fai clic sul nome di un metodo per isolarlo nel grafico.
  • Passa il cursore sopra un grafico per visualizzare un callout con ciascun metodo e i relativi in quel momento.
  • Fai clic e trascina una qualsiasi sezione del grafico per aumentare lo zoom sul periodo di nel tempo.

Passaggi successivi