Рекомендации по обращению в службу поддержки 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 в частном облаке , поэтому нам нужна конкретная информация о том, в каком конкретном продукте возникла проблема.

В следующей таблице приведены некоторые примеры, показывающие полную информацию в столбце «МОЖНО» и неполную информацию в столбце «НЕЛЬЗЯ» :

что делать НЕЛЬЗЯ
Не удалось развернуть API-прокси OAuth2 в нашей организации Public Cloud ...

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

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

Установка не удалась из-за следующей ошибки в нашем Edge Private Cloud версии 4.50.00 ...

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

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

Подробности проблемы

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

В следующей таблице приведены некоторые примеры, показывающие полную информацию в столбце «МОЖНО» и неполную информацию в столбце «НЕЛЬЗЯ» :

что делать НЕЛЬЗЯ

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

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

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

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

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

{"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"}}}

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

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

Время

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

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

В следующей таблице приведены примеры, показывающие точное время и продолжительность возникновения проблемы в столбце «НЕЛЬЗЯ» , а также неоднозначную или неясную информацию о том, когда возникла проблема, в столбце «НЕЛЬЗЯ» :

что делать НЕЛЬЗЯ
Огромное количество 503s наблюдалось вчера между 06.11.2020, 17:30 по тихоокеанскому времени и 06.11.2020, 17:35 по тихоокеанскому времени ...

Огромное количество 503s наблюдалось вчера в 17:30 в течение 5 минут.

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

Высокие задержки наблюдались на следующих прокси-серверах API с 09.11.2020 15:30 IST до 09.11.2020 18:10 IST ...

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

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

Настраивать

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

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

В следующей таблице приведены некоторые примеры, показывающие полную информацию в столбце «МОЖНО» и неполную информацию в столбце «НЕЛЬЗЯ» :

что делать НЕЛЬЗЯ

Число ошибок 401 в публичном облаке Edge увеличилось с 06.11.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 Ошибок стало больше.

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

Невозможно запустить обработчик сообщений в Edge Private Cloud версии 4.19.06 после добавления дополнительных узлов шлюза.

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

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

Невозможно запустить обработчик сообщений в Edge Private Cloud версии 4.19.06 после добавления дополнительных узлов шлюза.

(Журналы процессора сообщений и топология сети отсутствуют.)

Полезные артефакты

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

В этом разделе описаны некоторые полезные артефакты, которые полезны для всех продуктов 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, описывающая настройку частного облака, включая все центры обработки данных, узлы и компоненты, установленные на каждом узле.
Журналы диагностики пограничных компонентов Журналы диагностики относятся к конкретному компоненту Apigee Edge, например процессору сообщений, маршрутизатору или Cassandra.
Файл конфигурации установки Файл автоматической конфигурации, который используется при установке или обновлении Apigee Edge.

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

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

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

Шаблоны дел и образцы дел

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

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

Шаблон

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

Проблема:

<Предоставьте подробное описание проблемы или поведения, наблюдаемого с вашей стороны. Укажите название продукта и версию, если это применимо.>

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

<Включите полное сообщение об обнаруженной ошибке (если таковое имеется)>

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

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

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

Шаги по воспроизведению:

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

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

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

Пример случая

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

Проблема:

Мы наблюдаем большое количество ошибок 503 Service Unavailable в нашей организации Public Cloud . Можете ли вы разобраться в проблеме и решить ее или посоветовать нам, как ее решить?

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

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

Время начала проблемы (формат ISO 8601): 04.10.2020, 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 для частного облака .

Проблема:

<Предоставьте подробное описание проблемы или поведения, наблюдаемого с вашей стороны. Укажите название продукта и версию, если это применимо.>

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

<Включите полное сообщение об обнаруженной ошибке (если таковое имеется)>

Время начала проблемы (формат 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