啟用平台記載的必要條件

若要檢視 IBM Analytics Engine 平台日誌，您必須使用 IBM Cloud 中的「觀察」儀表板來配置平台記載。 請參閱 透過「觀察」儀表板配置平台日誌，以取得您需要遵循以透過「觀察」儀表板啟用記載功能的步驟。

記載 API

透過「觀察」儀表板啟用平台記載之後，請繼續下列各節中的步驟，以瞭解如何使用 API 端點來啟用記載、停用記載及檢視記載配置。

記載 API 呼叫需要服務實例的 GUID。 如果您未記下 GUID，請參閱 擷取無伺服器實例的 GUID。

現在，會公開兩個記載 API 端點:

• log_forwarding_config
• logging。此 API 端點已淘汰，即將停止提供。 雖然您可以使用此端點，但應該開始使用 log_forwarding_config 端點。

啟用從 IBM Analytics Engine 進行日誌轉遞

若要啟用將IBM Analytics Engine平台日誌轉送至IBM Cloud Logs，請針對現有的Analytics Engine實例呼叫下列 API。

您可以使用兩種方法來啟用轉遞日誌:

• 預設值: 在此情況下，您只會提出啟用日誌轉遞的要求，且與一或多個預設日誌來源 (spark-driver) 相關的日誌會開始轉遞。 您可以透過以下方式之一執行此操作：

  • 使用 log_forwarding_config API 端點:

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

  • 使用 logging API 端點 (已淘汰):

    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}
    

• 自訂: 使用此選項，您可以進一步控制日誌轉遞配置。 例如，您可以指定要轉遞的日誌來源。 您也可以選擇將一些標籤與日誌相關聯，稍後可以在IBM Cloud Logs 中將其用作搜尋關鍵字，以縮小適用日誌的搜尋範圍。 您可以透過以下方式之一執行此操作：

  • 使用 log_forwarding_config API 端點:

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

  • 使用 logging API 端點 (已淘汰):

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

從 IBM Analytics Engine 停用平台記載

透過以下方式之一停用將IBM Analytics Engine平台日誌轉送到IBM Cloud Logs。

• 使用 log_forwarding_config API 端點:

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

• 使用 logging API 端點 (已淘汰):

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

檢視 IBM Analytics Engine 實例的日誌轉遞配置

以下列其中一種方式檢視 IBM Analytics Engine 實例的現行記載配置:

• 使用 log_forwarding_config API 端點:

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

• 使用 logging API 端點 (已淘汰):

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

IBM Cloud Logs 儀表板中的IBM Analytics Engine日誌搜尋範例

您可以縮小與 IBM Analytics Engine 相關的平台日誌搜尋範圍，如下所示:

1. 點擊IBM Cloud Logs 儀表板上的 Sources 並選擇 ibmanalyticsengine 以從IBM Analytics Engine取得日誌。
2. 若要進一步縮小搜尋範圍，您可以在搜尋視窗中輸入並搜尋與 Spark 應用程式相關的任何關鍵字。