Google Stackdriver Logging 扩展程序

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

版本 1.2.1

将条目写入 Stackdriver Logging 日志。

本文内容提供了有关配置和使用此扩展程序的参考信息。

前提条件

通过 API 代理使用此扩展程序之前，您必须完成以下操作：

1. 在 IAM 中，向代表您的扩展程序的项目成员分配 Logging > Logs Writer 权限。如需了解如何授予角色，请参阅为服务帐号授予特定资源的角色。 如需详细了解日志记录角色，请参阅访问权限控制指南。

2. 使用 GCP Console 为服务帐号生成密钥。

3. 在通过配置参考添加和配置扩展程序时，使用所得到的 JSON 密钥文件的内容。

关于 Stackdriver Logging

Stackdriver Logging 是 Google Cloud Platform (GCP) 中 Stackdriver 产品套件的一部分。它包含日志存储、名为日志查看器的界面以及以程序化方式管理日志的 API。借助 Stackdriver Logging，您可以读取和写入日志条目、搜索和过滤日志、导出日志以及创建基于日志的指标。

此扩展程序目前会将条目写入日志。

如需了解详情，请参阅 Stackdriver Logging 文档。

示例

以下示例说明了如何使用 ExtensionCallout 政策配置对 Stackdriver Logging 扩展程序操作的支持。

全局日志

以下政策会将消息“This is a test”写入 Stackdriver 全局资源中名为 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>stackdriver-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 控制台配置扩展程序的步骤，请参阅添加和配置扩展程序。

Action

日志

向日志写入消息。

此操作会写入 Stackdriver 日志条目。日志条目由元数据和条目数据组成。如需详细了解日志条目，请参阅条目参考文档。如需了解 metadata 属性的内容，请参阅 Stackdriver Logging 文档中的 LogEntry 对象。

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-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 代理中使用时，请使用以下代码。

通用扩展属性

每个扩展程序都有以下属性。

此扩展程序软件包的属性

为此扩展程序的以下配置属性指定值。