Google Cloud Logging 拡張機能

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細

バージョン 1.6.0

Cloud Logging ログにエントリを書き込みます。

ここでは、この拡張機能を構成して使用するためのリファレンスを提供します。

前提条件

この拡張機能を API プロキシで使用する前に、次のことを行う必要があります。

1. IAM で、[ロギング] >ログ書き込みロールを、Cloud Logging システムの拡張機能を表すプロジェクト メンバーに付与します。ロールを付与する方法については、特定のリソースに対するロールをサービス アカウントに付与するをご覧ください。 ロギングロールの詳細については、アクセス制御ガイドをご覧ください。

2. Google Cloud コンソールを使用してサービス アカウント キーを生成する。

3. 拡張機能を追加および構成するときに、構成リファレンスを使用して生成されたキーの JSON ファイルの内容を使用します。

この拡張機能は、PostClientFlow にある ExtensionCallout ポリシーによる呼び出しをサポートしています。 ExtensionCallout ポリシーを使用して、 PostClientFlow 内に features.allowExtensionsInPostClientFlow フラグが 組織で true に設定されています。

• Apigee Edge for Public Cloud をご利用の場合は、Apigee Edge サポートに連絡して、 組織で features.allowExtensionsInPostClientFlow フラグが true に設定されている。

• Apigee Edge for Private Cloud をご利用の場合は、 Update organization properties API features.allowExtensionsInPostClientFlow フラグを true に設定します。

Cloud Logging について

Cloud Logging は Google Cloud のロギング / 説明します。ログのストレージ、ログと呼ばれるユーザー インターフェース、 ログをプログラムで管理するための API が用意されています。Cloud Logging を使用すると ログエントリの読み取りと書き込み、ログの検索とフィルタ、ログのエクスポートを行う ログベースの指標を作成できます

現在、Cloud Logging 拡張機能はログにエントリを書き込んでいます。詳しくは Cloud Logging のドキュメントをご覧ください。

サンプル

次の例は、Cloud Logging のサポートを構成する方法を示しています。 ExtensionCallout ポリシーで拡張機能のアクションを実行。

グローバルログ

次のポリシーは、メッセージ This is a test を Cloud グローバル リソースの example-log。実際に使用する場合は、おそらく 別の場所で値を設定したフロー変数にメッセージが含まれるようにする 使用します。

<?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 Cloud Logging ドキュメントをご覧ください。

<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 プロキシで使用するためにこの拡張機能を構成してデプロイする場合は、以下を使用します。

拡張機能の一般的なプロパティ

すべての拡張機能には次のプロパティがあります。

この拡張機能パッケージのプロパティ

この拡張機能に固有の次の構成プロパティの値を指定します。