মেসেজলগিং নীতি

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

কি

API রানটাইম পরিবেশে সমস্যাগুলি ট্র্যাক করার সেরা উপায়গুলির মধ্যে একটি হল বার্তাগুলি লগ করা। আপনি স্থানীয় ডিস্কে (শুধুমাত্র ব্যক্তিগত ক্লাউডের জন্য প্রান্ত) বা syslog-এ কাস্টম বার্তা লগ করার জন্য আপনার API-এ একটি MessageLogging নীতি সংযুক্ত এবং কনফিগার করতে পারেন।

নমুনা

<MessageLogging name="LogToSyslog">
  <Syslog>
    <Message>[3f509b58 tag="{organization.name}.{apiproxy.name}.{environment.name}"] Weather request for WOEID {request.queryparam.w}.</Message>
    <Host>logs-01.loggly.com</Host>
    <Port>514</Port>
    <Protocol>TCP</Protocol>
    <FormatMessage>true</FormatMessage>
    <DateFormat>yyyy-MM-dd'T'HH:mm:ss.SSSZ</DateFormat>
  </Syslog>
  <logLevel>ALERT</logLevel>
</MessageLogging>

<MessageLogging name="LogToSyslog">
  <Syslog>
    <Message>[3f509b58 tag="{organization.name}.{apiproxy.name}.{environment.name}"] Weather request for WOEID {request.queryparam.w}.</Message>
    <Host>logs-01.loggly.com</Host>
    <Port>6514</Port>
    <Protocol>TCP</Protocol>
    <FormatMessage>true</FormatMessage>
    <SSLInfo>
        <Enabled>true</Enabled>
    </SSLInfo>
    <DateFormat>yyMMdd-HH:mm:ss.SSS</DateFormat>
  </Syslog>
  <logLevel>WARN</logLevel>
</MessageLogging>

<MessageLogging name="LogPolicy">
  <File>
    <Message>This is a test message. Message id : {request.header.messageid}</Message>
      <FileName>test.log</FileName>
      <FileRotationOptions rotateFileOnStartup="true">
        <FileRotationType>SIZE</FileRotationType>
        <MaxFileSizeInMB>10</MaxFileSizeInMB>
        <MaxFilesToRetain>10</MaxFilesToRetain>
      </FileRotationOptions>
  </File>
  <logLevel>ERROR</logLevel>
</MessageLogging>

<MessageLogging name="LogPolicy">
  <File>
    <Message>This is a test message. Message id : {request.header.messageid}</Message>
    <FileName>test.log</FileName>
    <FileRotationOptions rotateFileOnStartup="true">
      <FileRotationType>TIME</FileRotationType>
      <RotationFrequency unit="minute">10</RotationFrequency>
      <MaxFilesToRetain>10</MaxFilesToRetain>
    </FileRotationOptions>
  </File>
  <logLevel>ERROR</logLevel>
</MessageLogging>

<MessageLogging name="LogPolicy">
  <File>
    <Message>This is a test message. Message id : {request.header.messageid}</Message>
    <FileName>test.log</FileName>
    <FileRotationOptions rotateFileOnStartup="true">
      <FileRotationType>TIME_SIZE</FileRotationType>
      <MaxFileSizeInMB>10</MaxFileSizeInMB>
      <MaxFilesToRetain>10</MaxFilesToRetain>
      <RotationFrequency unit="minute">10</RotationFrequency>
    </FileRotationOptions>
  </File>
  <logLevel>ERROR</logLevel>
</MessageLogging>

<MessageLogging name="LogPolicy">
  <File>
  ....
  ....
  </File>
  <BufferMessage>true</BufferMessage>
</MessageLogging>

উপাদান রেফারেন্স

MessageLogging নীতির ধরন কনফিগার করতে নিম্নলিখিত উপাদানগুলি ব্যবহার করুন।

<SSLInfo>
    <Enabled>true</Enabled>
</SSLInfo>

স্কিমাস

ব্যবহারের নোট

একটি API প্রক্সি ফ্লোতে একটি MessageLogging নীতি সংযুক্ত করার সময়, এটিকে প্রক্সিএন্ডপয়েন্ট প্রতিক্রিয়াতে পোস্টক্লায়েন্টফ্লো নামে একটি বিশেষ প্রবাহে রাখার কথা বিবেচনা করুন৷ অনুরোধকারী ক্লায়েন্টের কাছে প্রতিক্রিয়া পাঠানোর পরে পোস্টক্লায়েন্টফ্লো কার্যকর করে, যা নিশ্চিত করে যে সমস্ত মেট্রিক্স লগিংয়ের জন্য উপলব্ধ। PostClientFlow ব্যবহার করার বিস্তারিত জানার জন্য, API প্রক্সি কনফিগারেশন রেফারেন্স দেখুন।

পোস্টক্লায়েন্টফ্লো দুটি উপায়ে বিশেষ:

1. এটি শুধুমাত্র প্রতিক্রিয়া প্রবাহের অংশ হিসাবে কার্যকর করা হয়েছে।
2. প্রক্সি ত্রুটির অবস্থায় প্রবেশ করার পর এটিই একমাত্র প্রবাহ।

প্রক্সি সফল হোক বা ব্যর্থ হোক না কেন এটি কার্যকর করা হয়েছে, আপনি PostClientFlow-এ MessageLogging নীতিগুলি রাখতে পারেন এবং নিশ্চিত হতে পারেন যে তারা সর্বদা কার্যকর করবে৷

নিম্নোক্ত ট্রেস চিত্রটি ডিফল্টফল্ট রুল কার্যকর হওয়ার পরে পোস্টক্লায়েন্টফ্লো-এর অংশ হিসাবে একটি মেসেজলগিং নীতি কার্যকর করা দেখায়:

এই উদাহরণে, ভেরিফাই এপিআই কী নীতি একটি অবৈধ কী-এর কারণে ত্রুটি সৃষ্টি করেছে।

নীচে প্রক্সিএন্ডপয়েন্ট সংজ্ঞা দেখানো হয়েছে যা পোস্টক্লায়েন্টফ্লো অন্তর্ভুক্ত করে:

<ProxyEndpoint name="default">
  ...
  <PostClientFlow>
    <Response>
      <Step>
        <Name>Message-Logging-1</Name>
      </Step>
    </Response>
  </PostClientFlow>
  ...
</ProxyEndpoint>

এজ বার্তাগুলিকে সাধারণ পাঠ্য হিসাবে লগ করে, এবং আপনি ভেরিয়েবলগুলি অন্তর্ভুক্ত করার জন্য লগিং কনফিগার করতে পারেন, যেমন অনুরোধ বা প্রতিক্রিয়া প্রাপ্ত হওয়ার তারিখ এবং সময়, অনুরোধে ব্যবহারকারীর পরিচয়, উৎস আইপি ঠিকানা যেখান থেকে অনুরোধ পাঠানো হয়েছিল এবং তাই অন এজ লগ মেসেজ অ্যাসিঙ্ক্রোনাস করে, অর্থাৎ কলআউট ব্লক করার কারণে হতে পারে এমন কোনো লেটেন্সি আপনার এপিআই-তে প্রবর্তন করা হয়নি।

মেসেজলগিং নীতি একটি বাফারে মেমরিতে লগ করা বার্তা লেখে। বার্তা লগার বাফার থেকে বার্তা পড়ে এবং তারপর আপনার কনফিগার করা গন্তব্যে লেখে। প্রতিটি গন্তব্যের নিজস্ব বাফার আছে।

বাফারে লেখার হার যদি পড়ার হারের চেয়ে বেড়ে যায়, বাফার ওভারফ্লো হয় এবং লগিং ব্যর্থ হবে। যদি এটি ঘটে, আপনি লগ ফাইলে নিম্নলিখিত সম্বলিত একটি বার্তা খুঁজে পেতে পারেন:

Log message size exceeded. Increase the max message size setting

আপনি যদি প্রাইভেট ক্লাউড 4.15.07 এবং তার আগের এজ-এ এই সমস্যার সম্মুখীন হন, তাহলে message-logging.properties ফাইলটি সনাক্ত করুন এবং এই সমাধানটি ব্যবহার করুন:

message-logging.properties ফাইলে max.log.message.size.in.kb প্রপার্টি (ডিফল্ট মান = 128 KB) বাড়ান।

এজ ফর প্রাইভেট ক্লাউড 4.16.01 এবং পরবর্তীতে, conf/message-logging.properties+max. log.message.size.in.kb /opt/apigee/customer/application/message-processor.properties ফাইলে conf/message-logging.properties+max. log.message.size.in.kb প্রপার্টি এবং মেসেজ প্রসেসর রিস্টার্ট করুন। দয়া করে মনে রাখবেন যে এই সম্পত্তিটি প্রাথমিকভাবে ডিফল্টরূপে মন্তব্য করা হয়।

দ্রষ্টব্য: Edge এ প্রতিক্রিয়া বার্তা ভেরিয়েবল ত্রুটি ফ্লো থেকে পাওয়া যায় না। এই ভেরিয়েবলগুলি PostClientFlow-এও উপলভ্য নয় যদি পূর্ববর্তী প্রবাহটি ত্রুটি ফ্লো হয়। আপনি PostClientFlow থেকে প্রতিক্রিয়া তথ্য লগ করতে চান, বার্তা বস্তু ব্যবহার করুন. আপনি এই বস্তুটি ব্যবহার করে হেডার এবং প্রতিক্রিয়া থেকে অন্যান্য তথ্য পেতে পারেন যে কোনও ত্রুটি ছিল কিনা। আরও তথ্য এবং একটি উদাহরণের জন্য বার্তা ভেরিয়েবল দেখুন।

ব্যক্তিগত ক্লাউডের জন্য এজে লগ মেসেজ টাইমস্ট্যাম্প নিয়ন্ত্রণ করা

ডিফল্টরূপে, সমস্ত লগ বার্তার টাইমস্ট্যাম্পের বিন্যাস থাকে:

yyyy-MM-dd'T'HH:mm:ss.SSSZ

DateFormat উপাদান ব্যবহার করে syslog গন্তব্যগুলির জন্য এই সিস্টেম-ব্যাপী ডিফল্টটি ওভাররাইড করা যেতে পারে। জাভা এর SimpleDateFormat ক্লাসের ডকুমেন্টেশনে এই টেমপ্লেটটির আচরণ বর্ণনা করা হয়েছে। সেই সংজ্ঞা অনুসারে, yyyy 4-সংখ্যার বছর দিয়ে প্রতিস্থাপিত করা হবে, MM 2-অঙ্কের মাসের সংখ্যা দিয়ে প্রতিস্থাপিত করা হবে, ইত্যাদি। উপরের বিন্যাসের ফলে এই ফর্মের একটি স্ট্রিং হতে পারে:

2022-09-28T22:38:11.721+0000

আপনি যে বিন্যাস নিয়ন্ত্রণ করতে এজ মেসেজ প্রসেসরে conf_system_apigee.syslogger.dateFormat বৈশিষ্ট্য ব্যবহার করতে পারেন। উদাহরণস্বরূপ, বার্তা বিন্যাস এতে পরিবর্তন করুন:

yy/MM/dd'T'HH:mm:ss.SSSZ

..ড্যাশগুলিকে স্ল্যাশ দিয়ে প্রতিস্থাপন করা, এবং একটি 2-সংখ্যার বছরে সংক্ষিপ্ত করা, ফর্মটিতে একটি টাইমস্ট্যাম্প রেকর্ড করে:

22/09/28T22:38:11.721+0000

বিন্যাস পরিবর্তন করতে:

1. একটি এডিটরে message-processor.properties ফাইলটি খুলুন। ফাইলটি বিদ্যমান না থাকলে, এটি তৈরি করুন:
   > vi /opt/apigee/customer/application/message-processor.properties
2. পছন্দ অনুযায়ী বৈশিষ্ট্য সেট করুন:
   conf_system_apigee.syslogger.dateFormat=yy/MM/dd'T'HH:mm:ss.SSSZ
3. আপনার পরিবর্তন সংরক্ষণ করুন.
4. নিশ্চিত করুন যে বৈশিষ্ট্য ফাইলটি 'apigee' ব্যবহারকারীর মালিকানাধীন:
   > chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
5. এজ মেসেজ প্রসেসর রিস্টার্ট করুন:
   > /opt/apigee/apigee-service/bin/apigee-service edge-message-processor পুনরায় চালু করুন

ব্যক্তিগত ক্লাউডের জন্য এজে ফাইলের অবস্থান লগ করুন

প্রাইভেট ক্লাউড 4.16.01 এবং তার পরের জন্য এজ

ডিফল্টরূপে, ব্যক্তিগত ক্লাউড বার্তা লগগুলি বার্তা প্রসেসর নোডগুলিতে নিম্নলিখিত ডিরেক্টরিতে অবস্থিত:

/opt/apigee/var/log/edge-message-processor/messagelogging/org_name/environment/api_proxy_name/revision/logging_policy_name/

আপনি মেসেজ প্রসেসরে message-logging.properties ফাইলে বৈশিষ্ট্য পরিবর্তন করে ডিফল্ট লগ অবস্থান পরিবর্তন করতে পারেন:

• bin_setenv_data_dir - লগ ফাইল স্টোরেজের জন্য রুট পাথ সেট করে। উদাহরণস্বরূপ, bin_setenv_data_dir=/opt/apigee/var/log
• conf_message-logging_log.root.dir - যদি আপনি এটিকে একটি আপেক্ষিক পাথে সেট করেন, যেমন conf/message-logging.properties+log.root.dir=custom/folder/ , the path is appended to the bin_setenv_data_dir location.
  
  আপনি যদি এটিকে একটি পরম পথে সেট করেন, যেমন conf/message-logging.properties+log.root.dir=/opt/apigee/var/log/messages , বার্তা লগগুলি /opt/apigee/var/log/messages/messagelog/ এ সংরক্ষণ করা হবে /opt/apigee/var/log/messages/messagelog/ । একটি পরম পথ bin_setenv_data_dir এর চেয়ে অগ্রাধিকার নেয়।
  
  মনে রাখবেন যে আপনাকে সম্পত্তিটিকে conf/message-logging.properties+log.root.dir হিসাবে উল্লেখ করতে হবে কারণ এটি ডিফল্টরূপে মন্তব্য করা হয়। একটি টোকেন সেট করা দেখুন যা বর্তমানে আরো জন্য মন্তব্য করা হয়েছে ।

আপনি যদি লগ ফাইলগুলিকে একটি ফ্ল্যাট ফাইল কাঠামোতে সংরক্ষণ করতে চান যাতে সমস্ত লগ ফাইল একই ডিরেক্টরিতে রাখা হয়, তাহলে বার্তা-logging.properties-এ conf/message-logging.properties+enable.flat.directory.structure কে সত্য হিসাবে সেট করুন। ফাইল বার্তাগুলি উপরের বৈশিষ্ট্যগুলির দ্বারা নির্দিষ্ট করা ডিরেক্টরিতে সংরক্ষণ করা হয় এবং ফাইলের নামগুলি {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}_{filename} রূপ নেয়৷

এই বৈশিষ্ট্যগুলি সেট করতে:

1. একটি এডিটরে message-processor.properties ফাইলটি খুলুন। ফাইলটি বিদ্যমান না থাকলে, এটি তৈরি করুন:
   > vi /opt/apigee/customer/application/message-processor.properties
2. পছন্দ অনুযায়ী বৈশিষ্ট্য সেট করুন:
   conf/message-logging.properties+log.root.dir= /opt/apigee/var/log/messages
3. আপনার পরিবর্তন সংরক্ষণ করুন.
4. নিশ্চিত করুন যে বৈশিষ্ট্য ফাইলটি 'apigee' ব্যবহারকারীর মালিকানাধীন:
   > chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
5. এজ উপাদান পুনরায় চালু করুন:
   > /opt/apigee/apigee-service/bin/apigee-service edge-message-processor পুনরায় চালু করুন

প্রাইভেট ক্লাউড 4.15.07 এবং তার আগের জন্য এজ

ডিফল্টরূপে, বার্তা লগগুলি বার্তা প্রসেসরগুলিতে নিম্নলিখিত অবস্থানে অবস্থিত:

/opt/apigee4/var/log/apigee/message-processor/messagelog/{org}/{environment}/{api_proxy_name}/{revision}/{logging_policy_name}/

আপনি মেসেজ প্রসেসরে message-logging.properties ফাইলে নিম্নলিখিত বৈশিষ্ট্যগুলি পরিবর্তন করে ডিফল্ট লগ অবস্থান পরিবর্তন করতে পারেন:

• data.dir - লগ ফাইল স্টোরেজের জন্য রুট পাথ সেট করে। উদাহরণস্বরূপ, data.dir=/opt/apigee4/var/log
• log.root.dir - যদি আপনি এটিকে একটি আপেক্ষিক পাথে সেট করেন, যেমন log.root.dir=custom/folder/, পাথটি data.dir অবস্থানে যুক্ত করা হয়।

উদাহরণস্বরূপ, দুটি বৈশিষ্ট্যের সংমিশ্রণ /opt/apigee4/var/log/custom/folder/messagelog/ এ লগিং ডিরেক্টরি সেট করবে (মনে রাখবেন যে /messagelog স্বয়ংক্রিয়ভাবে যোগ করা হয়েছে)।

আপনি যদি এটিকে একটি পরম পথে সেট করেন, যেমন log.root.dir=/opt/apigee4/var/log/messages , বার্তা লগগুলি /opt/apigee4/var/log/messages/messagelog/-এ সংরক্ষণ করা হবে। log.root.dir-এ একটি নিখুঁত পথ data.dir এর চেয়ে অগ্রাধিকার নেয়।

আপনি যদি লগ ফাইলগুলিকে একটি ফ্ল্যাট ফাইল কাঠামোতে সংরক্ষণ করতে চান যাতে সমস্ত লগ ফাইল একই ডিরেক্টরিতে রাখা হয়, বার্তা প্রসেসরের মেসেজ-logging.properties ফাইলে enable.flat.directory.structure প্রপার্টিটিকে সত্য হিসাবে সেট করুন। বার্তাগুলি উপরের বৈশিষ্ট্যগুলির দ্বারা নির্দিষ্ট করা ডিরেক্টরিতে সংরক্ষণ করা হয় এবং ফাইলের নামগুলি {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}{filename}} রূপ নেয়৷

বার্তা টেমপ্লেটে ভেরিয়েবলের জন্য ডিফল্ট মান

বার্তা টেমপ্লেটে প্রতিটি ভেরিয়েবলের জন্য ডিফল্ট মান আলাদাভাবে নির্দিষ্ট করা যেতে পারে। উদাহরণস্বরূপ, যদি ভেরিয়েবল request.header.id সমাধান করা না যায়, তাহলে এর মান unknown মান দিয়ে প্রতিস্থাপিত হয়।

<Message>This is a test message. id = {request.header.id:unknown}</Message>

Message এলিমেন্টে defaultVariableValue অ্যাট্রিবিউট সেট করে সব অমীমাংসিত ভেরিয়েবলের জন্য একটি সাধারণ ডিফল্ট মান নির্দিষ্ট করা যেতে পারে:

<Message defaultVariableValue="unknown">This is a test message. id = {request.header.id}</Message>

তৃতীয় পক্ষের লগ ম্যানেজমেন্ট পরিষেবাগুলি কনফিগার করা হচ্ছে

মেসেজলগিং নীতি আপনাকে থার্ড-পার্টি লগ ম্যানেজমেন্ট পরিষেবা, যেমন স্প্লঙ্ক, সুমো লজিক এবং লগলিতে সিসলগ বার্তা পাঠাতে দেয়। আপনি যদি এই পরিষেবাগুলির মধ্যে একটিতে syslog পাঠাতে চান, পরিষেবাটির হোস্ট, পোর্ট এবং প্রোটোকল কনফিগার করতে সেই পরিষেবাটির ডকুমেন্টেশন দেখুন, তারপর সেই অনুযায়ী এই নীতিতে Syslog উপাদান সেট করুন৷

তৃতীয় পক্ষের লগ ম্যানেজমেন্ট কনফিগারেশনের জন্য নিম্নলিখিত ডকুমেন্টেশন দেখুন:

• স্প্লঙ্ক (পণ্য সংস্করণ নির্বাচন করুন)
  এছাড়াও এই Apigee কমিউনিটি পোস্টটি দেখুন: https://community.apigee.com/content/kbentry/13298/log-messages-into-splunk.html
• সুমো লজিক
  • এছাড়াও এই Apigee কমিউনিটি পোস্টটি দেখুন: https://community.apigee.com/questions/5226/setting-up-logging-with-sumo-logic-which-host-shou.html
  • লগিং পরিষেবা হিসাবে সুমো লজিক ব্যবহার করার একটি সম্পূর্ণ উদাহরণের জন্য, নিম্নলিখিত Apigee কমিউনিটি পোস্টটি দেখুন। সমাধানটি সুমো লজিক HTTP উত্স সংগ্রাহকের কাছে HTTP POST অনুরোধ করতে একটি একক জাভাস্ক্রিপ্ট নীতি ব্যবহার করে: https://community.apigee.com/articles/32286/logging-to-sumo-logic-using-javascript-and-http.html
• লগে লগে
  Loggly ব্যবহার করার সময়, <FormatMessage>true</FormatMessage> <Syslog> উপাদানের চাইল্ড হিসাবে নীতিতে প্রয়োজন।
  এছাড়াও Loggly এ বার্তা লগিং সম্পর্কে আরও তথ্যের জন্য এই Apigee কমিউনিটি পোস্টটি দেখুন: https://community.apigee.com/content/kbentry/14798/log-messages-into-loggly.html

ত্রুটি উল্লেখ

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.messagelogging.StepDefinitionExecutionFailed"
      },
      "faultstring":"Execution failed"
   }
}

Example fault rule

<FaultRule name="MessageLogging">
    <Step>
        <Name>ML-LogMessages</Name>
        <Condition>(fault.name Matches "StepDefinitionExecutionFailed") </Condition>
    </Step>
    <Condition>(messagelogging.ML-LogMessages.failed = true) </Condition>
</FaultRule>

ফ্লো ভেরিয়েবল

নিম্নলিখিত ভেরিয়েবলগুলি পলিসি ব্যর্থতার উপর পূর্ণ হয়।

• messagelogging.failed
• messagelogging.{stepdefinition-name}.failed

সম্পর্কিত বিষয়

• এজ দ্বারা উদ্ভাসিত ভেরিয়েবল: ভেরিয়েবল রেফারেন্স