搭配建構記錄使用結構化記錄

本文件說明如何設定 Cloud Build 記錄，以便搭配 Cloud Logging 中的結構化記錄使用。

結構化記錄功能可讓您將 JSON 格式的建構記錄欄位儲存在 LogEntry 中的 jsonPayload 欄位或其他特定欄位中。您可以設定建構設定檔，這樣一來，當您將建構記錄傳送至 Logging 時，系統就會以這種方式對應特定建構記錄欄位。

舉例來說，如果您的建構記錄包含 message，則訊息會顯示在結果記錄項目的 textPayload 或 jsonPayload.message 中。如果無法將建構記錄欄位對應至特定記錄項目欄位，則建構記錄欄位會儲存在記錄項目 jsonPayload 中。

將建構記錄欄位對應至記錄項目欄位

如要在建構記錄中啟用欄位對應功能，請將 BuildOptions 欄位 enableStructuredLogging 設為 TRUE。

下表列出對應至記錄項目欄位的建構記錄欄位：

BuildLog 欄位 (JSON) LogEntry 欄位 說明 附註
message textPayload或jsonPayload.message 可讓您設定記錄訊息

必須是字串。

如果建構記錄只包含可對應的欄位，則訊息會顯示在 textPayload 中。否則，訊息會顯示在 jsonPayload.message 中。

如果建構記錄包含多個步驟，則步驟 ID 會顯示在訊息開頭。
severity severity 可讓您設定記錄嚴重性。 必須是 LogSeverity 的列舉。

下列建構記錄欄位無法對應，如果出現在建構記錄中，就會從記錄項目中移除：

  • httpRequest
  • logging.googleapis.com/insertId
  • logging.googleapis.com/labels
  • logging.googleapis.com/operation
  • logging.googleapis.com/sourceLocation
  • logging.googleapis.com/spanId
  • logging.googleapis.com/trace
  • logging.googleapis.com/trace_sampled
  • time
  • timestamp
  • timestampSeconds
  • timestampNanos

所有其他建構記錄檔欄位都會顯示在記錄項目的 jsonPayload 中。