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

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

Версия 1.2.1

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

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

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

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

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

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

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

О системе логирования Stackdriver

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. Записи журнала состоят из метаданных и самих данных записи. Дополнительную информацию о записях журнала см. в справочнике по записям . Информацию о содержимом свойства 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" : "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>

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

Ответ

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

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

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

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

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

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

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