MessageLogging नीति

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

क्या

मैसेज को लॉग करना, एपीआई रनटाइम एनवायरमेंट में समस्याओं को ट्रैक करने का सबसे अच्छा तरीका है. अपने एपीआई पर MessageLogging नीति को अटैच और कॉन्फ़िगर किया जा सकता है, ताकि कस्टम मैसेज को किसी लोकल डिस्क (सिर्फ़ निजी क्लाउड के लिए Edge) या सिग्नल प्रोसेसिंग सिस्टम (एसआईएसएल) में लॉग किया जा सके.

सैंपल

<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 नीति के टाइप को कॉन्फ़िगर करने के लिए, इन एलिमेंट का इस्तेमाल करें.

<FileName>/opt/apigee/var/log/messages/mylog.log</FileName>

<FileName>mylog.log</FileName>

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

स्कीमा

इस्तेमाल से जुड़ी जानकारी

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

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

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

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

नीचे दी गई ट्रैक इमेज में, DefaultFaultRule लागू होने के बाद, PostClientFlow के हिस्से के तौर पर MessageLogging नीति लागू होने की जानकारी दी गई है:

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

यहां ProxyEndpoint की परिभाषा दी गई है, जिसमें PostClientFlow शामिल है:

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

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

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

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

Log message size exceeded. Increase the max message size setting

अगर आपको Edge for 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 और उसके बाद के वर्शन के लिए, /opt/apigee/customer/application/message-processor.properties फ़ाइल में conf/message-logging.properties+max. log.message.size.in.kb प्रॉपर्टी सेट करें और मैसेज प्रोसेसर को फिर से शुरू करें. कृपया ध्यान दें कि इस प्रॉपर्टी को शुरुआत में डिफ़ॉल्ट रूप से हटा दिया जाता है.

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

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

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

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

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

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

उस फ़ॉर्मैट को कंट्रोल करने के लिए, Edge Message Processor पर 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 Message Processor को रीस्टार्ट करें:
   > /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

Edge for Private Cloud में फ़ाइल की जगह को लॉग करना

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

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

Edge for Private Cloud 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 पर प्राथमिकता दी जाती है.

अगर आपको लॉग फ़ाइलों को फ़्लैट फ़ाइल स्ट्रक्चर में सेव करना है, ताकि सभी लॉग फ़ाइलें एक ही डायरेक्ट्री में सेव की जा सकें, तो मैसेज प्रोसेसर पर message-logging.properties फ़ाइल में enable.flat.directory.structure property को 'सही' पर सेट करें. मैसेज, ऊपर दी गई प्रॉपर्टी से तय की गई डायरेक्ट्री में सेव किए जाते हैं. साथ ही, फ़ाइल के नाम {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-which-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 का इस्तेमाल करते समय, <Syslog> एलिमेंट के चाइल्ड के तौर पर, <FormatMessage>true</FormatMessage> को नीति में शामिल करना ज़रूरी है.
  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

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

• Edge से एक्सपोज़ किए गए वैरिएबल: वैरिएबल का रेफ़रंस