Расширение ведения журнала Google Stackdriver

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Версия 1.3.7

Записывайте записи в журналы Stackdriver Logging .

Этот контент содержит информацию по настройке и использованию этого расширения.

Предварительные условия

Прежде чем использовать это расширение через прокси-сервер API, необходимо:

1. В IAM назначьте роль «Ведение журнала» > «Запись журналов» и «Ведение журнала» > «Просмотр журналов» участнику проекта, который будет представлять ваше расширение в системе ведения журнала Stackdriver. Инструкции по предоставлению ролей см. в разделе Предоставление ролей учетной записи службы для определенных ресурсов . Дополнительные сведения о ролях журналирования см. в Руководстве по контролю доступа .

2. Используйте консоль GCP для создания ключа для учетной записи службы .

3. Используйте содержимое полученного ключевого файла JSON при добавлении и настройке расширения с помощью справочника по конфигурации .

Это расширение поддерживает вызов с помощью политики ExtensionCallout , расположенной в PostClientFlow . Если вы хотите использовать политику ExtensionCallout для вызова этого расширения из PostClientFlow, убедитесь, что в вашей организации для флага features.allowExtensionsInPostClientFlow установлено значение true .

• Если вы являетесь клиентом Apigee Edge для публичного облака, вам необходимо обратиться в службу поддержки Apigee Edge, чтобы убедиться, что в вашей организации для флага features.allowExtensionsInPostClientFlow установлено значение true .

• Если вы являетесь клиентом Apigee Edge для частного облака, используйте API обновления свойств организации, чтобы установить для флага features.allowExtensionsInPostClientFlow значение true .

О ведении журнала Stackdriver

Stackdriver Logging является частью набора продуктов Stackdriver в Google Cloud Platform (GCP). Он включает в себя хранилище журналов, пользовательский интерфейс, называемый средством просмотра журналов, и API для программного управления журналами. С помощью Stackdriver Logging вы можете читать и записывать записи журнала, искать и фильтровать журналы, экспортировать журналы и создавать метрики на основе журналов.

Это расширение в настоящее время записывает записи в журнал. Дополнительную информацию см. в документации Stackdriver Logging .

Образцы

Следующие примеры иллюстрируют, как настроить поддержку действий расширения Stackdriver Logging с помощью политики ExtensionCallout .

Глобальный журнал

Следующая политика записывает сообщение «Это тест» в журнал example-log глобального ресурса Stackdriver. При фактическом использовании сообщение, вероятно, будет содержаться в переменной потока, значение которой вы установите в другом месте прокси-сервера 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 см. в разделе Добавление и настройка расширения .

Действия

бревно

Записывает сообщение в журнал.

Это действие записывает запись в журнал Stackdriver. Записи журнала состоят из метаданных и данных записи. Дополнительные сведения о записях журнала см. в разделе «Справочник по записям» . Сведения о содержимом свойства metadata см. в объекте LogEntry в документации по ведению журнала Stackdriver.

<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" : "stackdriver-log-name-to-use",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : "data-to-log-as-entry"
}]]></Input>

Параметры запроса

Ответ

Нет, если сообщение было записано в журнал. В противном случае запрос вернет ошибку. См. также Отладка расширения .

Справочник по конфигурации

Используйте следующее при настройке и развертывании этого расширения для использования в прокси-серверах API.

Общие свойства расширения

Следующие свойства присутствуют для каждого расширения.

Свойства этого пакета расширений

Укажите значения для следующих свойств конфигурации, специфичных для этого расширения.