504 গেটওয়ে টাইমআউট - রাউটার টাইমআউট হয়ে গেছে

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন দেখুন।
তথ্য

সমস্যার উপসর্গ

API কলের উত্তরে ক্লায়েন্ট অ্যাপ্লিকেশন 504 HTTP স্ট্যাটাস কোড সহ এই মেসেজটি পায়: Gateway Timeout

এই সমস্যার উত্তর থেকে বোঝা যায় যে API কল এক্সিকিউট করার সময় ক্লায়েন্ট Apigee Edge বা ব্যাকএন্ড সার্ভার থেকে সময়মতো উত্তর পায়নি।

সমস্যা সংক্রান্ত মেসেজ

ক্লায়েন্ট অ্যাপ্লিকেশন নিম্নলিখিত রেসপন্স কোড পায়:

HTTP/1.1 504 Gateway Time-out

cURL বা ওয়েব ব্রাউজার ব্যবহার করে এই ধরনের প্রক্সি কল করলে, আপনি নিম্নলিখিত সমস্যা দেখতে পেতে পারেন:

<!DOCTYPE html>
<html>
<head>
<title>Error</title>
<style>
    body {
        width: 35em;
        margin: 0 auto;
        font-family: Tahoma, Verdana, Arial, sans-serif;
    }
</style>
</head>
<body>
<h1>An error occurred.</h1>
<p>Sorry, the page you are looking for is currently unavailable.<br/>
Please try again later.</p>
</body>
</html>

টাইম-আউট হওয়ার কারণ কী?

Edge প্ল্যাটফর্মের মাধ্যমে API অনুরোধের সাধারণ পাথ হল ক্লায়েন্ট > রাউটার > মেসেজ প্রসেসর > ব্যাকএন্ড সার্ভার, যা নিম্নলিখিত ছবিতে দেখানো হয়েছে:

ক্লায়েন্ট, রাউটার, মেসেজ প্রসেসর ও ব্যাকএন্ড সার্ভার সহ Apigee Edge রানটাইম ফ্লোয়ের সব কম্পোনেন্ট উপযুক্ত ডিফল্ট টাইমআউট ভ্যালু দিয়ে সেট-আপ করা হয় যাতে API অনুরোধ সম্পূর্ণ হতে বেশি সময় না লাগে। ফ্লোয়ের কোনও কম্পোনেন্ট যদি টাইমআউট কনফিগারেশনে নির্দিষ্ট করা সময়সীমার মধ্যে আপস্ট্রিম কম্পোনেন্ট থেকে উত্তর না পায়, তাহলে নির্দিষ্ট কম্পোনেন্ট টাইমআউট হয়ে যাবে এবং সাধারণত একটি 504 Gateway Timeoutসমস্যা রিটার্ন করবে।

এই প্লেবুকে কীভাবে 504 সমস্যার সমাধান করতে হয় তা বর্ণনা করা হয়েছে। এই সমস্যা তখন হয় যখন রাউটার টাইম-আউট হয়ে যায়।

রাউটারে টাইম-আউট

Apigee Edge-এ রাউটারে কনফিগার করা ডিফল্ট টাইম-আউট হল ৫৭ সেকেন্ড। এটি হল সর্বাধিক সময়সীমা যার মধ্যে Edge-এ API অনুরোধ পাওয়ার সময় থেকে ব্যাকএন্ড থেকে পাওয়া উত্তর ও প্রয়োগ করা সব নীতি সহ উত্তর পাঠানোর সময় পর্যন্ত API প্রক্সি এক্সিকিউট করা যায়। রাউটার/ভার্চুয়াল হোস্টের ডিফল্ট টাইম-আউট ওভাররাইড করা যেতে পারে, যেমনটি রাউটারে I/O টাইম-আউট কনফিগার করা নিবন্ধে ব্যাখ্যা করা হয়েছে।

সম্ভাব্য কারণ

Edge-এ, রাউটার টাইম-আউট হওয়ার কারণে হওয়া 504 Gateway Timeout সমস্যার সাধারণ কারণগুলি হল:

কারণ বিবরণ এর জন্য প্রযোজ্য সমস্যার সমাধান সংক্রান্ত নির্দেশাবলী
রাউটারে ভুল টাইম-আউট কনফিগারেশন রাউটার ভুল I/O টাইম-আউট পিরিয়ড দিয়ে কনফিগার করা থাকলে এটি হয়। এজ পাবলিক ও প্রাইভেট ক্লাউড ব্যবহারকারী

সাধারণ ডায়াগনসিস ধাপ

এই সমস্যা ডায়াগনসিস করতে নিম্নলিখিত টুল/টেকনিকের মধ্যে একটি ব্যবহার করুন:

  • API মনিটরিং
  • NGINX অ্যাক্সেস লগ

API মনিটরিং

API মনিটরিং ব্যবহার করে সমস্যার ডায়াগনসিস করতে:

  1. বিশ্লেষণ করুন > API মনিটরিং > তদন্ত করুন পৃষ্ঠায় নেভিগেট করুন।
  2. 5xx সমস্যার জন্য ফিল্টার করুন এবং সময়সীমা বেছে নিন।
  3. সময়ের বিপরীতে স্ট্যাটাস কোড প্লট করুন।
  4. আরও বিবরণ দেখতে এবং নিচে দেখানো মতো এইসব সমস্যা সম্পর্কে লগ দেখতে, 504 সমস্যা দেখানো নির্দিষ্ট সেলে ক্লিক করুন:

    ৫০৪ সমস্যার উদাহরণ

  5. ডানদিকের প্যানেলে, লগ দেখুন বিকল্পে ক্লিক করুন।

    ট্রাফিক লগ উইন্ডো থেকে, কিছু 504 সমস্যার জন্য নিম্নলিখিত বিবরণগুলি নোট করুন:

    • অনুরোধ: এটি কল করার জন্য ব্যবহৃত অনুরোধ পদ্ধতি ও URI প্রদান করে
    • উত্তর সময়: এটি অনুরোধের জন্য মোট অতিক্রান্ত সময় প্রদান করে।

    উপরের উদাহরণে,

    • অনুরোধ GET /test-timeout-এর দিকে নির্দেশ করছে।
    • উত্তর দেওয়ার সময় হল 57.001 সেকেন্ড। এর থেকে বোঝা যায় যে মেসেজ প্রসেসর উত্তর দেওয়ার আগেই Router টাইম-আউট হয়ে গেছে, কারণ ভ্যালুটি Router-এ সেট করা ডিফল্ট I/O টাইম-আউটের খুব কাছাকাছি, যা ৫৭ সেকেন্ড।

    এছাড়াও, API মনিটরিং GET logs API ব্যবহার করে আপনি সব লগ পেতে পারেন। যেমন, org, env, timeRange, এবং status-এর জন্য কোয়েরি লগ করে, আপনি সেইসব ট্রানজ্যাকশনের জন্য সব লগ ডাউনলোড করতে পারবেন যেখানে ক্লায়েন্ট টাইম-আউট হয়ে গেছে।

    যেহেতু API মনিটরিং এইসব 504 এররের জন্য প্রক্সি - (সেট করা নেই) হিসেবে সেট করে, তাই আপনি ভার্চুয়াল হোস্ট ও পাথের জন্য সংশ্লিষ্ট প্রক্সি পেতে API (Logs API) ব্যবহার করতে পারবেন।

    যেমন :

    curl "https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=ORG&env=ENV&select=https
    
  6. অতিরিক্ত 504 সমস্যার জন্য প্রতিক্রিয়া জানানোর সময় পর্যালোচনা করুন এবং 504 সমস্যার মধ্যে প্রতিক্রিয়া জানানোর সময় সামঞ্জস্যপূর্ণ কিনা তা চেক করে দেখুন (রাউটারে সেট করা I/O টাইমআউট ভ্যালু যা ৫৭ সেকেন্ড)।

NGINX অ্যাক্সেস লগ

NGINX অ্যাক্সেস লগ ব্যবহার করে সমস্যার ডায়াগনসিস করতে:

  1. NGINX অ্যাক্সেস লগ চেক করুন:
    /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log
  2. নির্দিষ্ট সময়সীমার মধ্যে কোনও 504 সমস্যা হয়েছে কিনা (যদি সমস্যাটি আগে হয়ে থাকে) অথবা এখনও কোনও অনুরোধ ব্যর্থ হচ্ছে কিনা তা সার্চ করে দেখুন 504।
  3. কিছু 504 সমস্যার জন্য নিম্নলিখিত তথ্য মনে রাখবেন:
    • উত্তর দেওয়ার সময়
    • অনুরোধ করা URI

    এই উদাহরণে, আমরা নিম্নলিখিত তথ্য দেখতে পাই:

    • অনুরোধ করার সময়: 57.001 সেকেন্ড। এর থেকে বোঝা যায় যে রাউটার ৫৭.০০১ সেকেন্ড পরে টাইম-আউট হয়ে গেছে।

    • অনুরোধ: GET /test-timeout
    • হোস্টের ছদ্মনাম: myorg-test.apigee.net
  4. রাউটার/ভার্চুয়াল হোস্টে কনফিগার করা I/O টাইমআউট ও অনুরোধ করার সময় একই কিনা তা চেক করে দেখুন। হ্যাঁ হলে, এর অর্থ হল মেসেজ প্রসেসর এই সময়ের মধ্যে উত্তর না দেওয়ার আগে রাউটার টাইম-আউট হয়ে গেছে।

    উপরে দেখানো NGINX অ্যাক্সেস লগ এন্ট্রির উদাহরণে, অনুরোধ সময় 57.001 সেকেন্ড, রাউটারে সেট করা ডিফল্ট I/O টাইমআউটের খুব কাছাকাছি। এটি স্পষ্টভাবে ইঙ্গিত করে যে Message Processor উত্তর দেওয়ার আগেই রাউটার টাইম-আউট হয়ে গেছে।

  5. অনুরোধ ফিল্ডে বেস পাথ ব্যবহার করে, কোন API প্রক্সির জন্য অনুরোধ করা হয়েছে তা নির্ধারণ করুন।

কারণ: রাউটারে ভুল টাইম-আউট কনফিগারেশন

ডায়াগনসিস

  1. 504 সমস্যাগুলি কি এই কারণে হয়েছে যে মেসেজ প্রসেসর উত্তর দেওয়ার আগেই রাউটারের টাইম-আউট হয়ে গেছে তা নির্ধারণ করুন। আপনি এটি করতে পারেন, যদি API মনিটরিংয়ে রেসপন্স টাইম/রাউটারে রিকোয়েস্ট টাইম (দুটি ফিল্ড একই তথ্য দেখায়, তবে আলাদা আলাদা নামে পরিচিত) রাউটার/ভার্চুয়াল হোস্টে কনফিগার করা I/O টাইমআউটের সমান হয় এবং ফল্ট সোর্স, ফল্ট প্রক্সি ও ফল্ট কোড ফিল্ড - হিসেবে সেট করা থাকে, যা সাধারণ ডায়াগনসিস ধাপ-এ API মনিটরিং বা NGINX অ্যাক্সেস লগ হিসেবে ব্যাখ্যা করা হয়েছে।
  2. রাউটার বা নির্দিষ্ট ভার্চুয়াল হোস্টে কনফিগার করা I/O টাইমআউট ভ্যালু, মেসেজ প্রসেসর বা নির্দিষ্ট API প্রক্সিতে কনফিগার করা ভ্যালুর তুলনায় কম কিনা তা চেক করে দেখুন।

    এই বিভাগে উল্লেখ করা ধাপগুলি অনুসরণ করে আপনি এটি করতে পারবেন।

ভার্চুয়াল হোস্টের ক্ষেত্রে I/O টাইম-আউট যাচাই করা

Edge UI

Edge UI ব্যবহার করে ভার্চুয়াল হোস্ট টাইম-আউট যাচাই করতে, নিম্নলিখিত ধাপগুলি অনুসরণ করুন:

  1. Edge UI-তে লগ-ইন করুন।
  2. অ্যাডমিন > ভার্চুয়াল হোস্ট বিকল্পে নেভিগেট করুন।
  3. আপনি যেখানে টাইম-আউট সংক্রান্ত সমস্যার সম্মুখীন হচ্ছেন, সেই নির্দিষ্ট এনভায়রনমেন্ট বেছে নিন।
  4. আপনি যে নির্দিষ্ট ভার্চুয়াল হোস্টের জন্য I/O টাইমআউট ভ্যালু যাচাই করতে চান সেটি বেছে নিন।
  5. প্রপার্টি বিকল্পের মধ্যে, সেকেন্ডে প্রক্সি রিড টাইমআউট ভ্যালু দেখুন।

    উপরের উদাহরণে, প্রক্সি রিড টাইমআউট 120ভ্যালু দিয়ে কনফিগার করা হয়েছে। এর অর্থ হল, এই ভার্চুয়াল হোস্টে কনফিগার করা I/O টাইমআউট হল ১২০ সেকেন্ড।

ম্যানেজমেন্ট API

এছাড়াও, আপনি নিম্নলিখিত ম্যানেজমেন্ট API ব্যবহার করে প্রক্সি রিড টাইমআউট যাচাই করতে পারবেন:

  1. নিচে দেখানো virtualhost কনফিগারেশন পেতে ভার্চুয়াল হোস্ট পান API এক্সিকিউট করুন:

    পাবলিক ক্লাউড ব্যবহারকারী

    curl -v -X GET https://api.enterprise.apigee.com/v1/organizations/ORGANIZATION_NAME/environments/ENVIRONMENT_NAME/virtualhosts/VIRTUALHOST_NAME -u USERNAME
    

    প্রাইভেট ক্লাউড ব্যবহারকারী

    curl -v -X GET http://MANAGEMENT_SERVER_HOST:PORT#/v1/organizations/ORGANIZATION_NAME/environments/v/virtualhosts/VIRTUALHOST_NAME -u USERNAME
    

    যেখানে:

    ORGANIZATION_NAME হল সংস্থার নাম

    ENVIRONMENT_NAME হল এনভায়রনমেন্টের নাম

    VIRTUALHOST_NAME হল ভার্চুয়াল হোস্টের নাম

  2. proxy_read_timeout প্রপার্টির জন্য কনফিগার করা ভ্যালু চেক করুন

    ভার্চুয়াল হোস্টের সংজ্ঞা সংক্রান্ত নমুনা

    {
      "hostAliases": [
        "api.myCompany,com",
      ],
      "interfaces": [],
      "listenOptions": [],
      "name": "secure",
      "port": "443",
      "retryOptions": [],
      "properties": {
        "property": [
          {
            "name": "proxy_read_timeout",
            "value": "120"
          }
        ]
      },
      "sSLInfo": {
        "ciphers": [],
        "clientAuthEnabled": "false",
        "enabled": "true",
        "ignoreValidationErrors": false,
        "keyAlias": "myCompanyKeyAlias",
        "keyStore": "ref://myCompanyKeystoreref",
        "protocols": []
      },
      "useBuiltInFreeTrialCert": false
    }

    উপরের উদাহরণে, proxy_read_timeout-এর সাথে 120 ভ্যালু কনফিগার করা হয়েছে। এর অর্থ হল, এই ভার্চুয়াল হোস্টে কনফিগার করা I/O টাইমআউট হল ১২০ সেকেন্ড।

router.properties ফাইলে I/O টাইম-আউট যাচাই করা

  1. রাউটার মেশিনে লগ-ইন করুন।
  2. proxy_read_timeout ডিরেক্টরিতে /opt/nginx/conf.d প্রপার্টি সার্চ করুন এবং নিম্নলিখিত উপায়ে নতুন ভ্যালু সেট করা হয়েছে কিনা তা চেক করুন:
    grep -ri "proxy_read_timeout" /opt/nginx/conf.d
    
  3. নির্দিষ্ট ভার্চুয়াল হোস্ট কনফিগারেশন ফাইলে প্রপার্টির proxy_read_timeout জন্য সেট করা ভ্যালু চেক করুন।

    grep কমান্ড থেকে পাওয়া ফলাফলের নমুনা

    /opt/nginx/conf.d/0-default.conf:proxy_read_timeout 57;
    /opt/nginx/conf.d/0-edge-health.conf:proxy_read_timeout 1s;

    উপরের আউটপুটের উদাহরণে, লক্ষ্য করুন যে proxy_read_timeout প্রপার্টিটি 0-default.conf-এ নতুন ভ্যালু 57 দিয়ে সেট করা হয়েছে, যেটি হল ডিফল্ট ভার্চুয়াল হোস্টের কনফিগারেশন ফাইল। এর থেকে বোঝা যায় যে ডিফল্ট ভার্চুয়াল হোস্টের জন্য রাউটারে I/O টাইমআউট ৫৭ সেকেন্ডে কনফিগার করা আছে। আপনার একাধিক ভার্চুয়াল হোস্ট থাকলে, আপনি সেগুলির প্রত্যেকটির জন্য এই তথ্য দেখতে পাবেন। proxy_read_timeout-এর ভ্যালু পান। এর জন্য, API কল করার সময় আপনি যে নির্দিষ্ট ভার্চুয়াল হোস্ট ব্যবহার করেছেন সেটি 504 সমস্যার কারণে কাজ করেনি।

API প্রক্সিতে I/O টাইম-আউট যাচাই করা

আপনি নিম্নলিখিত জায়গায় I/O টাইম-আউট দেখতে পাবেন:

  • API প্রক্সির টার্গেট এন্ডপয়েন্ট
  • API প্রক্সির ServiceCallout নীতি
API প্রক্সির টার্গেট এন্ডপয়েন্টে I/O টাইমআউট দেখা
  1. Edge UI-তে, নির্দিষ্ট API প্রক্সি বেছে নিন যার I/O টাইমআউট ভ্যালু আপনি দেখতে চান।
  2. আপনি যে নির্দিষ্ট টার্গেট এন্ডপয়েন্ট চেক করতে চান সেটি বেছে নিন।
  3. TargetEndpoint কনফিগারেশনের মধ্যে <HTTPTargetConnection> এলিমেন্টের অধীনে উপযুক্ত ভ্যালু সহ io.timeout.millis প্রপার্টি দেখুন।

    যেমন, নিম্নলিখিত কোডে I/O টাইমআউট ১২০ সেকেন্ডে সেট করা আছে:

    <Properties>
      <Property name="io.timeout.millis">120000</Property>
    </Properties>
API প্রক্সির ServiceCallout নীতিতে I/O টাইম-আউট দেখা
  1. Edge UI-তে, ServiceCallout নীতির জন্য নতুন I/O টাইমআউট ভ্যালু দেখতে চান এমন নির্দিষ্ট API প্রক্সি বেছে নিন।
  2. আপনি যে নির্দিষ্ট ServiceCallout নীতি চেক করতে চান সেটি বেছে নিন।
  3. <ServiceCallout> কনফিগারেশনের অধীনে <Timeout> এলিমেন্টে উপযুক্ত ভ্যালু দেখুন।

    যেমন, নিম্নলিখিত কোডের I/O টাইমআউট ১২০ সেকেন্ড হবে:

    <Timeout>120000</Timeout>

মেসেজ প্রসেসরে I/O টাইমআউট যাচাই করা

  1. Message Processor মেশিনে লগ-ইন করুন।
  2. নিচের কমান্ড ব্যবহার করে /opt/apigee/edge-message-processor/conf ডিরেক্টরিতে HTTPTransport.io.timeout.millis প্রপার্টি সার্চ করুন:

    grep -ri "HTTPTransport.io.timeout.millis" /opt/apigee/edge-message-processor/conf
    

    আউটপুটের নমুনা

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPTransport.io.timeout.millis=55000
  3. উপরের আউটপুটের উদাহরণে, লক্ষ্য করুন যে প্রপার্টি HTTPTransport.io.timeout.millis-এর ভ্যালু 55000 হিসেবে সেট করা হয়েছে http.properties-এ। এটি থেকে বোঝা যায় যে মেসেজ প্রসেসরে I/O টাইম-আউট ৫৫ সেকেন্ডে সফলভাবে কনফিগার করা হয়েছে।

রাউটার ও মেসেজ প্রসেসরে কনফিগার করা টাইম-আউট নির্ধারণ করার পরে, যাচাই করে দেখুন যে রাউটার/ভার্চুয়াল হোস্ট মেসেজ প্রসেসর/এপিআই প্রক্সির তুলনায় কম টাইম-আউট ভ্যালু দিয়ে কনফিগার করা হয়েছে কিনা।

নিচের টেবিলে দেখানো সব লেয়ারে সেট করা ভ্যালুগুলি নোট করে নিন:

রাউটারে টাইম-আউট (সেকেন্ডে) ভার্চুয়াল হোস্টের টাইম-আউট (সেকেন্ড) মেসেজ প্রসেসরের টাইম-আউট (সেকেন্ড) API প্রক্সিতে টাইম-আউট (সেকেন্ড)
57 - 55 ১২০

এই উদাহরণে,

  • রাউটারে ডিফল্ট ভ্যালু হিসেবে ৫৭ সেকেন্ড কনফিগার করা থাকে।
  • নির্দিষ্ট ভার্চুয়াল হোস্টে টাইম-আউট ভ্যালু সেট করা নেই। এর অর্থ হল, এটি রাউটারে কনফিগার করা ৫৭ সেকেন্ডের ডিফল্ট ভ্যালু ব্যবহার করবে।
  • মেসেজ প্রসেসরে, ৫৫ সেকেন্ডের ডিফল্ট ভ্যালু কনফিগার করা হয়।
  • তবে, নির্দিষ্ট API প্রক্সিতে ১২০ সেকেন্ডের ভ্যালু কনফিগার করা আছে।

মনে রাখবেন, বেশি টাইম-আউট ভ্যালু শুধুমাত্র API প্রক্সিতে কনফিগার করা হয়, কিন্তু রাউটার এখনও ৫৭ সেকেন্ডের জন্য কনফিগার করা আছে। তাই, মেসেজ প্রসেসর/ব্যাকএন্ড এখনও আপনার অনুরোধ প্রসেস করছে বলে রাউটার ৫৭ সেকেন্ডে টাইম-আউট হয়ে যায়। এর ফলে রাউটার ক্লায়েন্ট অ্যাপ্লিকেশনকে 504 Gateway Timeout সমস্যার তথ্য সহ উত্তর দেয়।

রেজোলিউশন

এই সমস্যার সমাধান করতে, রাউটার ও মেসেজ প্রসেসরে সঠিক I/O টাইম-আউট কনফিগার করতে নিম্নলিখিত ধাপগুলি অনুসরণ করুন।

  1. Apigee Edge-এর মাধ্যমে API অনুরোধ ফ্লোতে অন্তর্ভুক্ত বিভিন্ন কম্পোনেন্টে কী কী টাইমআউট ভ্যালু সেট করা উচিত তা বুঝতে I/O টাইমআউট কনফিগার করার পেশাদার পদ্ধতি দেখুন।
  2. উপরের উদাহরণে, আপনি যদি নিশ্চিত হন যে একটি বেশি টাইমআউট ভ্যালু সেট করতে হবে কারণ ব্যাকএন্ড সার্ভারের বেশি সময় প্রয়োজন এবং আপনি মেসেজ প্রসেসরের টাইমআউট ভ্যালু বাড়িয়ে ১২০ সেকেন্ড করেছেন, তাহলে এর জন্য একটি বেশি টাইমআউট ভ্যালু সেট করুন যেমন: 123 seconds রাউটারে। নতুন টাইমআউট ভ্যালুর কারণে সব API Proxy যাতে প্রভাবিত না হয় তার জন্য, নির্দিষ্ট API Proxy-তে ব্যবহৃত 123 seconds-এর ভ্যালু শুধুমাত্র নির্দিষ্ট ভার্চুয়াল হোস্টে সেট করুন।
  3. ভার্চুয়াল হোস্টে টাইম-আউট সেট করতে, রাউটারে I/O টাইম-আউট কনফিগার করা লিঙ্কে দেওয়া নির্দেশাবলী অনুসরণ করুন।