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

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़.
जानकारी

वर्शन 1.3.7

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

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

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

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

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

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

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

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

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

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

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

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

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

सैंपल

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

ग्लोबल लॉग

इस नीति के तहत "यह एक टेस्ट है" मैसेज लिखा जाता है का इस्तेमाल करें. असल में इस्तेमाल करते समय, हो सकता है कि आपके पास मैसेज को किसी ऐसे फ़्लो वैरिएबल में शामिल किया जाए जिसकी वैल्यू आपने एपीआई प्रॉक्सी में कहीं और सेट की है.

<?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 के लॉगिंग दस्तावेज़ में 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>

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

पैरामीटर ब्यौरा टाइप डिफ़ॉल्ट ज़रूरी है
logName उस लॉग का नाम जिससे यह एंट्री जुड़ी है. स्ट्रिंग कोई नहीं. हां.
मेटाडेटा लॉग एंट्री के बारे में मेटाडेटा.
metadata में type और labels को सेट करने के बारे में ज़्यादा जानकारी और विकल्पों के लिए, MonitoredResource देखें.
JSON कोई नहीं. नहीं.
मैसेज इस लॉग एंट्री के लिए वैल्यू के तौर पर इस्तेमाल किया जाने वाला डेटा. स्ट्रिंग कोई नहीं. हां.

जवाब

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

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

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

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

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

प्रॉपर्टी जानकारी डिफ़ॉल्ट ज़रूरी है
name वह नाम, जिसे आप एक्सटेंशन का यह कॉन्फ़िगरेशन दे रहे हैं. कभी नहीं हां
packageName एक्सटेंशन पैकेज का नाम, जो Apigee Edge से दिया गया है. कभी नहीं हां
version उस एक्सटेंशन पैकेज का वर्शन नंबर जिससे आपको एक्सटेंशन कॉन्फ़िगर करना है. कभी नहीं हां
configuration आप जिस एक्सटेंशन को जोड़ रहे हैं उसके लिए खास तौर पर कॉन्फ़िगरेशन वैल्यू. इस एक्सटेंशन पैकेज के लिए प्रॉपर्टी देखें कभी नहीं हां

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

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

प्रॉपर्टी ब्यौरा डिफ़ॉल्ट ज़रूरी है
प्रोजेक्ट-आईडी वह GCP प्रोजेक्ट आईडी जहां लॉग बनाने हैं. कोई नहीं. हां.
क्रेडेंशियल Apigee Edge कंसोल में डाला गया कॉन्टेंट, आपके सेवा खाते की कुंजी वाली फ़ाइल का कॉन्टेंट होता है. मैनेजमेंट एपीआई की मदद से भेजने पर, यह base64 कोड में बदली गई वैल्यू होती है. यह सेवा खाते की कुंजी फ़ाइल से जनरेट होती है. कोई नहीं. हां.