Monitoraggio e risoluzione dei problemi

Questa pagina descrive come ottenere informazioni sugli errori che si sono verificati nelle importazioni di cataloghi ed eventi utente e in altre operazioni API in Vertex AI Search per il commercio.

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

Introduzione

Fornire informazioni accurate sul catalogo ed eventi utente all'API è importante per ottenere risultati di massima qualità. Il monitoraggio e la comprensione dell'origine degli errori ti aiutano a trovare e correggere eventuali errori nel tuo sito.

Visualizzare gli errori di integrazione aggregati

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

Questa pagina mostra tutti gli errori per l'API Vertex AI Search for Commerce. 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 di importazione, ad esempio una riga non valida 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 log relativi in Cloud Logging.

Puoi aprire i singoli log degli errori espandendoli. I log degli errori forniscono maggiori dettagli sulla richiesta, inclusi i payload di richiesta e risposta e i dettagli dell'errore. Queste informazioni possono aiutarti a determinare la posizione della chiamata al metodo errata nel tuo sito.

Per gli errori JSON non validi, puoi ottenere maggiori 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 nella finestra Stato attività:

  1. Vai alla pagina Dati nella console Cerca per il commercio.

    Vai alla pagina Dati

  2. Fai clic su Stato attività.

    La finestra Stato attività mostra lo stato delle operazioni a lunga esecuzione su controlli, eventi utente e catalogo prodotti.

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

  3. Fai clic su Visualizza log nella colonna Dettagli di qualsiasi operazione con un errore per esaminare i file di log in Cloud Logging.

Visualizza i log in Cloud Logging

Per aprire i file di log direttamente in Cloud Logging, utilizza la seguente procedura. 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 Commerce dal selettore di progetti.

  3. Fai clic sul menu a discesa Risorsa e seleziona API utilizzata > Cloud Retail.

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

Ad esempio, questo link apre i log di tutti gli errori di Vertex AI Search for Commerce nell'ultima ora:

Apri i log di Vertex AI Search per l'e-commerce

Per configurare i log API da scrivere, vedi Configura Logging.

Configura logging

Puoi configurare i log dei servizi che vengono scritti in Logging. La configurazione della registrazione fornisce un modo per impostare i livelli di gravità in base ai quali scrivere i log, attivare o disattivare la registrazione e ignorare le impostazioni di registrazione predefinite per servizi specifici.

Ogni richiesta API effettuata da un utente finale può generare una voce di logging. Una voce contiene informazioni quali il metodo API, quando è stato richiamato, il codice di risposta e i corpi della richiesta e della risposta. 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 disporre del ruolo Editor Vertex AI Search for Commerce.

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 Monitoraggio nella console Cerca per il commercio.

    Vai alla pagina Monitoring

  2. Fai clic su Configurazione logging.

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

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

curl

Per aggiornare le configurazioni di logging utilizzando l'API, utilizza la risorsa LoggingConfig. Consulta il riferimento 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 della registrazione, utilizza il metodo loggingConfig.Patch. Per saperne di più, consulta il riferimento API LoggingConfig.

    Questo esempio utilizza loggingConfig.Patch per impostare la configurazione di logging globale su LOG_WARNINGS_AND_ABOVE. Inoltre, imposta due configurazioni a livello di servizio: CatalogService è impostato su LOG_WARNINGS_AND_ABOVE e ControlService 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 di alcuni livelli di gravità. Le impostazioni del livello di logging determinano quali log generati da un metodo API vengono scritti in Logging.

Quando non è impostata alcuna configurazione di logging a livello di servizio per un metodo API, viene utilizzata l'impostazione del livello di logging globale.

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 errori e avvisi.
  • LOG_ALL: registra tutto, inclusi i log riusciti 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 la conferma dello stato riuscita o visualizzare una percentuale di log riusciti. Specificare una frequenza di campionamento può aiutarti a farlo senza scrivere un volume elevato di voci di log INFO in Logging, il che può comportare costi di Logging più elevati.

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

Configurazioni a livello di servizio

Puoi impostare configurazioni di logging per servizi specifici. In questo modo viene sovrascritta l'impostazione di logging globale per il servizio. Ad esempio, potresti impostare il livello di logging globale su LOG_WARNINGS_AND_ABOVE, ma impostare il livello di logging del servizio UserEventService su LOG_ALL per poter verificare l'integrazione degli eventi utente riuscita.

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 nei 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 è più basso del minimo richiesto. 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 è errato.
  • FIELD_VALUE_EXCEEDED: il valore nel campo è superiore al massimo consentito.
  • INVALID_RESOURCE_ID: l'ID risorsa non è valido. Ad esempio, un valore catalog_id inesistente nel nome della risorsa.
  • FIELD_SIZE_EXCEEDED: il numero di voci nel campo supera il limite massimo.
  • UNEXPECTED_FIELD: un campo che dovrebbe essere vuoto contiene un valore. Ad esempio, una transazione per un evento di visualizzazione della pagina dei dettagli.
  • INVALID_FORMAT: il formato del campo è errato, ad esempio una stringa con formato errato
  • RESOURCE_ALREADY_EXISTS: hai tentato di creare una risorsa già esistente, ad esempio un articolo di catalogo già creato in precedenza.
  • INVALID_API_KEY: la chiave API non corrisponde al progetto nella 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 esiste nel catalogo. Assicurati che il catalogo sia aggiornato.
  • BATCH_ERROR: la richiesta contiene diversi errori. Ad esempio, un'importazione in linea con 10 articoli che non superano la convalida per motivi diversi.
  • 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 inviato un numero anomalo di eventi in un breve periodo di tempo.
  • FILTER_TOO_STRICT: Il filtro delle richieste di previsione ha bloccato tutti i risultati della previsione. Vengono restituiti gli articoli popolari generici (non personalizzati), a meno che la chiamata non abbia specificato strictFiltering come false, nel qual caso non vengono restituiti articoli. Alcuni motivi comuni per cui si verifica questo problema:

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

Visualizzare le metriche di caricamento dei dati

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

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

    Vai alla pagina Monitoring

  2. Una volta che il sistema di caricamento dei dati è in esecuzione, utilizza le schede Catalogo ed Evento nella pagina Dati per visualizzare informazioni aggregate sul catalogo, visualizzare l'anteprima dei prodotti caricati e visualizzare le visualizzazioni delle metriche di integrazione degli eventi utente.

    Vai alla pagina Dati

  3. Per creare avvisi che ti informano in caso di problemi con i caricamenti dei dati, segui le procedure descritte in Configurare gli avvisi di Cloud Monitoring.

Riepilogo dei dati del catalogo

Utilizza la scheda Catalogo nella pagina Dati per visualizzare statistiche di alto livello per ogni ramo del catalogo. Questa pagina mostra quanti prodotti hai importato, quanti sono disponibili e quando hai importato gli ultimi prodotti per ogni ramo del catalogo prodotti.

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

Puoi importare i dati in rami diversi per organizzare e visualizzare in anteprima i suggerimenti o i risultati di ricerca. Ad esempio, per prepararsi a un periodo festivo, puoi caricare nuovi dati del catalogo in un ramo non predefinito e assicurarti che i risultati di Vertex AI Search per il commercio vengano generati correttamente prima di pubblicarli sul tuo sito web.

Statistiche di registrazione degli eventi utente

Per ogni tipo di evento utente, nella scheda Evento puoi vedere quanti ne hai registrati, quanti non sono stati associati a un prodotto (eventi non uniti) e come sono cambiati i numeri rispetto ai periodi precedenti. Puoi selezionare un periodo di tempo preimpostato o inserire un intervallo di tempo personalizzato.

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

Metriche di 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 di rendimento della ricerca e sul controllo della qualità dei dati, consulta Sbloccare i livelli di rendimento della ricerca.

Per un elenco di tutte le metriche sulla 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 suggerimenti e ricerche, consulta Requisiti e best practice per gli eventi utente.

Eventi non combinati

Quando un evento utente o una richiesta API fa riferimento a un prodotto che non è stato caricato in Vertex AI Search for Commerce, si tratta di un evento non unito. Gli eventi utente non uniti vengono comunque registrati e le richieste non unite vengono gestite, ma nessuno dei due può essere utilizzato per migliorare ulteriormente il modello per le previsioni future. Per questo motivo, devi assicurarti che la percentuale di eventi non registrati sia molto bassa sia per gli eventi utente sia per le richieste di previsione.

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

Errori API

Puoi visualizzare un grafico degli errori API nel tempo, visualizzati per nome del metodo, facendo clic su Visualizza metriche API nella barra dei pulsanti della pagina Monitoring.

Monitorare l'attività del metodo API

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

Per visualizzare maggiori dettagli su ogni grafico:

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

Passaggi successivi