Вы просматриваете документацию по Apigee Edge.
См. документацию по Apigee X.
Версия 1.2.0
Запись записей в журналы Stackdriver Logging .
В этом содержимом содержится справочная информация по настройке и использованию этого расширения.
Предпосылки
Прежде чем использовать это расширение с API-прокси, вы должны:
В IAM назначьте разрешение Logging > Logs Writer участнику проекта, который будет представлять ваше расширение в системе ведения журнала Stackdriver. Инструкции по предоставлению ролей см. в разделе Предоставление ролей учетной записи службы для определенных ресурсов . Дополнительные сведения о ролях журналирования см. в Руководстве по управлению доступом .
Используйте консоль GCP для создания ключа для сервисного аккаунта .
Используйте содержимое полученного ключевого JSON-файла при добавлении и настройке расширения с помощью справочника по конфигурации .
О ведении журнала 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>
Параметры запроса
Параметр | Описание | Тип | По умолчанию | Необходимый |
---|---|---|---|---|
имя_журнала | Имя журнала, которому принадлежит эта запись. | Нить | Никто. | Да. |
метаданные | Метаданные о записи журнала. Дополнительные сведения и параметры настройки type и labels в metadata см. в статье MonitoredResource . | JSON | Никто. | Нет. |
сообщение | Данные для использования в качестве значения для этой записи журнала. | Нить | Никто. | Да. |
Ответ
Нет, если сообщение было записано в журнал. В противном случае запрос вернет ошибку. См. также Отладка расширения .
Справочник по конфигурации
Используйте следующее при настройке и развертывании этого расширения для использования в прокси-серверах API.
Общие свойства расширения
Следующие свойства присутствуют для каждого расширения.
Свойство | Описание | По умолчанию | Необходимый |
---|---|---|---|
name | Имя, которое вы даете этой конфигурации расширения. | Никто | Да |
packageName | Имя пакета расширения, предоставленное Apigee Edge. | Никто | Да |
version | Номер версии пакета расширения, из которого вы настраиваете расширение. | Никто | Да |
configuration | Значение конфигурации, относящееся к добавляемому расширению. См. Свойства этого пакета расширения. | Никто | Да |
Свойства этого пакета расширения
Укажите значения для следующих свойств конфигурации, специфичных для этого расширения.
Свойство | Описание | По умолчанию | Необходимый |
---|---|---|---|
идентификатор проекта | Идентификатор проекта GCP, в котором должны создаваться журналы. | Никто. | Да. |
реквизиты для входа | При вводе в консоли Apigee Edge это содержимое файла ключа вашей учетной записи службы. При отправке через API управления это значение в кодировке base64 создается из файла ключа учетной записи службы. | Никто. | Да. |