ট্রেস টুল ব্যবহার করা

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

Trace টুল কী?

Apigee Edge-এ রান করা API প্রক্সি সংক্রান্ত সমস্যার সমাধান ও তা মনিটর করার জন্য Trace একটি টুল। Trace আপনাকে API প্রক্সি ফ্লোয়ের মাধ্যমে প্রতিটি ধাপের বিবরণ পরীক্ষা করতে দেয়।

Trace কীভাবে ব্যবহার করতে হয়

Trace ব্যবহার করা সহজ। আপনি একটি ট্রেস সেশন শুরু করেন, তারপর Edge প্ল্যাটফর্মে একটি API কল করেন, এবং ফলাফল পড়েন।

1. নিচে বর্ণিত পদ্ধতি অনুযায়ী API প্রক্সি পৃষ্ঠা অ্যাক্সেস করুন।
   

   Edge

   Edge UI ব্যবহার করে API প্রক্সি পৃষ্ঠা অ্যাক্সেস করতে:

   1. apigee.com/edge লিঙ্কে গিয়ে সাইন-ইন করুন।
   2. বাঁদিকের নেভিগেশন বারে ডেভেলপ করুন > API প্রক্সি বিকল্প বেছে নিন।

   নতুন Edge UI (প্রাইভেট ক্লাউড)

   নতুন Edge UI ব্যবহার করে API প্রক্সি পৃষ্ঠা অ্যাক্সেস করতে:

   1. http://host:3001/edge-এ নতুন Edge UI-তে সাইন-ইন করুন, যেখানে host হল নতুন Edge UI রান করা হোস্টের IP অ্যাড্রেস বা DNS নাম।
   2. বাঁদিকের নেভিগেশন বারে ডেভেলপ করুন > API প্রক্সি বিকল্প বেছে নিন।
2. API Proxies পৃষ্ঠা থেকে API প্রক্সি বেছে নিন।
3. আপনি যে API ট্রেস করতে চান সেটি ডেপ্লয় করা হয়েছে কিনা তা নিশ্চিত করুন।
4. ট্রেস টুল ভিউতে যেতে ট্রেস করুন বিকল্পে ক্লিক করুন।
5. আপনি কোন ডেপ্লয়মেন্ট এনভায়রনমেন্ট ও প্রক্সি রিভিশন ট্র্যাক করতে চান তা বেছে নিতে ট্রেস করার জন্য ডেপ্লয়মেন্ট ড্রপডাউন মেনু ব্যবহার করুন।
6. ট্রেস সেশন শুরু করুন বিকল্পে ক্লিক করুন। Trace সেশন চালু থাকলে, API প্রক্সি প্রসেসিং পাইপলাইনের প্রতিটি ধাপের বিবরণ রেকর্ড করে। ট্রেস সেশন চলাকালীন, লাইভ ট্রাফিক থেকে মেসেজ ও প্রাসঙ্গিক ডেটা ক্যাপচার করা হয়।
   

   

7. আপনার প্রক্সির মাধ্যমে কোনও লাইভ ট্রাফিক না থাকলে, API-তে একটি অনুরোধ পাঠান। অনুরোধ পাঠানোর জন্য আপনি curl, Postman বা আপনার পরিচিত যেকোনও টুল ব্যবহার করতে পারেন। অথবা, আপনি সরাসরি ট্রেস টুল থেকেই অনুরোধ পাঠাতে পারেন। শুধু URL লিখে পাঠান বিকল্পে ক্লিক করুন। মনে রাখবেন: আপনি শুধুমাত্র Trace টুল থেকে GET অনুরোধ পাঠাতে পারবেন, কিন্তু POST অনুরোধ পাঠাতে পারবেন না।
   
   মনে রাখবেন: একটি Trace সেশন, বেছে নেওয়া API প্রক্সির মাধ্যমে প্রতি মেসেজ প্রসেসর পিছু ১০টি অনুরোধ/উত্তর ট্রানজ্যাকশন সাপোর্ট করতে পারে। Edge ক্লাউডে, ২টি মেসেজ প্রসেসর ট্রাফিক ম্যানেজ করার সাথে, ২০টি অনুরোধ/উত্তর ট্রানজ্যাকশন কাজ করে। আপনি ম্যানুয়ালি বন্ধ না করলে, ট্রেস সেশন অটোমেটিক ১০ মিনিট পরে বন্ধ হয়ে যায়।
   
8. পর্যাপ্ত সংখ্যক অনুরোধ ক্যাপচার করা হয়ে গেলে, ট্রেস করা বন্ধ করুন সেশন বিকল্পে ক্লিক করুন।
9. বাঁদিকের মেনুতে ক্যাপচার করা অনুরোধ/উত্তর ট্রানজ্যাকশনের একটি তালিকা দেখানো হয়। বিস্তারিত ফলাফল দেখতে, যেকোনও একটি ট্রানজ্যাকশনে ক্লিক করুন।

ট্রেস কীভাবে পড়তে হয়

ট্রেস টুলের দুটি প্রধান অংশ রয়েছে, ট্রানজ্যাকশন ম্যাপ ও ফেজ সংক্রান্ত বিবরণ:

• API প্রক্সি ট্রানজ্যাকশনের সময় হওয়া প্রতিটি উল্লেখযোগ্য ধাপ চিহ্নিত করতে ট্রানজ্যাকশন ম্যাপ আইকন ব্যবহার করে, এর মধ্যে নীতি প্রয়োগ, শর্তসাপেক্ষ ধাপ ও ট্রানজিশন অন্তর্ভুক্ত। সারসংক্ষেপ তথ্য দেখতে, যেকোনও আইকনের উপরে মাউস নিয়ে যান। ট্রানজ্যাকশন ম্যাপের উপরের দিকে অনুরোধ ফ্লোয়ের ধাপগুলি এবং নিচের দিকে উত্তর ফ্লোয়ের ধাপগুলি দেখানো হয়।
• টুলের ফেজ বিবরণ বিভাগে প্রক্সি ইন্টার্নাল প্রসেসিং সংক্রান্ত তথ্য, সেট বা রিড করা ভেরিয়েবল, অনুরোধ ও উত্তরের হেডার এবং আরও অনেক কিছু তালিকাভুক্ত করা হয়। কোনও আইকনে ক্লিক করে সেই ধাপের ফেজ সংক্রান্ত বিবরণ দেখুন।

এখানে প্রধান প্রক্সি প্রসেসিং সেগমেন্ট লেবেল করা সহ একটি স্যাম্পেল ট্রেস টুল ম্যাপ দেওয়া হল:

ট্রেস টুলের ট্রানজ্যাকশন ম্যাপ

ট্রানজ্যাকশন ম্যাপ লিজেন্ড

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

ট্রানজ্যাকশন ম্যাপ আইকন

	API প্রক্সির ProxyEndpoint-এ অনুরোধ পাঠানো ক্লায়েন্ট অ্যাপ।
	প্রক্সি ফ্লোতে বৃত্তগুলি ট্রানজিশনাল এন্ডপয়েন্ট চিহ্নিত করে। ক্লায়েন্টের থেকে কোনও অনুরোধ এলে, টার্গেটে অনুরোধ গেলে, টার্গেট থেকে উত্তর ফিরে এলে এবং ক্লায়েন্টকে উত্তর পাঠানো হলে, এগুলি সবকটিই সেখানে থাকে।
	লম্বা বারগুলি API প্রক্সি ফ্লোতে ফ্লো সেগমেন্টের শুরু নির্দেশ করে। ফ্লো সেগমেন্টগুলি হল: ProxyEndpoint অনুরোধ, TargetEndpoint অনুরোধ, TargetEndpoint উত্তর এবং ProxyEndpoint উত্তর। একটি সেগমেন্টে PreFlow, Conditional Flows এবং PostFlow অন্তর্ভুক্ত থাকে। আরও তথ্যের জন্য ফ্লো কনফিগার করা দেখুন।
	এর থেকে বোঝা যায় যে ব্যাকগ্রাউন্ডে Analytics অ্যাকশন হয়েছে।
	সত্য হিসেবে মূল্যায়ন করা হয় এমন কন্ডিশনাল ফ্লো। কনডিশনাল ফ্লো সম্পর্কে প্রাথমিক ধারণা পেতে, ফ্লো কনফিগার করা দেখুন। মনে রাখবেন, কিছু শর্ত Edge-জেনারেটেড। যেমন, Edge নিম্নলিখিত এক্সপ্রেশন ব্যবহার করে চেক করে যে ProxyEndpoint-এ কোনও সমস্যা হয়েছে কিনা: ((error.state equals PROXY_REQ_FLOW) or (error.state equals PROXY_RESP_FLOW))
	মিথ্যা হিসেবে মূল্যায়ন করা হয় এমন কন্ডিশনাল ফ্লো। শর্তসাপেক্ষ ফ্লো সম্পর্কে জানতে, ফ্লো কনফিগার করা দেখুন। মনে রাখবেন, কিছু শর্ত Edge-জেনারেটেড। যেমন, Edge নিম্নলিখিত এক্সপ্রেশন ব্যবহার করে চেক করে যে TargetEndpoint-এ কোনও সমস্যা হয়েছে কিনা: (((error.state equals TARGET_REQ_FLOW) or (error.state equals TARGET_RESP_FLOW)) or ((error.state equals REQ_SENT) or (error.state equals RESP_START)))
	নীতি। প্রতিটি ধরনের নীতির জন্য অনন্য আইকন রয়েছে। এটি AssignMessage নীতির জন্য। এইসব আইকন থেকে আপনি জানতে পারবেন যে কোথায় নীতিগুলি সঠিক ক্রমে প্রয়োগ করা হয়েছে এবং সেগুলি সফল হয়েছে কিনা। কোনও নীতির প্রয়োগের ফলাফল এবং সেগুলি প্রত্যাশিত কিনা তা দেখতে, আপনি নীতি আইকনে ক্লিক করতে পারেন। যেমন, মেসেজটি সঠিকভাবে ট্রান্সফর্ম করা হয়েছে কিনা অথবা এটি ক্যাশে করা হচ্ছে কিনা তা আপনি দেখতে পাবেন। নীতি সঠিকভাবে প্রয়োগ করা হয়েছে কিনা তা টিকচিহ্ন দিয়ে স্পষ্টভাবে দেখানো হয়। কোনও সমস্যা হলে, আইকনে লাল রঙের বিস্ময়সূচক চিহ্ন দেখানো হয়। পরামর্শ: কোনও নীতি প্রত্যাশিত সময়ের চেয়ে বেশি সময় নিচ্ছে কিনা তা দেখতে টুলটিপ বা টাইমলাইন ভাল করে দেখুন।
	ব্যাকএন্ড টার্গেট Node.js অ্যাপ্লিকেশন হলে এটি দেখা যায়। Apigee Edge-এ Node.js-এর ওভারভিউ দেখুন।
	API প্রক্সি দ্বারা কল করা ব্যাকএন্ড টার্গেট।
	প্রসেসিং সম্পূর্ণ হতে কতক্ষণ (মিলিসেকেন্ডে) সময় লেগেছে তা টাইম লাইন থেকে বোঝা যায়। অতিক্রান্ত সময়ের সেগমেন্ট তুলনা করলে, যেসব নীতি এক্সিকিউট করতে সবচেয়ে বেশি সময় লাগছে এবং যেগুলি আপনার API কলকে ধীর করে দিচ্ছে, সেগুলি আলাদা করতে পারবেন।
	Epsilon, মিলিসেকেন্ডের চেয়েও কম সময়সীমা নির্দেশ করে।
	বন্ধ আছে। কোনও নীতি বন্ধ করা হলে, নীতি আইকনে এটি দেখা যায়। পাবলিক API-এর মাধ্যমে কোনও নীতি বন্ধ করা যেতে পারে। API প্রক্সি কনফিগারেশন রেফারেন্স দেখুন।
	সমস্যা। নীতি সংক্রান্ত ধাপের কন্ডিশন মিথ্যা হলে (দেখুন ফ্লো ভেরিয়েবল ও কন্ডিশন), অথবা RaiseFault নীতি কার্যকর হলে RaiseFault নীতি আইকনে দেখানো হয়।
	এড়িয়ে যাওয়া হয়েছে। নীতি আইকনে দেখানো হয় যখন নীতিটি প্রয়োগ করা হয়নি কারণ ধাপের কন্ডিশন মিথ্যা হিসেবে মূল্যায়ন করা হয়েছে। আরও তথ্যের জন্য ফ্লো ভেরিয়েবল ও কন্ডিশন দেখুন।

ফেজ সংক্রান্ত বিবরণ বোঝা

টুলের ফেজ সংক্রান্ত বিবরণ অংশটি আপনাকে প্রতিটি প্রসেসিং ধাপে আপনার প্রক্সির অবস্থা সম্পর্কে অনেক কিছু বলে। ফেজ সংক্রান্ত বিবরণে দেওয়া কিছু তথ্য এখানে দেওয়া হল। বেছে নেওয়া ধাপের বিবরণ দেখতে, ট্রেস টুলের যেকোনও আইকনে ক্লিক করুন অথবা একটি ধাপ থেকে অন্য ধাপে যেতে, পরবর্তী/আগের বোতাম ব্যবহার করুন।

ফিল্টার ব্যবহার করে মেসেজ ক্যাপচার রিফাইন করা

আপনি হেডার এবং/অথবা কোয়েরি প্যারামিটার ভ্যালু নির্দিষ্ট করে, কোন অনুরোধগুলি ট্রেস টুলে দেখানো হবে তা ফিল্টার করতে পারবেন। সমস্যা সৃষ্টি করতে পারে এমন নির্দিষ্ট কল টার্গেট করার জন্য ফিল্টার আপনাকে সাহায্য করে। যেমন, আপনাকে নির্দিষ্ট কন্টেন্ট সহ অনুরোধ বা নির্দিষ্ট পার্টনার বা অ্যাপ থেকে আসা অনুরোধের উপর ফোকাস করতে হতে পারে। আপনি এগুলির উপর ভিত্তি করে ফিল্টার করতে পারবেন:

• HTTP হেডার - শুধুমাত্র নির্দিষ্ট হেডার থাকা কলের জন্য ট্রেস সীমিত করুন। এটি হল সমস্যার সমাধান করার একটি ভাল উপায়। আপনি অ্যাপ ডেভেলপারকে একটি হেডার পাঠাতে পারেন এবং যে কলের কারণে সমস্যা হচ্ছে তাতে এটি যোগ করতে বলতে পারেন। তারপরে Apigee Edge শুধুমাত্র সেই নির্দিষ্ট হেডার সহ কল রেকর্ড করবে যাতে আপনি ফলাফল পরীক্ষা করতে পারেন।
• কোয়েরি প্যারামিটার - শুধুমাত্র প্যারামিটারের নির্দিষ্ট ভ্যালু সহ কল রেকর্ড করা হবে।

'ফিল্টার' ফিচার সম্পর্কে যা জানা প্রয়োজন

• ফিল্টার ফিল্ডে ফিল্টার প্যারামিটার নির্দিষ্ট করার পরে আপনাকে অবশ্যই Trace সেশন আবার চালু করতে হবে।
• ফিল্টার প্যারামিটারগুলি একসাথে AND করা হয়। সফলভাবে ম্যাচ করার জন্য উল্লেখ করা সব কোয়েরি এবং/অথবা হেডার নাম/ভ্যালু পেয়ার অনুরোধে থাকতে হবে।
• ফিল্টার টুলে প্যাটার্ন ম্যাচিং কাজ করে না।
• ফিল্টার প্যারামিটার ও ভ্যালু ছোট ও বড় হাতের অক্ষরের মধ্যে পার্থক্য করে।

কীভাবে ট্রেস ফিল্টার তৈরি করবেন

1. কোনও ট্রেস সেশন চালু থাকলে, ট্রেস সেশন বন্ধ করুন বিকল্পে ক্লিক করে সেটি বন্ধ করুন।
2. Trace টুলের উপরের বাঁদিকের কোণে ফিল্টার বিকল্পে ক্লিক করে ফিল্টার ফিল্ডটি বড় করুন।
   
   
   
3. ফিল্টার ফিল্ডে, আপনি যে কোয়েরি প্যারামিটার এবং/অথবা হেডার ভ্যালু ফিল্টার করতে চান তা নির্দিষ্ট করুন । এই উদাহরণে, আমরা ফিল্টার করার জন্য দুটি কোয়েরি প্যারামিটার নির্দিষ্ট করেছি। সঠিকভাবে ম্যাচ করার জন্য দুটি প্যারামিটারকেই অনুরোধে থাকতে হবে।
   
   
   
4. ট্রেস সেশন শুরু করুন।
5. আপনার API কল করুন। শুধুমাত্র সেইসব অনুরোধ সফলভাবে ম্যাচ করে যেগুলিতে উল্লেখ করা সবকটি হেডার এবং/অথবা কোয়েরি প্যারামিটার থাকে।

উপরের উদাহরণে, এই API কলটি Trace-এ দেখা যাবে:

http://docs-test.apigee.net/cats?name=Penny&breed=Calico

কিন্তু এর ফলে এগুলি হবে না:

http://docs-test.apigee.net/cats?name=Penny

Trace-এর মাধ্যমে ডিবাগ করা

Trace আপনাকে API প্রক্সি সম্পর্কে অনেক ইন্টার্নাল বিবরণ দেখতে দেয়। যেমন:

• কোন নীতি সঠিকভাবে প্রয়োগ করা হচ্ছে বা প্রয়োগ করা যাচ্ছে না তা আপনি এক নজরে দেখতে পাবেন।
• ধরা যাক, আপনি কোনও একটি Analytics ড্যাশবোর্ডের মাধ্যমে লক্ষ্য করেছেন যে আপনার কোনও একটি API-এর পারফর্ম্যান্স অস্বাভাবিকভাবে কমে গেছে। এখন, কোথায় সমস্যা হচ্ছে তা শনাক্ত করতে আপনি Trace ব্যবহার করতে পারবেন। ট্রেস, প্রতিটি প্রসেসিং ধাপ সম্পূর্ণ করতে কত সময় লাগে তা মিলিসেকেন্ডে দেখায়। আপনি যদি দেখেন যে কোনও একটি ধাপ সম্পূর্ণ করতে অনেক বেশি সময় লাগছে, তাহলে আপনি সংশোধনী ব্যবস্থা নিতে পারেন।
• ফেজের বিবরণ দেখে, আপনি ব্যাকএন্ডে পাঠানো হেডার চেক করতে পারবেন, নীতি দ্বারা সেট করা ভেরিয়েবল দেখতে পারবেন এবং আরও অনেক কিছু।
• বেস পাথ যাচাই করার মাধ্যমে, আপনি নিশ্চিত করতে পারবেন যে কোনও নীতি মেসেজকে সঠিক সার্ভারে রাউট করছে।

দেখার বিকল্প বেছে নেওয়া

ট্রেস সেশনের জন্য ভিউ বিকল্প বেছে নিন।

ট্রেস ফলাফল ডাউনলোড করা

আপনি টেক্সট এডিটরে অফলাইনে দেখার ও সার্চ করার জন্য কাঁচা ট্রেস ফলাফলের একটি XML ফাইল ডাউনলোড করতে পারবেন। ফাইলটি শোনার সেশনের সম্পূর্ণ বিবরণ দেখায়, যার মধ্যে সব হেডার, ভেরিয়েবল ও নীতি অন্তর্ভুক্ত।

ডাউনলোড করতে, ট্রেস সেশন ডাউনলোড করুন বিকল্পে ক্লিক করুন।

curl হিসেবে অনুরোধ দেখানো

টার্গেট সার্ভারে করা API কল ট্রেস করার পরে, আপনি curl কমান্ড হিসেবে অনুরোধ দেখতে পারবেন। কয়েকটি কারণে এটি ডিবাগিংয়ের জন্য বিশেষভাবে উপযোগী:

• API প্রক্সি অনুরোধ পরিবর্তন করতে পারে, তাই প্রক্সি থেকে টার্গেট সার্ভারে পাঠানো অনুরোধ মূল অনুরোধের থেকে কতটা আলাদা তা দেখা দরকার। curl কমান্ডটি পরিবর্তিত অনুরোধকে উপস্থাপন করে।
• আরও বড় মেসেজ পেলোডের জন্য, curl আপনাকে HTTP হেডার এবং মেসেজ কন্টেন্ট একটি জায়গাতেই দেখতে দেয়। (বর্তমানে প্রায় ১,০০০ অক্ষরের সীমা আছে। এই সীমা অতিক্রম করার ব্যাপারে পরামর্শ পেতে, এই কমিউনিটি পোস্ট দেখুন।)

নিরাপত্তার জন্য, curl ফিচার HTTP অনুমোদন হেডার মাস্ক করে।

Trace-এ API কল আসার পরে curl হিসেবে অনুরোধ দেখতে, Transaction Map ডায়াগ্রামে "টার্গেট সার্ভারে পাঠানো অনুরোধ" স্টেজ বেছে নিন, তারপর Phase Details প্যানেলে "টার্গেট সার্ভারে পাঠানো অনুরোধ" কলামে curl দেখুন বোতামে ক্লিক করুন।

Apigee সহায়তা টিমের Trace ব্যবহার

ডিফল্টরূপে, Apigee Edge Apigee Support কে আপনার API প্রক্সিতে ট্রেস টুল ব্যবহার করতে সহায়তা প্রদানের অনুমতি দেয়। আপনি যেকোনো সময় এই বিকল্পটি অক্ষম করতে পারেন। যাইহোক, এই বিকল্পটি নিষ্ক্রিয় করলে Apigee সাপোর্টের আপনাকে সহায়তা প্রদানের ক্ষমতা সীমিত হতে পারে।

ট্রেস টুল ব্যবহার করে Apigee সমর্থন নিষ্ক্রিয় করতে:

1. https://apigee.com/edge- এ সাইন ইন করুন।
2. বাম নেভিগেশন বারে অ্যাডমিন > গোপনীয়তা এবং নিরাপত্তা নির্বাচন করুন।
3. Apigee Support দ্বারা ট্রেস টুলের ব্যবহার নিষ্ক্রিয় করতে Apigee Support to Trace টগল সক্ষম করুন ক্লিক করুন।