Рекомендации по запросам в службу поддержки Google Cloud Apigee

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

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

Если вы предоставите подробную информацию по запросу, служба поддержки Google Cloud Apigee сможет быстро и эффективно вам помочь. Если в вашем запросе в службу поддержки не хватает важной информации, нам приходится запрашивать ее, и это может занять много времени. Это занимает больше времени и может привести к задержкам в решении проблем. В руководстве по эффективным методам рассказывается, какая информация нам нужна, чтобы быстрее решить вашу проблему.

Как описать проблему

В проблеме должна быть информация о том, что произошло, а также о том, что должно было произойти, когда и как. Хороший запрос в службу поддержки Apigee должен содержать следующую ключевую информацию о каждом из продуктов Apigee:

Основная информация Описание Apigee Edge для общедоступного облака Apigee Edge для частного облака
Товар Название продукта Apigee, в котором наблюдается проблема, включая информацию о версии, если применимо.
  • Версия
Сведения о проблеме Четкое и подробное описание проблемы, включая полное сообщение об ошибке, если оно есть.
  • Сообщение об ошибке
  • Выходные данные инструмента трассировки
  • Инструкции по воспроизведению ошибки.
  • Полный запрос к API/команда
  • Сообщение об ошибке
  • Выходные данные инструмента трассировки
  • Инструкции по воспроизведению ошибки.
  • Полный запрос к API/команда
  • Журналы диагностики компонентов
Время Точная временная метка, когда началась проблема, и как долго она продолжалась.
  • Дата, время и часовой пояс, когда возникла проблема
  • Продолжительность проблемы
  • Дата, время и часовой пояс, когда возникла проблема
  • Продолжительность проблемы
Настройка Подробная информация о том, где наблюдается проблема.
  • Название организации
  • Название среды
  • Название прокси-сервера API
  • Версия
  • Топология сети
  • Неисправный компонент Edge

Ниже эти понятия описаны более подробно.

Товар

Существуют разные продукты Apigee, например Apigee Edge в общедоступном облаке и Apigee Edge в частном облаке, поэтому нам нужна информация о том, с каким именно продуктом возникла проблема.

В таблице ниже приведены примеры, в которых в столбце Что можно делать указана полная информация, а в столбце Чего делать нельзя – неполная.

DOs Чего делать нельзя
Развертывание прокси-сервера API OAuth2 не удалось в нашей организации Public Cloud…

Не удалось развернуть прокси-сервер API

(Нам нужно знать, в каком продукте Apigee вы столкнулись с проблемой.)

При установке Edge Private Cloud версии 4.50.00 произошла следующая ошибка:

Не удалось установить частное облако.

(Информация о версии отсутствует)

Сведения о проблеме

Предоставьте точную информацию о проблеме, включая сообщение об ошибке (если оно есть), а также ожидаемое и фактическое поведение.

В таблице ниже приведены примеры, в которых в столбце Что можно делать указана полная информация, а в столбце Чего делать нельзя – неполная.

DOs Чего делать нельзя

Новый прокси-сервер edgemicro edgemicro_auth не работает и выдает следующую ошибку:

{"error":"missing_authorization","error_description":"Missing Authorization header"}

Созданный сегодня прокси-сервер edgemicro не работает

(Название прокси-сервера неизвестно. Непонятно, возвращает ли прокси-сервер ошибку или какой-либо неожиданный ответ.)

При отправке запросов к прокси-серверу API наши клиенты получают ошибки 500 со следующим сообщением об ошибке:

{"fault":{"faultstring":"Execution of JSReadResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"content\" from undefined. (JSReadResponse.js:23)","detail":{"errorcode":"steps.javascript.ScriptExecutionFailed"}}}

При отправке запросов к прокси-серверу API клиенты получают ошибки 500.

Просто сообщить об ошибках 500 недостаточно, чтобы мы могли разобраться в проблеме. Нам нужно знать фактическое сообщение об ошибке и код ошибки, которые вы видите.)

Время

Время – очень важная информация. Специалисту службы поддержки важно знать, когда вы впервые столкнулись с этой проблемой, как долго она продолжалась и продолжается ли сейчас.

Специалист службы поддержки, который будет решать вашу проблему, может находиться в другом часовом поясе, поэтому относительные временные указания затрудняют диагностику. Поэтому мы рекомендуем использовать для временной метки формат ISO 8601, чтобы точно указать, когда была обнаружена проблема.

В таблице ниже приведены примеры того, как правильно (DOs) и неправильно (DON'Ts) указывать время и продолжительность проблемы.

DOs Чего делать нельзя
Вчера между 2020-11-06 17:30 PDT и 2020-11-06 17:35 PDT наблюдалось большое количество 503s…

Вчера в 17:30 в течение пяти минут наблюдалось большое количество 503s.

(Мы вынуждены использовать подразумеваемую дату, и неясно, в каком часовом поясе наблюдалась проблема.)

Высокая задержка наблюдалась в следующих прокси API с 9 ноября 2020 г., 15:30 (IST) по 9 ноября 2020 г., 18:10 (IST)…

На прошлой неделе в некоторых прокси API наблюдались высокие задержки.

(Непонятно, в какой день и как долго наблюдалась проблема на прошлой неделе.)

Настройка

Нам нужно знать, где именно вы видите проблему. В зависимости от того, какой продукт вы используете, нам потребуется следующая информация:

  • Если вы используете Apigee Cloud, у вас может быть несколько организаций, поэтому нам нужно знать, в какой именно организации и с какими другими деталями вы наблюдаете проблему:
    • Названия организации и среды
    • Название прокси-сервера API и номера версий (для неудачных запросов к API).
  • Если вы используете частное облако , то, возможно, применяете одну из поддерживаемых топологий установки. Поэтому нам нужно знать, какую топологию вы используете, включая такие детали, как количество центров обработки данных и узлов.

В таблице ниже приведены примеры, в которых в столбце Что можно делать указана полная информация, а в столбце Чего делать нельзя – неполная.

DOs Чего делать нельзя

401 Количество ошибок в общедоступном облаке Edge увеличилось с 6 ноября 2020 г., 09:30 по центральнокитайскому стандартному времени.

Настройки Edge

Ниже приведены сведения о неработающем API:
  Названия организаций: myorg
  Названия сред: test
  Названия прокси-серверов API: myproxy
  Номера версий: 3

Ошибка

{"fault":{"faultstring":"Failed to resolve API Key variable request.header.X-APP-API_KEY","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

Количество ошибок 401 увеличилось.

(В нем нет информации о том, какой продукт используется, когда возникла проблема и какие настройки были заданы.)

Не удается запустить Message Processor в Edge Private Cloud версии 4.19.06 после добавления дополнительных узлов шлюза.

Журналы диагностики:
Прикреплены журналы процессора сообщений.

Топология сети:
Прикреплен файл network-topology.png, содержащий дополнительные узлы.

Не удается запустить Message Processor в Edge Private Cloud версии 4.19.06 после добавления дополнительных узлов шлюза.

(Отсутствуют журналы Message Processor и Топология сети.)

Полезные объекты

Предоставление нам артефактов, связанных с проблемой, ускорит ее решение, поскольку поможет нам понять, что именно вы наблюдаете, и получить больше информации.

В этом разделе описаны некоторые полезные артефакты, которые можно использовать со всеми продуктами Apigee:

Общие артефакты для всех продуктов Apigee

Следующие артефакты полезны для всех продуктов Apigee: Apigee Edge в общедоступном облаке и Apigee Edge в частном облаке:

Объект Описание
Выходные данные инструмента трассировки В выходных данных инструмента Trace содержится подробная информация о запросах API, проходящих через продукты Apigee. Это полезно при любых ошибках во время выполнения, например 4XX, 5XX и проблемах с задержкой.
Скриншоты Скриншоты помогают понять, как именно проявляется проблема. Это поможет при обнаружении ошибок или проблем, например в интерфейсе или Аналитике.
HAR (архив HTTP) HAR – это файл, который создается инструментами HTTP-сеансов для отладки проблем, связанных с интерфейсом. Это можно сделать с помощью браузеров, таких как Chrome, Firefox или Internet Explorer.
tcpdumps Инструмент tcpdump захватывает пакеты TCP/IP, переданные или полученные через сеть. Это полезно при любых проблемах с сетью, например при сбоях подтверждения TLS, ошибках 502, проблемах с задержкой и т. д.

Дополнительные артефакты для Apigee Edge для частного облака

Для Apigee Edge для частного облака нам могут понадобиться дополнительные артефакты, которые помогут быстрее диагностировать проблемы.

Объект Описание
Топология сети Схема топологии установки Edge, описывающая вашу конфигурацию частного облака, включая все центры обработки данных, узлы и компоненты, установленные в каждом узле.
Журналы диагностики компонентов Edge Диагностические журналы, относящиеся к определенному компоненту Apigee Edge, например процессору сообщений, маршрутизатору или Cassandra.
Файл конфигурации установки Файл конфигурации, используемый при установке или обновлении Apigee Edge.

Этот файл полезен для проверки правильности всех настроек в случаях, когда возникают проблемы с установкой или переносом.

Дампы кучи Дампы кучи – это снимки процесса памяти Java. Это полезно, если в определенных компонентах Edge наблюдается высокая загрузка памяти или ошибки OutOfMemory.
Дампы потоков Дамп потоков – это снимок всех потоков выполняющегося процесса Java.

Это полезно, если вы наблюдаете высокую загрузку процессора или системы на определенных компонентах Edge.

Шаблоны и примеры обращений

В этом разделе приведены шаблоны и примеры обращений для разных продуктов, основанные на рекомендациях, описанных в этом документе:

Apigee Edge в общедоступном облаке

Шаблон

В этом разделе приведен пример шаблона для Apigee Edge в общедоступном облаке.

Проблема

<Provide detailed description of the problem or the behaviour being observed at your end. Укажите название и версию продукта, если применимо.>

Сообщение об ошибке:

<Include the complete error message observed (if any)>

Время начала проблемы (в формате ISO 8601):

Время окончания проблемы (в формате ISO 8601).

Сведения о настройке Apigee:
  Названия организаций:
  Названия сред:
  Названия прокси-серверов API:
  Номера версий:

Действия для воспроизведения проблемы

<Укажите, как воспроизвести проблему, если это возможно>

Информация о диагностике

<Список прикрепленных файлов>

Пример

В этом разделе приведен пример использования Apigee Cloud (Apigee в Google Cloud/Apigee Edge в общедоступном облаке).

Проблема

В нашей организации Public Cloud наблюдается большое количество ошибок 503 (Сервис недоступен). Просим вас разобраться в ситуации и устранить проблему или подсказать нам, как это сделать.

Сообщение об ошибке:

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

Время начала проблемы (формат ISO 8601): 2020-10-04 06:30 IST

Время окончания проблемы (формат ISO 8601): проблема не устранена.

Сведения о настройке Apigee Cloud:
  Названия организаций: myorg
  Названия сред: dev
  Названия прокси-серверов API: myproxy
  Номера версий: 3

Действия для воспроизведения проблемы

Чтобы воспроизвести проблему, выполните следующую команду curl:

curl -X GET 'https://myorg-dev.apigee.net/v1/myproxy'

Информация о диагностике

Выходные данные инструмента трассировки (trace-503.xml)

Apigee Edge для частного облака

Шаблон

В этом разделе приведен пример шаблона для Apigee Edge для частного облака.

Проблема

<Provide detailed description of the problem or the behaviour being observed at your end. Укажите название и версию продукта, если применимо.>

Сообщение об ошибке:

<Include the complete error message observed (if any)>

Время начала проблемы (в формате ISO 8601):

Время окончания проблемы (в формате ISO 8601).

Сведения о настройке Edge Private Cloud

<Прикрепите топологию сети, описывающую настройку вашего частного облака, включая центры обработки данных и узлы>

Действия для воспроизведения проблемы

<Укажите, как воспроизвести проблему, если это возможно>

Диагностическая информация

<Список прикрепленных файлов>

Пример

В этом разделе приведен пример использования Apigee Edge для частного облака.

Проблема

При установке сервера управления Apigee на узле 10 в рамках Edge Private Cloud 4.19.06 на Linux RHEL 7.6 возникает следующая ошибка.

Сообщение об ошибке

<snipped as the output is too long>
Checking for management-server uuid ................................................
Unable to get uuid for management-server.
Error: setup.sh: /opt/apigee/apigee-service/bin/apigee-service exited with unexpected status 1

Время начала проблемы (в формате ISO 8601). Проблема возникает при установке

Время окончания проблемы(формат ISO 8601): неприменимо.

Сведения о настройке Edge Private Cloud

Прикреплен файл network-topology.png.

Действия для воспроизведения проблемы

Вот команда, которая привела к ошибке выше:

/opt/apigee/apigee-setup/bin/setup.sh -p ms -f /app/NonProdConfig.txt

Информация о диагностике

Прикрепил следующие файлы:

  • output.txt с полным выводом указанной выше команды, включая сообщение об ошибке.
  • Журналы сервера управления и
  • Файл конфигурации NonProdConfig.txt