En esta página se describe cómo obtener información sobre los errores que se han producido en las importaciones de catálogos y eventos de usuario, así como en otras operaciones de la API de Vertex AI Search para el sector del comercio.
Para obtener ayuda sobre cómo configurar alertas, consulta Configurar alertas de Cloud Monitoring.
Introducción
Para obtener resultados de la máxima calidad, es importante proporcionar información precisa del catálogo y eventos de usuario a la API. Monitorizar y comprender la fuente de los errores te ayuda a encontrarlos y corregirlos en tu sitio.
Ver errores de integración agregados
Para ver los errores agregados que generan los procesos de subida de datos y las solicitudes de predicción o de búsqueda, usa la página Monitorización.
En esta página se muestran todos los errores de la API Vertex AI Search para el sector del comercio. Puedes ver errores relacionados con el catálogo de productos, los eventos de usuario, las predicciones de recomendaciones, los resultados de búsqueda y los modelos. El sistema también registra los errores de las importaciones, como una línea mal formada en el archivo de Cloud Storage. El sistema registra hasta 100 errores por archivo de importación. Puede definir el periodo durante el que se muestran los errores y filtrar por tipo de error.
Puede hacer clic en un error concreto para ver los registros correspondientes en Cloud Logging.
Para abrir un registro de errores concreto, expándelo. Los registros de errores proporcionan más detalles sobre la solicitud, incluidas las cargas útiles de la solicitud y la respuesta, así como los detalles del error. Esta información puede ayudarte a determinar dónde se encuentra la llamada al método errónea en tu sitio.
En el caso de los errores de JSON no válido, puede obtener más información sobre el problema
ampliando el campo status
.
Ver el estado de una operación de integración específica
Puede ver el estado de una operación de integración específica en la ventana Estado de la actividad:
Ve a la página Datos de la consola de búsqueda de comercio.
Ir a la página DatosHaz clic en Estado de la actividad.
En la ventana Estado de la actividad se muestra el estado de las operaciones de larga duración en tu catálogo de productos, eventos de usuario y controles.
En esta ventana puedes inspeccionar los errores de operaciones de integración concretas.
En la columna Detalles de cualquier operación con un error, haga clic en Ver registros para inspeccionar sus archivos de registro en Cloud Logging.
Ver los registros en Cloud Logging
Para abrir los archivos de registro directamente en Cloud Logging, sigue este procedimiento. Para ver los registros, debe tener el rol Visor de registros (roles/logging.viewer
).
Ve a Explorador de registros en la Google Cloud consola. Ir a Explorador de registros
Selecciona tu proyecto de Vertex AI Search para el comercio en el selector de proyectos.
Haz clic en el menú desplegable Recurso y selecciona API consumida > Cloud Retail.
Para obtener más información sobre el Explorador de registros, consulta el artículo Ver registros con el Explorador de registros.
Por ejemplo, este enlace abre los registros de todos los errores de Vertex AI Search para el sector del comercio de la última hora:
Abrir los registros de Vertex AI Search para el comercio
Para configurar qué registros de API se escriben, consulta Configurar el registro.
Configurar el registro
Puedes configurar qué registros de servicio se escriben en Logging. La configuración de registro permite definir los niveles de gravedad en los que se escriben los registros, activar o desactivar el registro y anular los ajustes de registro predeterminados de servicios específicos.
Cada solicitud de API que haga un usuario final puede generar una entrada de registro. Una entrada contiene información como el método de la API, cuándo se invocó, el código de respuesta y los cuerpos de la solicitud y la respuesta. La configuración de registro de un proyecto especifica qué tipos de registros generados por la API se escriben en Logging, con la opción de especificar de forma granular las configuraciones de registro de servicios de API concretos.
Para actualizar las configuraciones de registro, necesitas el rol de editor de Vertex AI Search para el sector del comercio.
Puede usar la consola o la API LoggingConfig
para configurar Logging.
Consola
Para actualizar las configuraciones de registro en la consola, sigue estos pasos:
Ve a la página Monitorización de la consola de búsqueda de comercio.
Ir a la página MonitoringHaz clic en Configuración de registro.
Para definir una configuración de registro global, selecciona un nivel de registro. Si selecciona LOG_ALL, también debe introducir una frecuencia de muestreo para los registros correctos.
Para definir una configuración a nivel de servicio, selecciona un servicio para actualizarlo y elige su nivel de registro. Este ajuste anula la configuración de registro global.
curl
Para actualizar las configuraciones de registro mediante la API, usa el recurso LoggingConfig
. Consulta la referencia de la API LoggingConfig
.
Para ver la configuración de registro actual, usa
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: el ID de tu proyecto.
Para actualizar la configuración de registro, usa el método
loggingConfig.Patch
. Para obtener más información, consulta la referencia de la APILoggingConfig
.En este ejemplo se usa
loggingConfig.Patch
para definir la configuración de registro global enLOG_WARNINGS_AND_ABOVE
. También define dos configuraciones a nivel de servicio:CatalogService
se define comoLOG_WARNINGS_AND_ABOVE
yControlService
se define comoLOG_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" } } ] }'
Niveles de registro
Solo se escriben en Logging los registros de algunos niveles de gravedad. Los ajustes de nivel de registro determinan qué registros generados por un método de API se escriben en Logging.
Si no se ha definido ninguna configuración de registro a nivel de servicio para un método de API, se utiliza el ajuste de nivel de registro global.
El nivel de registro predeterminado es LOG_WARNINGS_AND_ABOVE
.
El campo logging_level
acepta los siguientes valores:
LOGGING_DISABLED
: no se ha escrito ningún registro.LOG_ERRORS_AND_ABOVE
: solo registra errores.LOG_WARNINGS_AND_ABOVE
: solo registra errores y advertencias.LOG_ALL
: registra todo, incluidos los registros correctos, como los registros deINFO
.
Frecuencia de muestreo de los registros correctos
Si define el nivel de registro en LOG_ALL
, pero no quiere registrar todos los registros correctos, puede especificar una frecuencia de muestreo. Por ejemplo, puede decidir monitorizar periódicamente los registros para confirmar el estado correcto o ver el porcentaje de registros correctos. Especificar una frecuencia de muestreo puede ayudarte a hacerlo sin escribir un gran volumen de entradas de registro INFO
en Logging, lo que puede conllevar costes más elevados.
Para especificar una frecuencia de muestreo, asigne a info_log_sample_rate
un valor float válido
mayor que 0 y menor o igual que 1. La frecuencia de muestreo determina la probabilidad de que se escriba un registro INFO
en Logging. El valor predeterminado es 1 (se escriben todos los registros INFO
).
Configuraciones a nivel de servicio
Puedes definir configuraciones de registro para servicios específicos. De esta forma, se sobrescribe el ajuste de registro global de ese servicio. Por ejemplo, puedes definir el nivel de registro global en LOG_WARNINGS_AND_ABOVE
, pero establecer el nivel de registro del servicio UserEventService
en LOG_ALL
para comprobar si las integraciones de eventos de usuario se han realizado correctamente.
Usa el objeto ServiceLoggingLevel
para definir niveles de registro detallados.
El campo service_name
acepta los siguientes valores:
CompletionService
ControlService
MerchantCenterStreaming
ModelService
PredictionService
ProductService
ServingConfigService
UserEventService
Tipos de error
En esta sección se proporcionan definiciones de los tipos de errores que pueden aparecer en tus registros:
MISSING_FIELD
: falta un valor de campo obligatorio, por ejemplo, el título de un elemento del catálogo.INVALID_TIMESTAMP
: la marca de tiempo no es válida, por ejemplo, porque tiene un formato incorrecto o es demasiado lejana.FIELD_VALUE_TOO_SMALL
: el valor introducido es inferior al mínimo que se requiere. Por ejemplo, un precio negativo.INCORRECT_JSON_FORMAT
: el formato del JSON de la solicitud no es correcto. Por ejemplo, falta un paréntesis "{".INVALID_LANGUAGE_CODE
: el formato del código de idioma no es correcto.FIELD_VALUE_EXCEEDED
: el valor introducido supera el máximo permitido.INVALID_RESOURCE_ID
: el ID del recurso no es válido. Por ejemplo, uncatalog_id
que no existe en el nombre del recurso.FIELD_SIZE_EXCEEDED
: el número de entradas del campo supera el límite máximo.UNEXPECTED_FIELD
: se ha introducido un valor en un campo que debería estar vacío. Por ejemplo, la transacción de un evento de la vista de la página de detalles.INVALID_FORMAT
: el formato del campo no es correcto, por ejemplo, en una cadena.RESOURCE_ALREADY_EXISTS
: has intentado crear un recurso que ya existe. Por ejemplo, un elemento del catálogo que ya se había creado.INVALID_API_KEY
: la clave de API no coincide con el proyecto de la solicitud.INSUFFICIENT_PERMISSIONS
: No tienes permiso para ejecutar la solicitud. Este error suele estar relacionado con la falta de un permiso de gestión de identidades y accesos obligatorio.UNJOINED_WITH_CATALOG
: la solicitud incluye un ID de elemento del catálogo que no existe en el catálogo. Comprueba que el catálogo está actualizado.BATCH_ERROR
: hay varios errores en la solicitud. Por ejemplo, una importación insertada con 10 elementos que no se puede validar por distintas razones.INACTIVE_RECOMMENDATION_MODEL
: has realizado una consulta relacionada con un modelo que no está activo.ABUSIVE_ENTITY
: El ID de visitante o el ID de usuario asociado a la solicitud ha enviado un número anormal de eventos en un breve periodo.FILTER_TOO_STRICT
: el filtro de la solicitud de predicción ha bloqueado todos los resultados de predicción. Se devuelven los elementos populares genéricos (no personalizados), a menos que la llamada haya especificadostrictFiltering
como false, en cuyo caso no se devuelve ningún elemento. Estos son algunos de los motivos habituales por los que se produce este problema:- Está especificando una etiqueta de filtro que no existe en su catálogo. Las actualizaciones de las etiquetas de filtro pueden tardar hasta un día en aplicarse.
- El filtro es demasiado estrecho.
Ver métricas de carga de datos
Para monitorizar la ingesta de datos de eventos de usuario y de catálogo en la Google Cloud consola, sigue estos pasos:
Consulte las métricas de errores de su catálogo y de la ingestión de datos de eventos de usuario en la página Monitorización.
Una vez que el sistema de subida de datos funcione correctamente, use las pestañas Catálogo y Evento de la página Datos para ver información agregada sobre su catálogo, obtener una vista previa de los productos que ha subido y consultar visualizaciones de las métricas de integración de eventos de usuario.
Para crear alertas que te avisen si hay algún problema con las subidas de datos, sigue los procedimientos que se indican en Configurar alertas de Cloud Monitoring.
Resumen de datos del catálogo
Use la pestaña Catálogo de la página Datos para ver estadísticas de datos generales de cada rama del catálogo. En esta página se muestra cuántos productos has importado, cuántos están en stock y cuándo importaste productos por última vez en cada rama del catálogo de productos.
También puede ver una vista previa de los elementos del catálogo que ha subido y filtrar por campos de producto.
Puedes importar datos a diferentes ramas para organizar y previsualizar recomendaciones o resultados de búsqueda. Por ejemplo, para prepararse para la temporada festiva, puede subir nuevos datos de catálogo a una rama que no sea la predeterminada y asegurarse de que los resultados de Vertex AI Search para el comercio se generen correctamente antes de publicarlos en su sitio web.
Estadísticas de grabación de eventos de usuario
En la pestaña Evento, puede ver cuántos eventos de cada tipo ha registrado, cuántos de ellos no se han podido asociar a un producto (eventos no unidos) y cómo han cambiado las cifras con respecto a periodos anteriores. Puede seleccionar un periodo predefinido o introducir un intervalo de tiempo personalizado.
El gráfico de métricas muestra los eventos de usuario registrados a lo largo del tiempo, que puede filtrar por tipo de evento de usuario.
Métricas de calidad de los datos
En la página Calidad de los datos, puede ver métricas que muestran los porcentajes de productos y eventos de usuario que cumplen los estándares de calidad de los datos recomendados para la búsqueda. Usa esta página para evaluar qué datos necesitas importar o actualizar para mejorar la calidad de los resultados de búsqueda y acceder a niveles de rendimiento de búsqueda.
Para obtener más información sobre los niveles de rendimiento de búsqueda y comprobar la calidad de tus datos, consulta el artículo Desbloquear niveles de rendimiento de búsqueda.
Para ver una lista de todas las métricas de calidad de los datos del catálogo, consulta Métricas de calidad de los datos del catálogo.
Para consultar todos los requisitos y recomendaciones de eventos de usuario para recomendaciones y búsquedas, consulta el artículo Requisitos y prácticas recomendadas de eventos de usuario.
Eventos sin coincidencias
Cuando un evento de usuario o una solicitud de API hace referencia a un producto que no se ha subido a Vertex AI Search para el sector del comercio, se trata de un evento sin unir. Los eventos de usuarios que no se han unido se siguen registrando y las solicitudes de usuarios que no se han unido se siguen gestionando, pero ninguno de los dos se puede usar para mejorar el modelo de cara a predicciones futuras. Por este motivo, debe asegurarse de que el porcentaje de eventos sin registrar sea muy bajo tanto en los eventos de usuario como en las solicitudes de predicción.
Puedes ver el porcentaje de eventos de usuario sin unir en la pestaña Evento de la página Datos.
Errores de la API
Para ver un gráfico de los errores de la API a lo largo del tiempo, ordenados por nombre de método, haga clic en Ver métricas de la API en la barra de botones de la página Monitorización.
Monitorizar la actividad de los métodos de API
Para ver visualizaciones del tráfico, los errores y la latencia por método de API, vaya a la página Monitorización. Puede seleccionar un periodo predefinido o introducir un intervalo de tiempo personalizado.
Para ver más detalles sobre cada gráfico, sigue estos pasos:
- Debajo de un gráfico, haz clic en el nombre de un método para aislarlo en el gráfico.
- Coloca el cursor sobre un gráfico para ver una llamada con cada método y sus valores en ese momento.
- Haz clic y arrastra el cursor sobre cualquier sección del gráfico para ampliar ese periodo.
Siguientes pasos
- Consulte cómo configurar alertas de error para sus feeds de datos.
- Más información sobre Error Reporting
- Consulta más información sobre cómo ver registros en Logging.