Prérequis pour activer la journalisation de la plateforme

Pour afficher les journaux de la plateforme IBM Analytics Engine, vous devez utiliser le tableau de bord d'observabilité dans IBM Cloud pour configurer la consignation de la plateforme. Voir Configuration des journaux de plateforme via le tableau de bord Observabilité pour connaître les étapes à suivre pour activer la journalisation via le tableau de bord Observabilité.

API de journalisation

Une fois que vous avez activé la journalisation de plateforme via le tableau de bord Observabilité, passez aux étapes des sections suivantes pour apprendre à utiliser les noeuds finaux d'API pour activer la journalisation, désactiver la journalisation et afficher la configuration de la journalisation.

Les appels d'API de journalisation requièrent l'identificateur global unique de l'instance de service. Si vous n'avez pas noté l'identificateur global unique (GUID), voir Extraction de l'identificateur global unique d'une instance sans serveur.

A présent, deux noeuds finaux d'API de journalisation sont exposés:

• log_forwarding_config
• logging: Ce noeud final d'API est obsolète et sera bientôt abandonné. Bien que vous puissiez utiliser ce noeud final, vous devez commencer à utiliser le noeud final log_forwarding_config.

Activation de la transmission de journaux à partir de IBM Analytics Engine

Pour activer le transfert des journaux de la plateforme IBM Analytics Engine vers IBM Cloud Logs, invoquez l'API suivante sur une instance Analytics Engine existante.

Vous pouvez utiliser deux méthodes pour activer l'acheminement des journaux:

• Par défaut: dans ce cas, vous envoyez uniquement une demande d'activation de l'acheminement des journaux et les journaux associés à la ou aux sources de journal par défaut (spark-driver) commencent à être transférés. Vous pouvez effectuer cette opération de l'une des manières suivantes :

  • A l'aide du noeud final d'API 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}'
    

  • A l'aide du noeud final d'API logging (obsolète):

    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}
    

• Personnalisé: cette option vous permet de mieux contrôler la configuration de l'acheminement des journaux. Par exemple, vous pouvez spécifier les sources des journaux que vous souhaitez transférer. Vous pouvez également choisir d'associer des balises aux journaux, qui pourront ensuite être utilisées dans IBM Cloud Logs comme mots-clés de recherche pour affiner la recherche sur les journaux concernés. Vous pouvez effectuer cette opération de l'une des manières suivantes :

  • A l'aide du noeud final d'API 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>",...]} '
    

  • A l'aide du noeud final d'API logging (obsolète):

    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>",...]} '
    

Désactivation de la consignation de la plateforme à partir de IBM Analytics Engine

Désactivez le transfert des journaux de la plateforme IBM Analytics Engine vers IBM Cloud Logs, de l'une des manières suivantes.

• A l'aide du noeud final d'API 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}'
  

• A l'aide du noeud final d'API logging (obsolète):

  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}'
  

Affichage de la configuration de l'acheminement des journaux d'une instance IBM Analytics Engine

Affichez la configuration de journalisation en cours d'une instance IBM Analytics Engine de l'une des manières suivantes:

• A l'aide du noeud final d'API 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"
  

• A l'aide du noeud final d'API logging (obsolète):

  curl -X GET https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/<instance_guid>/logging -H "Authorization: Bearer $TOKEN"
  

Exemples de recherches de logs IBM Analytics Engine dans le tableau de bord IBM Cloud Logs

Vous pouvez affiner la recherche des journaux de plateforme liés à IBM Analytics Engine comme suit:

1. Cliquez sur " Sources dans le tableau de bord IBM Cloud Logs et choisissez " ibmanalyticsengine pour obtenir les journaux de IBM Analytics Engine.
2. Pour affiner votre recherche, vous pouvez entrer et rechercher des mots clés liés à votre application Spark dans la fenêtre de recherche.