結構化記錄

本文件將說明結構化記錄的概念,以及在記錄項目酬載欄位中加入結構的方法。當記錄酬載的格式為 JSON 物件,且該物件儲存在 jsonPayload 欄位中時,記錄項目就稱為「結構化記錄」。針對這些記錄,您可以建構查詢來搜尋特定 JSON 路徑,並在記錄酬載中索引特定欄位。相反地,如果記錄酬載的格式為字串,且儲存在 textPayload 欄位中,則記錄項目為非結構化。您可以搜尋文字欄位,但無法將內容編入索引。

如要建立結構化記錄項目,請執行下列任一操作:

  • 呼叫 entries.write API 方法,並提供已完整格式化的 LogEntry
  • 使用 gcloud logging write 指令。
  • 使用可寫入結構化記錄的 Cloud Logging 用戶端程式庫。

如要進一步瞭解這些方法,請參閱下列各節。

使用用戶端程式庫或 API 寫入記錄

您可以使用會呼叫 Cloud Logging API 的 Cloud Logging 用戶端程式庫,或直接呼叫 Cloud Logging API,來寫入記錄資料。用戶端程式庫可自動擷取部分資訊,並提供適當填入欄位的介面,簡化特殊 JSON 欄位的填入作業。不過,如要完全控制酬載的結構,請直接呼叫 Cloud Logging API,並將完整的 LogEntry 結構傳遞至 Cloud Logging API。

詳情請參閱 entries.write 參考資料。

如需程式碼範例,請參閱「撰寫結構化記錄檔」。

使用 gcloud CLI 寫入記錄

您可以使用 gcloud CLI 寫入記錄資料。這個介面支援非結構化記錄和結構化記錄。如要寫入結構化記錄,請提供序列化 JSON 物件的指令。

如需快速入門指南,請參閱「使用 Google Cloud CLI 寫入及查詢記錄項目」。

如需程式碼範例,請參閱 gcloud logging write 參考資料。

後續步驟