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

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

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

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

Описание проблемы

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

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

В следующих разделах эти понятия описаны более подробно.

Продукт

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

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

DOs ЧЕГО НЕ СЛЕДУЕТ ДЕЛАТЬ
Развертывание API-прокси OAuth2 в нашей организации в публичном облаке завершилось неудачей...

Развертывание API-прокси завершилось неудачей.

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

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

В нашей системе частного облака установка завершилась неудачей.

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

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

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

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

DOs ЧЕГО НЕ СЛЕДУЕТ ДЕЛАТЬ

Новый 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 , чтобы указать точное время возникновения проблемы.

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

DOs ЧЕГО НЕ СЛЕДУЕТ ДЕЛАТЬ
Вчера в период с 17:30 по 17:35 по тихоокеанскому времени 6 ноября 2020 года было зафиксировано огромное количество 503s ...

Вчера в 17:30 в течение 5 минут было зафиксировано огромное количество 503s .

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

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

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

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

Настраивать

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

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

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

DOs ЧЕГО НЕ СЛЕДУЕТ ДЕЛАТЬ

С 06.11.2020 09:30 CST количество ошибок 401 в общедоступном облаке 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 ARchive) HAR-файл — это файл, который перехватывается инструментами HTTP-сессий для отладки любых проблем, связанных с пользовательским интерфейсом. Его можно перехватить с помощью таких браузеров, как Chrome, Firefox или Internet Explorer.
tcpdumps Инструмент tcpdump захватывает TCP/IP-пакеты, передаваемые или принимаемые по сети. Это полезно для решения любых проблем, связанных с сетью, таких как сбои TLS-рукопожатия, ошибки 502 , проблемы с задержкой и т. д.

Дополнительные артефакты для Apigee Edge for Private Cloud

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

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

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

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

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

Шаблоны и примеры кейсов

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

Apigee Edge в публичном облаке

Шаблон

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

Проблема:

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

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

<Укажите полное сообщение об ошибке (если таковое имеется)>

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

Время завершения задачи (в формате ISO 8601):

Детали настройки Apigee:
Названия организаций:
Названия переменных окружения:
Названия прокси-серверов API:
Номера редакций:

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

<По возможности укажите шаги для воспроизведения проблемы>

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

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

Пример из практики

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

Проблема:

В нашей организации в публичном облаке наблюдается большое количество ошибок 503 Service Unavailable. Не могли бы вы изучить эту проблему и устранить её или подсказать, как её решить?

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

{"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 for Private Cloud .

Проблема:

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

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

<Укажите полное сообщение об ошибке (если таковое имеется)>

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

Время завершения задачи (в формате ISO 8601):

Детали настройки частного облака Edge:

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

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

<По возможности укажите шаги для воспроизведения проблемы>

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

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

Пример из практики

В этом разделе представлен пример использования 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:

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

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

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

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

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

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

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