MessageLogging नीति

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी

यह क्या है

एपीआई रनटाइम एनवायरमेंट में समस्याओं को ट्रैक करने का सबसे अच्छा तरीका, मैसेज लॉग करना है. किसी लोकल डिस्क (सिर्फ़ निजी क्लाउड के लिए Edge) या syslog पर कस्टम मैसेज को लॉग करने के लिए, अपने एपीआई पर 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 नीति अटैच करते समय, इसे प्रॉक्सीEndpoint रिस्पॉन्स में PostClientFlow नाम के एक खास फ़्लो में रखने के बारे में सोचें. PostClientFlow, अनुरोध करने वाले क्लाइंट को जवाब भेजे जाने के बाद ही काम करता है, जिससे यह पक्का होता है कि लॉग करने के लिए सभी मेट्रिक उपलब्ध हैं. PostClientFlow का इस्तेमाल करने के बारे में जानकारी के लिए, एपीआई प्रॉक्सी कॉन्फ़िगरेशन रेफ़रंस देखें.

PostClientFlow दो तरह से खास है:

1. इसे सिर्फ़ रिस्पॉन्स फ़्लो के हिस्से के तौर पर चलाया जाता है.
2. प्रॉक्सी के गड़बड़ी की स्थिति में आने के बाद, सिर्फ़ यही फ़्लो चलाया जाता है.

प्रॉक्सी की प्रोसेस पूरी हो गई है या नहीं हो पाई, लेकिन इसे एक्ज़ीक्यूट किया जाता है. इसलिए, MessageLogging नीतियों को PostClientFlow में शामिल किया जा सकता है. इनकी मदद से यह भी पक्का किया जा सकता है कि ये नीतियां हमेशा लागू होंगी.

नीचे दी गई ट्रेस इमेज, डिफ़ॉल्टFaultTerms के लागू होने के बाद, PostClientFlow के हिस्से के तौर पर, MessageLogging नीति को लागू करने की जानकारी दिखाती है:

इस उदाहरण में, 'एपीआई पासकोड की पुष्टि करें' नीति की वजह से, गलत कुंजी की वजह से गड़बड़ी हुई.

नीचे प्रॉक्सीEndpoint की परिभाषा दिखाई गई है, जिसमें PostClientFlow शामिल है:

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

Edge, मैसेज को आसान टेक्स्ट के तौर पर लॉग करता है. साथ ही, वैरिएबल को शामिल करने के लिए लॉगिंग को कॉन्फ़िगर किया जा सकता है. जैसे, अनुरोध या जवाब मिलने की तारीख और समय, अनुरोध पर उपयोगकर्ता की पहचान, सोर्स का वह आईपी पता जिससे अनुरोध भेजा गया था वगैरह. एसिंक्रोनस तरीके से एज लॉग मैसेज, इसका मतलब है कि आपके एपीआई में कॉल आउट को ब्लॉक करने की वजह से इंतज़ार के समय की कोई जानकारी नहीं दी जाती है.

MessageLogging नीति, मेमोरी में लॉग किए गए मैसेज को बफ़र में लिखती है. मैसेज लॉग करने वाला टूल, बफ़र के मैसेज पढ़ता है और उस डेस्टिनेशन पर लिखता है जिसे आपने कॉन्फ़िगर किया है. हर डेस्टिनेशन का अपना बफ़र होता है.

अगर बफ़र में लिखने की दर, रीड रेट से ज़्यादा हो जाती है, तो बफ़र ओवरफ़्लो होने और लॉग इन नहीं किया जा सकेगा. अगर ऐसा होता है, तो आपको लॉग फ़ाइल में यह मैसेज दिख सकता है:

Log message size exceeded. Increase the max message size setting

अगर आपको Private Cloud के 4.15.07 और इससे पहले के वर्शन में यह समस्या आती है, तो message-logging.properties फ़ाइल ढूंढें और इसका इस्तेमाल करें:

message-logging.properties फ़ाइल में, max.log.message.size.in.kb प्रॉपर्टी (डिफ़ॉल्ट वैल्यू = 128 केबी) को बढ़ाएं.

Edge for Private Cloud 4.16.01 और उसके बाद के वर्शन के लिए, conf_message-logging_max.log.message.size.in.kb प्रॉपर्टी को /opt/apigee/customer/application/message-processor.properties फ़ाइल में सेट करें. इसके बाद, Message प्रोसेसर को रीस्टार्ट करें.

ध्यान दें: Edge में, रिस्पॉन्स मैसेज के वैरिएबल एरर फ़्लो में उपलब्ध नहीं होते. अगर पिछला फ़्लो, 'गड़बड़ी का फ़्लो' था, तब भी ये वैरिएबल PostClientFlow में उपलब्ध नहीं हैं. अगर आपको PostClientFlow से रिस्पॉन्स की जानकारी लॉग करनी है, तो message ऑब्जेक्ट का इस्तेमाल करें. हेडर और दूसरी जानकारी पाने के लिए, इस ऑब्जेक्ट का इस्तेमाल किया जा सकता है. इससे कोई फ़र्क़ नहीं पड़ता कि कोई गड़बड़ी हुई है या नहीं. ज़्यादा जानकारी और उदाहरण के लिए, मैसेज वैरिएबल देखें.

Private Cloud के लिए, Edge में लॉग मैसेज के टाइमस्टैंप को कंट्रोल करना

डिफ़ॉल्ट रूप से, सभी लॉग मैसेज में टाइमस्टैंप का फ़ॉर्मैट यह होता है:

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

पूरे सिस्टम के इस डिफ़ॉल्ट डिफ़ॉल्ट फ़ंक्शन को DateFormat एलिमेंट का इस्तेमाल करके, syslog डेस्टिनेशन के लिए बदला जा सकता है. इस टेंप्लेट के काम करने के तरीके की जानकारी, Java की SimpleDateFormat क्लास के दस्तावेज़ में दी गई है. उस परिभाषा के मुताबिक, yyyy को चार अंकों वाले साल से बदल दिया जाएगा और MM को महीने के दो अंकों से बदल दिया जाएगा. इसी तरह आगे भी ऐसे ही होते रहेंगे. ऊपर दिए गए फ़ॉर्मैट की वजह से इस फ़ॉर्म में स्ट्रिंग दिख सकती है:

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

इस फ़ॉर्मैट को कंट्रोल करने के लिए, Edge Message प्रोसेसर में conf_system_apigee.syslogger.dateFormat प्रॉपर्टी का इस्तेमाल किया जा सकता है. उदाहरण के लिए, मैसेज के फ़ॉर्मैट को इसमें बदलना:

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

..डैश को स्लैश के साथ बदलकर और साल को दो अंकों में छोटा करने पर, यह फ़ॉर्म में टाइमस्टैंप रिकॉर्ड करता है:

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. Edge मैसेज प्रोसेसर को रीस्टार्ट करें:
   > /opt/apigee/apigee-service/bin/apigee-serviceedge-message-processor रीस्टार्ट

Private Cloud के लिए, Edge में फ़ाइल की जगह की जानकारी लॉग करें

Private Cloud 4.16.01 और उसके बाद के वर्शन के लिए Edge

डिफ़ॉल्ट रूप से, प्राइवेट क्लाउड मैसेज लॉग, मैसेज प्रोसेसर नोड पर इस डायरेक्ट्री में मौजूद होते हैं:

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

Messages प्रोसेसर पर मौजूद message-logging.property फ़ाइल में प्रॉपर्टी में बदलाव करके, लॉग की डिफ़ॉल्ट जगह को बदला जा सकता है:

• 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/ में सेव हो जाएंगे. ऐब्सलूट पाथ को bin_setenv_data_dir से ज़्यादा प्राथमिकता दी जाती है.
  
  ध्यान दें कि आपको इस प्रॉपर्टी को conf/message-logging.properties+log.root.dir के तौर पर रेफ़रंस देना होगा, क्योंकि इस पर डिफ़ॉल्ट रूप से टिप्पणी की गई है. ज़्यादा जानकारी के लिए, उस टोकन को सेट करना जिस पर अभी टिप्पणी की गई है देखें.

अगर आपको अपनी लॉग फ़ाइलों को किसी फ़्लैट फ़ाइल स्ट्रक्चर में सेव करना है, ताकि सभी लॉग फ़ाइलें एक ही डायरेक्ट्री में रखी जा सकें, तो message-logging.property फ़ाइल में 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. Edge कॉम्पोनेंट को रीस्टार्ट करें:
   > /opt/apigee/apigee-service/bin/apigee-serviceedge-message-प्रोसेसर रीस्टार्ट

Private Cloud 4.15.07 और इससे पहले के वर्शन के लिए एज

डिफ़ॉल्ट रूप से, मैसेज लॉग मैसेज प्रोसेसर पर नीचे दी गई जगह पर मौजूद होते हैं:

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

मैसेज प्रोसेसर पर, message-logging.property फ़ाइल में नीचे दी गई प्रॉपर्टी में बदलाव करके, लॉग की डिफ़ॉल्ट जगह को बदला जा सकता है:

• data.dir - लॉग फ़ाइल स्टोरेज का रूट पाथ सेट करता है. उदाहरण के लिए, data.direct=/opt/apigee4/var/log
• log.root.dir - अगर इसे किसी मिलते-जुलते पाथ पर सेट किया जाता है, जैसे कि Log.root.dr=custom/folder/, तो पाथ को data.direct की जगह पर जोड़ दिया जाता है.

उदाहरण के लिए, दो प्रॉपर्टी का कॉम्बिनेशन, लॉग इन डायरेक्ट्री को /opt/apigee4/var/log/custom/folder/messagelog/ पर सेट करेगा (ध्यान दें कि /messagelog अपने-आप जुड़ जाता है).

अगर इसे एक ऐब्सलूट पाथ पर सेट किया जाता है, जैसे कि log.root.dir=/opt/apigee4/var/log/messages, तो मैसेज लॉग /opt/apigee4/var/log/messages/messagelog/ में स्टोर किए जाएंगे. Log.root.der में, ऐब्सलूट पाथ को data.dir से ज़्यादा अहमियत दी जाती है.

अगर आपको लॉग फ़ाइलों को किसी फ़्लैट फ़ाइल स्ट्रक्चर में सेव करना है, ताकि सभी लॉग फ़ाइलें एक ही डायरेक्ट्री में रखी जा सकें, तो Message प्रोसेसर पर message-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>

तीसरे पक्ष के लॉग मैनेजमेंट की सेवाएं कॉन्फ़िगर करना

MessageLogging नीति की मदद से, आपको Splunk, Sumo Logic, और Loggly जैसी तीसरे पक्ष की लॉग मैनेजमेंट सेवाओं को सिस्लॉग मैसेज भेजने की सुविधा मिलती है. अगर आपको इनमें से किसी भी सेवा को syslog की सुविधा भेजनी है, तो उस सेवा के दस्तावेज़ को देखें, ताकि उस सेवा के होस्ट, पोर्ट, और प्रोटोकॉल को कॉन्फ़िगर किया जा सके. इसके बाद, इस नीति पर Syslog एलिमेंट को उसके मुताबिक सेट करें.

तीसरे पक्ष के लॉग मैनेजमेंट के कॉन्फ़िगरेशन के लिए, नीचे दिए गए दस्तावेज़ देखें:

• Splunk (प्रॉडक्ट वर्शन चुनें)
  यह Apigee कम्यूनिटी पोस्ट भी देखें: https://community.apigee.com/content/kbentry/13298/log-messages-into-splunk.html
• Sumo लॉजिक
  • यह Apigee कम्यूनिटी पोस्ट भी देखें: https://community.apigee.com/questions/5226/setting-up-logging-with-sumo-logic-using-host-shou.html
  • डेटा को लॉग करने वाली सेवा के तौर पर, Sumo Logic का इस्तेमाल करने के कुछ उदाहरण के लिए, Apigee की कम्यूनिटी पोस्ट देखें. यह समाधान, Sumo Logic एचटीटीपी सोर्स कलेक्टर को एचटीटीपी पोस्ट अनुरोध करने के लिए, एक JavaScript नीति का इस्तेमाल करता है: https://community.apigee.com/articles/32286/logging-to-sumo-logic-using-javascript-and-http.html
• Loggly
  Loggly का इस्तेमाल करते समय, नीति में <FormatMessage>true</FormatMessage> की ज़रूरत <Syslog> एलिमेंट के चाइल्ड के तौर पर होती है.
  Loggly में मैसेज लॉग करने के बारे में ज़्यादा जानकारी के लिए, यह Apigee कम्यूनिटी पोस्ट भी देखें: https://community.apigee.com/content/kbentry/14798/log-messages-into-loggly.html

गड़बड़ी का रेफ़रंस

यह सेक्शन गड़बड़ी के कोड और दिखाए गए गड़बड़ी के मैसेज के बारे में बताता है. साथ ही, इस नीति के ट्रिगर होने पर Edge की मदद से सेट की गई गड़बड़ी के वैरिएबल के बारे में बताता है. यह जानकारी जानना ज़रूरी है कि क्या गड़बड़ियों को ठीक करने के लिए, गड़बड़ी से जुड़े नियम बनाए जा रहे हैं. ज़्यादा जानने के लिए, नीति से जुड़ी गड़बड़ियों के बारे में आपके लिए ज़रूरी जानकारी और गड़बड़ियों को ठीक करने के तरीके देखें.

रनटाइम से जुड़ी गड़बड़ियां

नीति के लागू होने पर ये गड़बड़ियां हो सकती हैं.

डिप्लॉयमेंट से जुड़ी गड़बड़ियां

ये गड़बड़ियां तब हो सकती हैं, जब इस नीति वाले किसी प्रॉक्सी को डिप्लॉय किया जाता है.

गड़बड़ी वाले वैरिएबल

रनटाइम में कोई गड़बड़ी होने पर ये वैरिएबल सेट किए जाते हैं. ज़्यादा जानकारी के लिए, नीति से जुड़ी गड़बड़ियों के बारे में आपके लिए ज़रूरी जानकारी देखें.

गड़बड़ी के जवाब का उदाहरण

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

गड़बड़ी के नियम का उदाहरण

<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

मिलते-जुलते विषय

• एज के ज़रिए दिखाए गए वैरिएबल: वैरिएबल संदर्भ