आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
इस पेज पर जाएं
Apigee X दस्तावेज़. जानकारी
वर्शन 1.6.6
Cloud Logging के लॉग में एंट्री लिखें.
इस कॉन्टेंट में, इस एक्सटेंशन को कॉन्फ़िगर करने और इसका इस्तेमाल करने के बारे में जानकारी दी गई है.
ज़रूरी शर्तें
किसी API प्रॉक्सी से इस एक्सटेंशन का उपयोग करने से पहले, आपको यह करना होगा:
IAM में, लॉगिंग > प्रोजेक्ट के सदस्य के लिए राइटर की भूमिका को लॉग करता है, जो क्लाउड लॉगिंग सिस्टम में आपके एक्सटेंशन को दिखाएगा. भूमिकाएं देने के तरीके से जुड़े निर्देशों के लिए, खास संसाधनों के लिए सेवा खाते को भूमिकाएं देना देखें. लॉगिंग भूमिकाओं के बारे में ज़्यादा जानने के लिए, ऐक्सेस कंट्रोल गाइड देखें.
सेवा खाते के लिए कुंजी जनरेट करने के लिए, Google Cloud Console का इस्तेमाल करें.
कॉन्फ़िगरेशन रेफ़रंस का इस्तेमाल करके, एक्सटेंशन जोड़ते और कॉन्फ़िगर करते समय, नतीजे वाली कुंजी JSON फ़ाइल के कॉन्टेंट का इस्तेमाल करें.
यह एक्सटेंशन, PostClientFlow में मौजूद एक्सटेंशन कॉलआउट नीति के ज़रिए कॉल करने का समर्थन करता है.
अगर इस एक्सटेंशन को कॉल करने के लिए, एक्सटेंशन कॉल आउट नीति का इस्तेमाल करना है, तो
PostClientFlow, यह पक्का करें कि features.allowExtensionsInPostClientFlow
फ़्लैग
आपके संगठन में इसे true
पर सेट किया गया है.
अगर आप सार्वजनिक Cloud के ग्राहक हैं, तो आपको Apigee Edge की सहायता टीम से संपर्क करना होगा, ताकि यह पक्का किया जा सके कि आपके संगठन में
features.allowExtensionsInPostClientFlow
फ़्लैग कोtrue
पर सेट किया गया है.अगर आप Private Cloud के ग्राहक के लिए Apigee Edge हैं, तो संगठन की प्रॉपर्टी अपडेट करना एपीआई
features.allowExtensionsInPostClientFlow
फ़्लैग कोtrue
पर सेट करने के लिए.
क्लाउड लॉगिंग के बारे में
क्लाउड लॉगिंग, Google Cloud का हिस्सा है ऑपरेशन सुइट. इसमें लॉग का स्टोरेज शामिल होता है. लॉग नाम का यूज़र इंटरफ़ेस होता है एक्सप्लोरर और एपीआई की मदद से लॉग मैनेज करने की सुविधा का इस्तेमाल करें. क्लाउड लॉगिंग के साथ, आप लॉग एंट्री पढ़ें और लिखें, लॉग खोजें और फ़िल्टर करें, लॉग एक्सपोर्ट करें, और लॉग-आधारित मेट्रिक बना सकता है.
फ़िलहाल, क्लाउड लॉगिंग एक्सटेंशन लॉग में एंट्री लिखता है. अन्य जानकारी के लिए, Cloud Logging के दस्तावेज़ देखें.
सैंपल
नीचे दिए गए उदाहरणों में, क्लाउड लॉगिंग के लिए सहायता को कॉन्फ़िगर करने का तरीका बताया गया है एक्सटेंशन कॉलआउट नीति का इस्तेमाल करके, एक्सटेंशन से जुड़ी कार्रवाइयां.
ग्लोबल लॉग
यह नीति, कॉल किए गए लॉग में This is a test
मैसेज लिखती है
Cloud Global के संसाधन में example-log
. असल में इस्तेमाल करते समय, शायद आप
मैसेज को किसी ऐसे फ़्लो वैरिएबल में शामिल रखें जिसका मान आपने कहीं और सेट किया हो
की अनुमति है.
<?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
लॉग में मैसेज लिखता है.
यह कार्रवाई, क्लाउड लॉगिंग लॉग एंट्री लिखती है. लॉग एंट्री में मेटाडेटा होता है
शामिल है. लॉग एंट्री के बारे में ज़्यादा जानने के लिए, देखें
एंट्री रेफ़रंस.
metadata
प्रॉपर्टी के कॉन्टेंट के बारे में जानने के लिए, यहां देखें
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 कंसोल में डाला गया कॉन्टेंट, आपके सेवा खाते की कुंजी वाली फ़ाइल का कॉन्टेंट होता है. मैनेजमेंट एपीआई की मदद से भेजने पर, यह base64 कोड में बदली गई वैल्यू होती है. यह सेवा खाते की कुंजी फ़ाइल से जनरेट होती है. | कोई नहीं | हां |