فعال کردن گزارش‌های اشکال‌زدایی NGINX در «مسیریاب‌ها»

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید.
اطلاعات

در Apigee، «مسیریاب‌ها» به‌طور پیش‌فرض پیکربندی شده‌اند تا فقط پیام‌های خطا را در فایل‌های گزارش خطا ثبت کنند. بااین‌حال، ممکن است موقعیت‌های زیادی وجود داشته باشد که در آن‌ها نیاز به جمع‌آوری اطلاعات بیشتری برای تعیین دلیل وقوع یک خطای خاص داشته باشید. یکی از راه‌های انجام این کار این است که «مسیریاب» را پیکربندی کنید تا در حالت اشکال‌زدایی کار کند تا بتوانید گزارش‌های اشکال‌زدایی دریافت کنید که می‌تواند به شما کمک کند اطلاعات بیشتری درباره خطا کسب کنید و آن را سریع‌تر برطرف کنید.

این سند توضیح می‌دهد چگونه گزارش‌های اشکال‌زدایی را در «مسیریاب» Apigee Edge برای درخواست‌های میزبان مجازی خاص فعال کنید. گزارش‌گیری اشکال‌زدایی را می‌توان فعال کرد تا درصورت وجود هرگونه مشکل، اطلاعات بیشتری را ثبت کند، 400 Bad Request - SSL Certificate Error، در Northbound (بین برنامه «کاربر» و «مسیریاب»).

قبل‌از شروع

  • اگر با گزارش‌های خطای NGINX و سطوح گزارش‌گیری آشنا نیستید، لطفاً به مستندات گزارش خطای NGINX مراجعه کنید.
  • نام‌های سازمان، محیط، و میزبان مجازی درخواست‌های API را که باید اطلاعات اشکال‌زدایی آن‌ها را جمع‌آوری کنید جمع‌آوری کنید.

فعال کردن گزارش‌های اشکال‌زدایی NGINX در «مسیریاب‌ها»

این بخش نحوه فعال کردن گزارش‌های اشکال‌زدایی در «مسیریاب‌های لبه» را توضیح می‌دهد.

درحال شناسایی فایل پیکربندی میزبان مجازی مربوطه

مراحل زیر نحوه یافتن فایل پیکربندی میزبان مجازی مربوطه در «مسیریاب» را شرح می‌دهد:

  1. اگر نام سازمان، نام محیط، و میزبان مجازی را برای درخواست مشخص API که می‌خواهید اشکال‌زدایی کنید می‌دانید، فایل پیکربندی میزبان مجازی را به‌صورت زیر تعیین کنید:
    1. به فهرست راهنمای /opt/nginx/conf.d/ پیمایش کنید.
    2. بااستفاده از فرمان زیر، فایل ORG_NAME_ENV_NAME_VIRTUALHOST.conf را در دایرکتوری conf.d جستجو کنید:
      ls -ltrh | grep "ORG_NAME_ENV_NAME_VIRTUALHOST_NAME"
  2. اگر نام سازمان را نمی‌دانید، می‌توانید فایل پیکربندی میزبان مجازی را بااستفاده از نام مستعار میزبان که در درخواست API استفاده می‌شود به این روش شناسایی کنید:

    به دایرکتوری /opt/nginx/conf.d/ بروید و hostalias را که درخواست با آن انجام شده است بااستفاده از فرمان زیر جستجو کنید:

    ls -ltrh | grep -r 'HOST_ALIAS_NAME'

    برونداد نمونه:

    فرض کنیم نام مستعار میزبان opdk.cert-test.com باشد. وقتی فرمان ls -ltrh را اجرا می‌کنید، برونداد را به‌صورت زیر می‌بینید:

فعال کردن گزارش‌گیری اشکال‌زدایی برای میزبان مجازی خاص در «مسیریاب»

مراحل زیر نحوه فعال کردن گزارش‌های اشکال‌زدایی در «مسیریاب‌های Apigee» برای میزبان مجازی خاصی را شرح می‌دهد.

  1. فایل زیر را در دستگاه «مسیریاب» در ویرایشگر باز کنید: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf. برای مثال:
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf
  2. خط زیر را تغییر دهید:
    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;

    تا

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;
  3. تغییرات را ذخیره کنید.
  4. فرمان بارگیری مجدد NGINX را اجرا کنید. برای مثال:
    sudo /opt/nginx/scripts/apigee-nginx reload
  5. فایل زیر اکنون گزارش‌های اشکال‌زدایی را ضبط خواهد کرد:
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  6. اگر می‌خواهید گزارش‌های اشکال‌زدایی را در بیش‌از یک «مسیریاب» ضبط کنید، این مراحل را در هریک از «مسیریاب‌ها» تکرار کنید.

درستی‌سنجی اطلاعات اشکال‌زدایی در فایل گزارش خطای NGINX ثبت می‌شود

  1. وقتی کارخواهان «درخواست‌های میانای برنامه‌سازی کاربردی» را در نام مستعار میزبان و درگاه مرتبط با پیکربندی میزبان مجازی ایجاد می‌کنند، گزارش‌های اشکال‌زدایی در فایل زیر ضبط می‌شود:

    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log

  2. تأیید کنید که اطلاعات اشکال‌زدایی را برای درخواست‌های 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 با بار مفید بزرگ ارسال می‌کند، اطلاعات نشان‌داده‌شده در بالا ضبط می‌شود. این گزارش فقط زمانی نشان داده می‌شود که گزارش‌گیری اشکال‌زدایی فعال باشد.

  3. اگر اطلاعات اشکال‌زدایی اضافی را نمی‌بینید، تأیید کنید که همه مراحل ذکرشده در فعال کردن گزارش اشکال‌زدایی برای میزبان مجازی خاص در «مسیریاب» را به‌درستی دنبال کرده‌اید. اگر مرحله‌ای را ازدست داده‌اید، همه مراحل را دوباره به‌درستی تکرار کنید.
  4. اگر همچنان نمی‌توانید اطلاعات اشکال‌زدایی را دریافت کنید، لطفاً با پشتیبانی Apigee Edge تماس بگیرید.

غیرفعال کردن گزارش‌های اشکال‌زدایی برای میزبان مجازی خاص در «مسیریاب»

این بخش توضیح می‌دهد چگونه گزارش‌های اشکال‌زدایی را در «مسیریاب» برای یک میزبان مجازی خاص غیرفعال کنید.

  1. فایل زیر را در دستگاه «رهیاب» در ویرایشگر باز کنید: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf برای مثال:
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf
  2. خط زیر را تغییر دهید:

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;

    تا

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;
  3. تغییرات را ذخیره کنید.
  4. فرمان بارگیری مجدد NGINX را اجرا کنید. برای مثال:
    /opt/nginx/scripts/apigee-nginx reload
  5. فایل زیر اکنون فقط گزارش‌های خطا را ضبط می‌کند:
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  6. اگر می‌خواهید گزارش‌های اشکال‌زدایی را در بیش‌از یک «مسیریاب» متوقف کنید، این مراحل را در هریک از «مسیریاب‌ها» تکرار کنید.

فقط اطلاعات خطا در فایل گزارش خطای NGINX ثبت می‌شود

  1. درخواست‌های میانای برنامه‌سازی کاربردی را در نام مستعار میزبان و درگاه مرتبط با پیکربندی میزبان مجازی خاص انجام دهید یا منتظر بمانید تا مشتریان درخواست‌ها را انجام دهند.
  2. فایل زیر را بررسی کنید: /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  3. تأیید کنید که فقط اطلاعات خطا را می‌بینید و اطلاعات اشکال‌زدایی دیگر برای درخواست‌ها ثبت نمی‌شود.
  4. اگر همچنان می‌بینید که اطلاعات اشکال‌زدایی اضافی ثبت می‌شود، تأیید کنید که همه مراحل ذکرشده در غیرفعال کردن گزارش‌های اشکال‌زدایی برای میزبان مجازی خاص در «رهیاب» را به‌درستی دنبال کرده‌اید. اگر مرحله‌ای را ازدست داده‌اید، همه مراحل را دوباره به‌درستی تکرار کنید.
  5. اگر همچنان نمی‌توانید اطلاعات اشکال‌زدایی را دریافت کنید، لطفاً با پشتیبانی Apigee Edge تماس بگیرید.