Pré-requisito para ativar a criação de log da plataforma

Para visualizar os logs da plataforma IBM Analytics Engine, deve-se usar o painel Observabilidade em IBM Cloud para configurar a criação de log da plataforma. Consulte Configurando logs da plataforma por meio do painel Observabilidade para obter as etapas que você precisa seguir para ativar a criação de log por meio do painel Observabilidade.

APIs de registro

Depois de ter ativado a criação de log da plataforma por meio do painel Observabilidade, continue com as etapas nas seções a seguir para saber como usar os terminais de API para ativar a criação de log, desativar a criação de log e visualizar a configuração de criação de log

As chamadas API de criação de log requerem o GUID da instância de serviço. Se não anotou o GUID, consulte Recuperando o GUID de uma instância serverless.

Agora, dois terminais de API de criação de log são expostos:

• log_forwarding_config
• logging. Esse terminal de API foi descontinuado e será descontinuado em breve Embora você possa usar esse terminal, deve começar a usar o terminal log_forwarding_config.

Ativando o encaminhamento de log do IBM Analytics Engine

Para ativar o encaminhamento de registros da plataforma IBM Analytics Engine para o IBM Cloud Logs, invoque a seguinte API em uma instância Analytics Engine existente.

Há dois métodos que você pode usar para ativar logs de encaminhamento:

• Padrão: nesse caso, você apenas coloca uma solicitação para ativar o encaminhamento de log e os logs relacionados à origem ou origens de log padrão (spark-driver) começarão a ser encaminhados. Isso pode ser feito de uma das seguintes maneiras:

  • Usando o terminal de API do 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}'
    

  • Usando o terminal de API do logging (descontinuado):

    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}
    

• Customizado: com essa opção, você obtém mais controle sobre a configuração de encaminhamento de log.. Por exemplo, é possível especificar as origens dos logs que você deseja que sejam encaminhadas Você também pode optar por associar algumas tags aos logs, que podem ser usadas posteriormente no IBM Cloud Logs como palavras-chave de pesquisa para restringir a pesquisa nos logs aplicáveis. Isso pode ser feito de uma das seguintes maneiras:

  • Usando o terminal de API do 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>",...]} '
    

  • Usando o terminal de API do logging (descontinuado):

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

Desativando a criação de log da plataforma por meio do IBM Analytics Engine

Desative o encaminhamento dos logs da plataforma IBM Analytics Engine para o IBM Cloud Logs, de uma das seguintes maneiras.

• Usando o terminal de API do 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}'
  

• Usando o terminal de API do logging (descontinuado):

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

Visualizando a configuração de encaminhamento de log de uma instância do IBM Analytics Engine

Visualize a configuração de criação de log atual de uma instância do IBM Analytics Engine, de uma das seguintes maneiras:

• Usando o terminal de API do 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"
  

• Usando o terminal de API do logging (descontinuado):

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

Exemplos de pesquisas de registro IBM Analytics Engine no painel do IBM Cloud Logs

É possível limitar a procura para os logs da plataforma relacionados ao IBM Analytics Engine conforme a seguir:

1. Clique em " Sources no painel do IBM Cloud Logs e escolha " ibmanalyticsengine para obter os registros de IBM Analytics Engine.
2. Para limitar ainda mais sua procura, é possível inserir e procurar quaisquer palavras-chave relacionadas ao seu aplicativo Spark na janela de procura.