Google Cloud Logging 擴充功能

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

1.6.6 版

將項目寫入 Cloud Logging 記錄檔。

這項內容提供設定與使用這項擴充功能的參考資源。

必要條件

如要透過 API Proxy 使用這個擴充功能，您必須：

1. 在 IAM 中，指派 Logging >記錄檔寫入者角色授予專案成員，該成員將代表 Cloud Logging 系統的擴充功能。如需授予角色的操作說明，請參閱將角色授予特定資源的服務帳戶。 如要進一步瞭解記錄角色，請參閱存取權控制指南。

2. 使用 Google Cloud 控制台產生服務帳戶的金鑰。

3. 使用設定參考資料新增及設定擴充功能時，請使用產生的金鑰 JSON 檔案內容。

這項額外資訊支援由 PostClientFlow 的 ExtensionCall 政策呼叫。 如果您想使用額外資訊摘要政策，從 PostClientFlow，確認 features.allowExtensionsInPostClientFlow 標記 已在貴機構中設為「true」。

• 如果您是 Apigee Edge for Public Cloud 客戶，請務必與 Apigee Edge 支援團隊聯絡， 貴機構的「features.allowExtensionsInPostClientFlow」標記已設為「true」。

• 如果您是適用於 Private Cloud 客戶的 Apigee Edge，請使用 更新機構屬性 API 將 features.allowExtensionsInPostClientFlow 標記設為 true。

關於 Cloud Logging

Cloud Logging 是 Google Cloud 作業套件。包括記錄檔儲存空間，名為「記錄檔」的使用者介面 Explorer 以及 API，可透過程式化的方式管理記錄檔。有了 Cloud Logging 讀取和寫入記錄項目、搜尋及篩選記錄、匯出記錄，以及 建立記錄指標。

Cloud Logging 擴充功能目前會將項目寫入記錄檔。如果需要 請參閱 Cloud Logging 說明文件。

範例

以下範例說明如何設定 Cloud Logging 支援 使用額外資訊摘要政策的額外資訊動作。

全域記錄檔

下列政策會將 This is a test 訊息寫入名為 example-log。實際使用時 該訊息會包含在流程變數中，其值由您在其他位置設定 存取 API

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Logging-Extension">
    <DisplayName>Logging Connector</DisplayName>
    <Connector>cloud-extension-sample</Connector>
    <Action>log</Action>
    <Input><![CDATA[{
        "logName": "example-log",
        "metadata": {
            "resource": {
                "type": "global",
                "labels": {
                    "project_id": "my-test"
                }
            }
        },
        "message": "This is a test."
    }]]></Input>
</ConnectorCallout>

這項內容提供設定與使用這項擴充功能的參考資源。 如需使用 Apigee 控制台設定擴充功能的步驟，請參閱 新增及設定擴充功能。

動作

log

這個外掛程式能將訊息寫入記錄。

這項操作會寫入 Cloud Logging 記錄項目。記錄項目由中繼資料組成 和項目資料如要進一步瞭解記錄項目，請參閱 項目參考資料。 如要進一步瞭解 metadata 屬性的內容，請參閱 LogEntry 物件。

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "cloud-log-name-to-use",
  "metadata" : JSON-structured-metadata,
  "message" : "data-to-log-as-entry"
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message": "This is a test."
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : { "info" :  "This is a test." }
}]]></Input>

要求參數

回應

None，表示訊息已寫入記錄。否則，要求會傳回錯誤。另請參閱對擴充功能偵錯。

設定參考資料

設定及部署這項擴充功能以用於 API Proxy 時，請使用下列指令。

常見擴充功能屬性

每個擴充功能都有下列屬性。

這個擴充功能套件的屬性

指定這個擴充功能專用的下列設定屬性值。