Reenvío de registros a IBM Cloud Logs
Registros de la plataforma son registros expuestos a los usuarios por varios servicios de la plataforma ' IBM Cloud '. IBM Analytics Engine " permite reenviar los registros del servicio " IBM Analytics Engine " a una instancia de " IBM Cloud " Logs habilitada para recibir los registros de la plataforma.
-
Los registros de plataforma son regionales.
Puede supervisar los registros desde IBM Analytics Engine en IBM Cloud en la región en la que el servicio está disponible.
-
Sólo puede configurar una instancia de IBM Cloud Logs por región y por cuenta IBM Cloud para recopilar registros de plataforma en esa ubicación.
Puede tener varias instancias de IBM Cloud Logs en una ubicación. Sin embargo, solo se puede configurar una instancia en una ubicación (región) para recibir registros de servicios de IBM Cloud, como IBM Analytics Engine en esa ubicación de IBM Cloud.
Además, los registros generados por una instancia " IBM Analytics Engine " perteneciente a una cuenta se reenvían a una instancia " IBM Cloud " Logs de la misma cuenta " IBM Cloud.
Para comprobar si el servicio IBM Cloud Logs está configurado para recibir registros de plataforma, consulte el panel de control de Observability.
Requisito previo para habilitar el registro de plataforma
Para ver los registros de plataforma de IBM Analytics Engine, debe utilizar el panel de control Observabilidad en IBM Cloud para configurar el registro de plataforma. Consulte Configuración de registros de plataforma a través del panel de control Observabilidad para ver los pasos que debe seguir para habilitar el registro a través del panel de control Observabilidad.
API de registro
Después de haber habilitado el registro de plataforma a través del panel de control Observabilidad, continúe con los pasos de las secciones siguientes para aprender a utilizar los puntos finales de API para habilitar el registro, inhabilitar el registro y ver la configuración de registro.
Las llamadas de API de registro requieren el GUID de la instancia de servicio. Si no ha tomado nota del GUID, consulte Recuperación del GUID de una instancia sin servidor.
Ahora, se exponen dos puntos finales de API de registro:
log_forwarding_configlogging. Este punto final de API está en desuso y se dejará de mantener pronto. Aunque puede utilizar este punto final, debe empezar a utilizar el punto finallog_forwarding_config.
Habilitación del reenvío de registros desde IBM Analytics Engine
Para activar el reenvío de los registros de la plataforma ' IBM Analytics Engine ' a los registros de ' IBM Cloud ', invoque la siguiente API contra una instancia existente de ' Analytics Engine '.
Existen dos métodos que puede utilizar para habilitar el reenvío de registros:
-
Valor predeterminado: en este caso, sólo colocará una solicitud para habilitar el reenvío de registros, y los registros relacionados con el origen o los orígenes de registro predeterminados (
spark-driver) empezarán a reenviarse. Puede hacer esto de una de las formas siguientes:- Utilizando el punto final de la API de
log_forwarding_config:curl -X PUT https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/<instance_guid>/log_forwarding_config -H "Authorization: Bearer $TOKEN" -H "content-type: application/json" -d '{"enabled":true}' - Utilizando el punto final de API de
logging(en desuso):curl -X PUT https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/<instance_guid>/logging -H "Authorization: Bearer $TOKEN" -H "content-type: application/json" -d '{"enable":true}
- Utilizando el punto final de la API de
-
Personalizado: con esta opción, obtendrá más control sobre la configuración de reenvío de registros. Por ejemplo, puede especificar los orígenes de los registros que desea reenviar. También puede optar por asociar algunas etiquetas a los registros, que pueden utilizarse posteriormente en IBM Cloud Logs como palabras clave de búsqueda para limitar la búsqueda a los registros aplicables. Puede hacer esto de una de las formas siguientes:
- Utilizando el punto final de la API de
log_forwarding_config:curl -X PUT https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/<instance_guid>/log_forwarding_config -H "Authorization: Bearer $TOKEN" -H "content-type: application/json" -d ' {"enabled":true,"sources": ["spark-driver", "spark-executor"],"tags": ["<tag_1>", "<tag_2>",...]} ' - Utilizando el punto final de API de
logging(en desuso):curl -X PUT https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/<instance_guid>/logging -H "Authorization: Bearer $TOKEN" -H "content-type: application/json" -d ' {"enable":true,"components": ["spark-driver", "spark-executor"],"tags": ["<tag_1>", "<tag_2>",...]} '
- Utilizando el punto final de la API de
Inhabilitación del registro de plataforma desde IBM Analytics Engine
Desactive el reenvío de IBM Analytics Engine registros de plataforma a IBM Cloud Logs, de una de las siguientes formas.
-
Utilizando el punto final de la API de
log_forwarding_config:curl -X PATCH https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/<instance_guid>/log_forwarding_config -H "Authorization: Bearer $TOKEN" -H "content-type: application/json" -d '{"enabled":false}' -
Utilizando el punto final de API de
logging(en desuso):curl -X PATCH https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/<instance_guid>/logging -H "Authorization: Bearer $TOKEN" -H "content-type: application/json" -d '{"enable":false}'
Visualización de la configuración de reenvío de registros de una instancia de IBM Analytics Engine
Vea la configuración de registro actual de una instancia de IBM Analytics Engine, de una de las maneras siguientes:
-
Utilizando el punto final de la API de
log_forwarding_config:curl -X GET https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/<instance_guid>/log_forwarding_config -H "Authorization: Bearer $TOKEN" -
Utilizando el punto final de API de
logging(en desuso):curl -X GET https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/<instance_guid>/logging -H "Authorization: Bearer $TOKEN"
Ejemplos de búsquedas de registros IBM Analytics Engine en el panel de IBM Cloud Logs
Puede reducir la búsqueda de los registros de plataforma relacionados con IBM Analytics Engine de la forma siguiente:
- Haga clic en "
Sourcesen el panel de IBM Cloud Logs y seleccione "ibmanalyticsengine" para obtener los registros de IBM Analytics Engine. - Para reducir aún más la búsqueda, puede especificar y buscar cualquier palabra clave relacionada con la aplicación Spark en la ventana de búsqueda.
Ejemplos de búsquedas
Esta sección lista ejemplos de cómo puede buscar registros. Todos los ejemplos utilizan los siguientes valores de ejemplo:
- ID de instancia de IBM Analytics Engine: '
4308f7a6-2cfd-4d7e-b7a7-678e71a27957 - ID de aplicación Spark:
5438585f-6413-4bb2-9251-8162d34f3dc3 - Orígenes para los que está habilitado el reenvío de registros:
spark-driveryspark-executor - Etiquetas asociadas:
prodyus-south
La siguiente imagen muestra un ejemplo de los resultados de búsqueda devueltos en el panel de IBM Cloud Logs. En la parte inferior de la imagen se puede ver el campo de entrada de búsqueda donde se introducen las consultas de búsqueda. En
el ejemplo, se han especificado el ID de aplicación 5438585f-6413-4bb2-9251-8162d34f3dc3 y el origen spark-driver.
Ejemplos de búsquedas:
-
Para recuperar los registros para todas las aplicaciones Spark enviadas en una instancia de IBM Analytics Engine específica, pase el ID de instancia en la ventana de búsqueda:
4308f7a6-2cfd-4d7e-b7a7-678e71a27957 -
Para captar los registros de una aplicación Spark específica, puede pasar:
- Una combinación del ID de instancia de IBM Analytics Engine y el ID de aplicación de Spark:
4308f7a6-2cfd-4d7e-b7a7-678e71a27957 5438585f-6413-4bb2-9251-8162d34f3dc3 - Solo el ID de aplicación:
5438585f-6413-4bb2-9251-8162d34f3dc3
- Una combinación del ID de instancia de IBM Analytics Engine y el ID de aplicación de Spark:
-
Para buscar los registros maestros de Spark de una aplicación, puede pasar:
- Una combinación del ID de instancia de IBM Analytics Engine, el ID de aplicación de Spark y la palabra clave
spark-driver:4308f7a6-2cfd-4d7e-b7a7-678e71a27957 5438585f-6413-4bb2-9251-8162d34f3dc3 spark-driver - Una combinación del ID de aplicación y la palabra clave
spark-driver:5438585f-6413-4bb2-9251-8162d34f3dc3 spark-driver
- Una combinación del ID de instancia de IBM Analytics Engine, el ID de aplicación de Spark y la palabra clave
-
Para buscar por varios nombres de origen de registro, puede pasar:
- Una combinación del ID de instancia de IBM Analytics Engine, el ID de aplicación de Spark y los nombres de origen:
4308f7a6-2cfd-4d7e-b7a7-678e71a27957 5438585f-6413-4bb2-9251-8162d34f3dc3 (spark-driver OR spark-executor-2) - Una combinación del ID de aplicación y los nombres de origen de registro:
5438585f-6413-4bb2-9251-8162d34f3dc3 (spark-driver OR spark-executor-2)
- Una combinación del ID de instancia de IBM Analytics Engine, el ID de aplicación de Spark y los nombres de origen:
-
Para obtener los registros relacionados con todas las aplicaciones que se ejecutan en una instancia determinada dentro de la región
us-southy el entornoprod, puede especificar lo siguiente en el campo de búsqueda:4308f7a6-2cfd-4d7e-b7a7-678e71a27957 "prod us-south"