Apigee Edge के दस्तावेज़ देखे जा रहे हैं.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
वर्शन 2.0.2
Cloud Logging के लॉग में एंट्री लिखें.
इस कॉन्टेंट में, इस एक्सटेंशन को कॉन्फ़िगर करने और इस्तेमाल करने के बारे में जानकारी दी गई है.
ज़रूरी शर्तें
एपीआई प्रॉक्सी से इस एक्सटेंशन का इस्तेमाल करने से पहले, आपको ये काम करने होंगे:
IAM में, प्रोजेक्ट के उस सदस्य को लॉगिंग > लॉग राइटर की भूमिका असाइन करें जो Cloud Logging सिस्टम में आपके एक्सटेंशन का प्रतिनिधित्व करेगा. भूमिकाएं असाइन करने के तरीके के बारे में जानने के लिए, किसी सेवा खाते को चुनिंदा संसाधनों के लिए भूमिकाएं असाइन करना लेख पढ़ें. लॉगिंग की भूमिकाओं के बारे में ज़्यादा जानने के लिए, ऐक्सेस कंट्रोल गाइड देखें.
Google Cloud Console का इस्तेमाल करके, सेवा खाते के लिए कुंजी जनरेट करें.
कॉन्फ़िगरेशन रेफ़रंस का इस्तेमाल करके एक्सटेंशन को जोड़ने और कॉन्फ़िगर करने के दौरान, जनरेट हुई कुंजी वाली JSON फ़ाइल के कॉन्टेंट का इस्तेमाल करें.
यह एक्सटेंशन, PostClientFlow में मौजूद ExtensionCallout नीति के ज़रिए कॉल किए जाने की सुविधा देता है.
अगर आपको PostClientFlow से इस एक्सटेंशन को कॉल करने के लिए, ExtensionCallout नीति का इस्तेमाल करना है, तो पक्का करें कि आपके संगठन में features.allowExtensionsInPostClientFlow फ़्लैग को true पर सेट किया गया हो.
अगर आप Apigee Edge for Public Cloud के ग्राहक हैं, तो आपको Apigee Edge की सहायता टीम से संपर्क करना होगा. इससे यह पक्का किया जा सकेगा कि आपके संगठन में
features.allowExtensionsInPostClientFlowफ़्लैग कोtrueपर सेट किया गया है.अगर आप Apigee Edge for Private Cloud के ग्राहक हैं, तो
features.allowExtensionsInPostClientFlowफ़्लैग कोtrueपर सेट करने के लिए, संगठन की प्रॉपर्टी अपडेट करें एपीआई का इस्तेमाल करें.
Cloud Logging के बारे में जानकारी
के नाम से जाना जाता हैCloud Logging, Google Cloud के कार्रवाइयों वाले सुइट का हिस्सा है. इसमें लॉग को सेव करने की सुविधा, लॉग एक्सप्लोरर नाम का यूज़र इंटरफ़ेस, और प्रोग्राम के हिसाब से लॉग मैनेज करने के लिए एपीआई शामिल है. Cloud Logging की मदद से, ये काम किए जा सकते हैं: लॉग एंट्री पढ़ना और लिखना, अपने लॉग खोजना और उन्हें फ़िल्टर करना, अपने लॉग एक्सपोर्ट करना, और लॉग पर आधारित मेट्रिक बनाना.
Cloud Logging एक्सटेंशन, लॉग में एंट्री लिखता है. ज़्यादा जानकारी के लिए, Cloud Logging के दस्तावेज़ देखें.
सैंपल
यहां दिए गए उदाहरणों में, ExtensionCallout नीति का इस्तेमाल करके, Cloud Logging एक्सटेंशन की कार्रवाइयों के लिए सहायता को कॉन्फ़िगर करने का तरीका बताया गया है.
ग्लोबल लॉग
नीचे दी गई नीति, Cloud Global संसाधन में example-log नाम के लॉग में This is a test मैसेज लिखती है. असल में, आपको मैसेज को किसी फ़्लो वैरिएबल में रखना होगा. इसकी वैल्यू, एपीआई प्रॉक्सी में कहीं और सेट की जाती है.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Logging-Extension">
<DisplayName>Logging Connector</DisplayName>
<Connector>cloud-extension-sample</Connector>
<Action>log</Action>
<Input><![CDATA[{
"logName": "example-log",
"metadata": {
"resource": {
"type": "global",
"labels": {
"project_id": "my-test"
}
}
},
"message": "This is a test."
}]]></Input>
</ConnectorCallout>
इस कॉन्टेंट में, इस एक्सटेंशन को कॉन्फ़िगर करने और इस्तेमाल करने के बारे में जानकारी दी गई है. Apigee कंसोल का इस्तेमाल करके एक्सटेंशन को कॉन्फ़िगर करने का तरीका जानने के लिए, एक्सटेंशन जोड़ना और उसे कॉन्फ़िगर करना लेख पढ़ें.
कार्रवाइयां
log
यह फ़ंक्शन, लॉग में कोई मैसेज लिखता है.
इस कार्रवाई से, Cloud Logging में लॉग एंट्री लिखी जाती है. लॉग एंट्री में मेटाडेटा और एंट्री डेटा शामिल होता है. लॉग एंट्री के बारे में ज़्यादा जानने के लिए, एंट्री का रेफ़रंस देखें.
metadata प्रॉपर्टी के कॉन्टेंट के बारे में जानने के लिए, Cloud Logging के दस्तावेज़ में LogEntry ऑब्जेक्ट देखें.
सिंटैक्स
<Action>log</Action>
<Input><![CDATA[{
"logName" : "cloud-log-name-to-use",
"metadata" : JSON-structured-metadata,
"message" : "data-to-log-as-entry"
}]]></Input>
उदाहरण: स्ट्रिंग
<Action>log</Action>
<Input><![CDATA[{
"logName" : "example-log",
"metadata" : { "resource" : { "type" : "global" } },
"message": "This is a test."
}]]></Input>
उदाहरण: JSON
<Action>log</Action>
<Input><![CDATA[{
"logName" : "example-log",
"metadata" : { "resource" : { "type" : "global" } },
"message" : { "info" : "This is a test." }
}]]></Input>
अनुरोध के पैरामीटर
| पैरामीटर | ब्यौरा | टाइप | डिफ़ॉल्ट | ज़रूरी है |
|---|---|---|---|---|
logName |
उस लॉग का नाम जिससे यह एंट्री जुड़ी है. | स्ट्रिंग | कोई नहीं | हां |
metadata |
लॉग एंट्री के बारे में मेटाडेटा.metadata में type और labels सेट करने के बारे में ज़्यादा जानकारी और विकल्पों के लिए, MonitoredResource देखें. |
JSON | कोई नहीं | नहीं |
message |
इस लॉग एंट्री के लिए वैल्यू के तौर पर इस्तेमाल किया जाने वाला डेटा. ज़्यादा स्ट्रक्चर्ड मैसेज को लॉग करने के लिए, स्ट्रिंग तय की जा सकती है या JSON का इस्तेमाल किया जा सकता है. | स्ट्रिंग या JSON | कोई नहीं | हां |
जवाब
None अगर मैसेज को लॉग में लिखा गया था. ऐसा न करने पर, अनुरोध में गड़बड़ी दिखेगी. एक्सटेंशन को डीबग करना लेख भी पढ़ें.
कॉन्फ़िगरेशन का रेफ़रंस
एपीआई प्रॉक्सी में इस्तेमाल करने के लिए इस एक्सटेंशन को कॉन्फ़िगर और डिप्लॉय करते समय, इसका इस्तेमाल करें.
एक्सटेंशन की सामान्य प्रॉपर्टी
हर प्रॉपर्टी के लिए नीचे दी गई प्रॉपर्टी मौजूद हैं.
| प्रॉपर्टी | जानकारी | डिफ़ॉल्ट | ज़रूरी है |
|---|---|---|---|
name |
वह नाम, जिसे आप एक्सटेंशन का यह कॉन्फ़िगरेशन दे रहे हैं. | कभी नहीं | हां |
packageName |
एक्सटेंशन पैकेज का नाम, जो Apigee Edge से दिया गया है. | कभी नहीं | हां |
version |
उस एक्सटेंशन पैकेज का वर्शन नंबर जिससे आपको एक्सटेंशन कॉन्फ़िगर करना है. | कभी नहीं | हां |
configuration |
आप जिस एक्सटेंशन को जोड़ रहे हैं उसके लिए खास तौर पर कॉन्फ़िगरेशन वैल्यू. इस एक्सटेंशन पैकेज के लिए प्रॉपर्टी देखें | कभी नहीं | हां |
इस एक्सटेंशन पैकेज के लिए प्रॉपर्टी
इस एक्सटेंशन के लिए, यहां दी गई कॉन्फ़िगरेशन प्रॉपर्टी की वैल्यू तय करें.
| प्रॉपर्टी | ब्यौरा | डिफ़ॉल्ट | ज़रूरी है |
|---|---|---|---|
projectId |
वह Google Cloud प्रोजेक्ट आईडी जहां लॉग बनाए जाने चाहिए. | कोई नहीं | हां |
credentials |
Apigee Edge कंसोल में डालने पर, यह आपकी सेवा खाते की कुंजी फ़ाइल का कॉन्टेंट होता है. Management API का इस्तेमाल करके भेजे जाने पर, यह सेवा खाते की कुंजी फ़ाइल से जनरेट की गई base64-encoded वैल्यू होती है. | कोई नहीं | हां |