Google Stackdriver लॉगिंग एक्सटेंशन

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

है

वर्शन 1.3.7

स्टैकड्राइवर लॉगिंग लॉग में एंट्री लिखें.

इस कॉन्टेंट में, इस एक्सटेंशन को कॉन्फ़िगर करने और इसका इस्तेमाल करने का रेफ़रंस दिया गया है.

ज़रूरी शर्तें

किसी API प्रॉक्सी से इस एक्सटेंशन का उपयोग करने से पहले, आपको:

1. IAM में, प्रोजेक्ट के सदस्य को लॉगिंग > लॉग राइटर और लॉगिंग > लॉग व्यूअर की भूमिका असाइन करें. यह भूमिका, स्टैकड्राइवर लॉगिंग सिस्टम को आपके एक्सटेंशन के तौर पर दिखेगी. भूमिकाएं देने के तरीके से जुड़े निर्देशों के लिए, खास संसाधनों के लिए किसी सेवा खाते को भूमिकाएं देना देखें. लॉगिंग भूमिकाओं के बारे में ज़्यादा जानकारी के लिए, ऐक्सेस कंट्रोल गाइड देखें.

2. सेवा खाते के लिए कुंजी जनरेट करने के लिए, GCP कंसोल का इस्तेमाल करें.

3. कॉन्फ़िगरेशन रेफ़रंस का इस्तेमाल करके, एक्सटेंशन को जोड़ते और कॉन्फ़िगर करते समय, जनरेट हुई कुंजी JSON फ़ाइल के कॉन्टेंट का इस्तेमाल करें.

यह एक्सटेंशन, PostClientFlow में मौजूद एक्सटेंशन कॉलआउट नीति से कॉल करने का समर्थन करता है. अगर आपको इस एक्सटेंशन को PostClientFlow से कॉल करने के लिए, एक्सटेंशन कॉलआउट नीति का इस्तेमाल करना है, तो पक्का करें कि आपके संगठन में features.allowExtensionsInPostClientFlow फ़्लैग को true पर सेट किया गया हो.

• अगर आप Public Cloud के ग्राहक के लिए Apigee Edge हैं, तो आपको Apigee Edge की सहायता टीम से संपर्क करना होगा. इससे यह पक्का किया जा सकेगा कि आपके संगठन में features.allowExtensionsInPostClientFlow फ़्लैग को true पर सेट किया गया है.

• अगर आप Private Cloud के ग्राहक के लिए Apigee Edge हैं, तो संगठन की प्रॉपर्टी अपडेट करें एपीआई का इस्तेमाल करके, features.allowExtensionsInPostClientFlow फ़्लैग को true पर सेट करें.

स्टैकड्राइवर लॉगिंग के बारे में

स्टैकड्राइवर लॉगिंग Google Cloud Platform (GCP) में प्रॉडक्ट के Stackdriver सुइट का हिस्सा है. इसमें लॉग के लिए स्टोरेज, लॉग व्यूअर नाम का यूज़र इंटरफ़ेस, और लॉग को प्रोग्राम के हिसाब से मैनेज करने के लिए एपीआई शामिल है. स्टैकड्राइवर लॉगिंग की मदद से, लॉग एंट्री को पढ़ा और लिखा जा सकता है. साथ ही, अपने लॉग को खोजा और फ़िल्टर किया जा सकता है, अपने लॉग एक्सपोर्ट किए जा सकते हैं, और लॉग-आधारित मेट्रिक बनाए जा सकते हैं.

यह एक्सटेंशन फ़िलहाल, लॉग में एंट्री लिखता है. ज़्यादा जानकारी के लिए, स्टैकड्राइवर लॉगिंग दस्तावेज़ देखें.

सैंपल

नीचे दिए गए उदाहरणों में, एक्सटेंशन कॉलआउट नीति का इस्तेमाल करके, Stackdriver लॉगिंग एक्सटेंशन की कार्रवाइयों के लिए सहायता कॉन्फ़िगर करने का तरीका बताया गया है.

ग्लोबल लॉग

इस नीति में Stackdriver 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>stackdriver-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 प्रॉपर्टी के कॉन्टेंट के बारे में जानकारी के लिए, Stackdriver Logging दस्तावेज़ में LogEntry ऑब्जेक्ट देखें.

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-log-name-to-use",
  "metadata" : JSON-structured-metadata,
  "message" : "data-to-log-as-entry"
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-log-name-to-use",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : "data-to-log-as-entry"
}]]></Input>

अनुरोध के पैरामीटर

जवाब

अगर मैसेज लॉग में लिखा गया हो, तो कोई नहीं. ऐसा न करने पर, अनुरोध करने पर गड़बड़ी का मैसेज दिखेगा. किसी एक्सटेंशन को डीबग करना भी देखें.

कॉन्फ़िगरेशन का रेफ़रंस

इस एक्सटेंशन को एपीआई प्रॉक्सी में इस्तेमाल करने के लिए, कॉन्फ़िगर और डिप्लॉय करते समय, इनका इस्तेमाल करें.

सामान्य एक्सटेंशन प्रॉपर्टी

हर प्रॉपर्टी के लिए नीचे दी गई प्रॉपर्टी मौजूद हैं.

इस एक्सटेंशन पैकेज की प्रॉपर्टी

इस एक्सटेंशन के लिए खास तौर पर, यहां दी गई कॉन्फ़िगरेशन प्रॉपर्टी की वैल्यू तय करें.