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

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

Версия 2.0.1

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

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

Предпосылки

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

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

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

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

О Stackdriver Logging

Stackdriver Logging является частью набора продуктов Stackdriver в Google Cloud Platform (GCP). Он включает хранилище для журналов, пользовательский интерфейс, называемый Logs Viewer, и 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. Записи журнала состоят из метаданных и данных записи. Для получения дополнительной информации о записях журнала см. справочник Entry . Для получения информации о содержимом свойства metadata см. объект LogEntry в документации Stackdriver Logging.

<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.

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

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

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

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