Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
В Apigee маршрутизаторы по умолчанию настроены на регистрацию в файлах журналов ошибок только сообщений об ошибках. Однако в некоторых случаях вам может потребоваться дополнительная информация, чтобы определить причину ошибки. Например, можно настроить маршрутизатор на работу в режиме отладки, чтобы получать журналы отладки. Это поможет вам получить больше информации об ошибке и быстрее ее устранить.
В этом документе рассказывается, как включить журналы отладки для запросов к определенному виртуальному хосту на маршрутизаторе Apigee Edge. Отладка журналов может быть включена для сбора дополнительной информации при возникновении проблем, таких как неправильный запрос, 400 Bad Request - SSL Certificate Error, на Northbound (между клиентским приложением и маршрутизатором).
Подготовка
- Если вы не знакомы с журналами ошибок NGINX и уровнями ведения журналов, ознакомьтесь с документацией по журналам ошибок NGINX.
- Соберите названия организации, среды и виртуального хоста для запросов API, для которых вам нужно собрать отладочную информацию.
Как включить журналы отладки NGINX на маршрутизаторах
В этом разделе рассказывается, как включить журналы отладки на пограничных маршрутизаторах.
Как определить подходящий файл конфигурации виртуального хоста
Чтобы найти нужный файл конфигурации виртуального хоста на маршрутизаторе, выполните следующие действия:
- Если вам известно название организации, среды и виртуального хоста для определенного запроса API, который вы хотите отладить, то определить файл конфигурации виртуального хоста можно следующим образом:
- Перейдите в каталог
/opt/nginx/conf.d/. - Найдите файл ORG_NAME_ENV_NAME_VIRTUALHOST
.confв каталогеconf.dс помощью следующей команды:ls -ltrh | grep "ORG_NAME_ENV_NAME_VIRTUALHOST_NAME"
- Перейдите в каталог
-
Если вы не знаете название организации, то можете определить файл конфигурации виртуального хоста по псевдониму хоста, который используется в запросе к API, следующим образом:
Перейдите в каталог
/opt/nginx/conf.d/и найдитеhostalias, с помощью которого был отправлен запрос, используя следующую команду:ls -ltrh | grep -r 'HOST_ALIAS_NAME'
Пример результата:
Предположим, псевдоним хоста –
opdk.cert-test.com. После выполнения командыls -ltrhвы увидите выходные данные, как показано ниже:
Как включить ведение журнала отладки для определенного виртуального хоста на маршрутизаторе
Ниже описано, как включить журналы отладки на маршрутизаторах Apigee для определенного виртуального хоста.
- Откройте следующий файл на компьютере маршрутизатора в редакторе:
/opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf. Пример:vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf
- Измените следующую строку:
error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;
to
error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;
- Сохраните изменения.
- Выполните команду перезагрузки NGINX. Пример:
sudo /opt/nginx/scripts/apigee-nginx reload
- Теперь следующий файл будет содержать журналы отладки:
/opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
- Если вы хотите получить журналы отладки для нескольких маршрутизаторов, повторите эти действия для каждого из них.
Проверка отладочной информации регистрируется в файле журнала ошибок NGINX
-
После того как клиенты отправят запросы API на псевдоним хоста и порт, связанные с конфигурацией виртуального хоста, журналы отладки будут сохранены в следующем файле:
/opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log -
Убедитесь, что вы видите отладочную информацию для запросов API, как показано в следующем примере:
Пример информации для отладки:
2021/01/27 02:48:40 [warn] 27624#27624: *3777 a client request body is buffered to a temporary file /opt/apigee/var/log/edge-router/nginx/client_temp/0000000001, client: XX.XX.XX.XX, server: XX.XX.XX.XX, request: "POST /post-no-target HTTP/1.1", host: "XX.XX.XX.XX:443"
Информация, указанная выше, будет получена, когда клиент отправит запрос
POSTс большим объемом данных. Этот журнал будет показываться только при включенном ведении журнала отладки. - Если вы не видите дополнительную информацию для отладки, убедитесь, что вы правильно выполнили все шаги, описанные в разделе Как включить ведение журнала отладки для определенного виртуального хоста на маршрутизаторе. Если вы пропустили какой-либо шаг, повторите все действия заново.
- Если вам не удается получить отладочную информацию, обратитесь в службу поддержки Apigee Edge.
Как отключить журналы отладки для определенного виртуального хоста на маршрутизаторе
В этом разделе рассказывается, как отключить журналы отладки в маршрутизаторе для определенного виртуального хоста.
- Откройте следующий файл на компьютере маршрутизатора в редакторе:
/opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.confПример:vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf
-
Измените следующую строку:
error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;
to
error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;
- Сохраните изменения.
- Выполните команду перезагрузки NGINX. Пример:
/opt/nginx/scripts/apigee-nginx reload
- Теперь в следующем файле будут регистрироваться только журналы ошибок:
/opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
- Если вы хотите остановить ведение журналов отладки на нескольких маршрутизаторах, повторите эти шаги для каждого из них.
Проверка того, что в файле журнала ошибок NGINX регистрируется только информация об ошибках
- Выполните несколько запросов к API на псевдониме хоста и порте, связанных с определенной конфигурацией виртуального хоста, или подождите, пока клиенты выполнят запросы.
- Проверьте следующий файл:
/opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log. - Убедитесь, что вы видите только информацию об ошибках и что отладочная информация больше не регистрируется для запросов.
- Если вы по-прежнему видите, что регистрируется дополнительная отладочная информация, убедитесь, что вы правильно выполнили все шаги, описанные в разделе Отключение отладочных журналов для определенного виртуального хоста на маршрутизаторе. Если вы пропустили какой-либо шаг, повторите все действия заново.
- Если вам не удается получить отладочную информацию, обратитесь в службу поддержки Apigee Edge.