एपीआई का इस्तेमाल करके मेट्रिक डेटा देखें

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

एपीआई मॉनिटरिंग मेट्रिक पाने के लिए, यहां बताए गए एपीआई का इस्तेमाल करें. मेट्रिक, एपीआई मॉनिटरिंग लॉग में मौजूद रॉ डेटा से एपीआई मॉनिटरिंग की मदद से इकट्ठा की गई डेटा वैल्यू होती हैं.

नीचे दिए गए सेक्शन में, एपीआई का इस्तेमाल करके मेट्रिक मैनेज करने का तरीका बताया गया है.

मेट्रिक एपीआई के बारे में ज़्यादा जानने के लिए, मेट्रिक एपीआई देखें.

इन उदाहरणों में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

Metrics API

मेट्रिक एपीआई को जीईटी अनुरोध करने के लिए, इस्तेमाल किया जाने वाला बेस यूआरएल यह है:

https://apimonitoring.enterprise.apigee.com/metrics/resource

यहां resource किसी खास मेट्रिक से जुड़ा है. यहां दी गई टेबल में मेट्रिक के रिसॉर्स की सूची दी गई है:

संसाधन जानकारी
/traffic ट्रैफ़िक मेट्रिक पाएं. प्रॉक्सी का नाम, इंटरवल, टाइम विंडो, टारगेट, स्टेटस कोड वगैरह जैसे फ़िल्टर तय करें.
/latency अनुरोधों के लिए इंतज़ार का समय दिखाने वाली मेट्रिक पाना

को Edge और बैकएंड टारगेट पर भेजा जाता है. प्रॉक्सी का नाम, इंटरवल, टारगेट, स्टेटस कोड वगैरह जैसे फ़िल्टर तय करें.

/targets किसी खास संगठन और एनवायरमेंट के लिए, सभी टारगेट डोमेन पाएं.
/alerthistory किसी खास संगठन और समयावधि के लिए, सूचना के इतिहास की मेट्रिक पाएं.
/alertinstance/instanceid सूचना के किसी खास इंस्टेंस आईडी के लिए, सूचना के इतिहास की मेट्रिक पाएं.
/alertsummary किसी संगठन और समयावधि के लिए, सूचनाओं की कुल संख्या पाएं.
/faultcodenames गड़बड़ी के कोड के सभी नाम पाएं.
/faultcodes गड़बड़ी के कोड पाएं.
/faultcodecategories गड़बड़ी के कोड की कैटगरी पाएं.
/faultcodesubcategories गड़बड़ी के कोड की सबकैटगरी पाएं.
/faultcodedetails गड़बड़ी के सभी कोड और उनकी जानकारी पाएं.

गड़बड़ी की जानकारी पाना

/fault* संसाधन, Edge पर होने वाली संभावित गड़बड़ियों के बारे में मेटाडेटा दिखाते हैं. उदाहरण के लिए, गड़बड़ी की सभी संभावित कैटगरी की सूची देखने के लिए:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/faultcodecategories" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें, जैसा कि OAuth 2.0 ऐक्सेस टोकन पाना में बताया गया है.

जवाब इस तरह दिखता है:

{
  "faultCodeCategories":[
    "","API Protocol","Developer/App","Extension Policy","Gateway",
    "Mediation Policy","Mint","Security Policy","Sense","Traffic Mgmt Policy"
  ]
}

इसके बाद, API Protocol कैटगरी के लिए गड़बड़ी के कोड की सूची तय की जा सकती है:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/faultcodes?faultCodeCategory=API Protocol" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

ज़्यादा विकल्पों के लिए, Metrics API देखें.

ट्रैफ़िक और इंतज़ार के समय की मेट्रिक कैप्चर करना

Metrics API में ऐसे फ़िल्टर होते हैं जिन्हें एपीआई पर लागू किया जा सकता है. इससे, कैलकुलेट की गई मेट्रिक के लिए, पसंद के मुताबिक समयसीमाएं, प्रॉक्सी, इलाके, एनवायरमेंट, और अन्य फ़िल्टर तय किए जा सकते हैं. उदाहरण के लिए, सभी एनवायरमेंट के लिए, पिछले घंटे के हर 10 मिनट में हर सेकंड के लेन-देन (tps) की मेट्रिक देखने के लिए:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/traffic?from=-1h&to=now&select=tps&interval=10m&groupBy=env&org=myorg" \
-H "accept: application/json"  \
-H "Authorization: Bearer $ACCESS_TOKEN" 

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें, जैसा कि OAuth 2.0 ऐक्सेस टोकन पाना में बताया गया है.

इस कॉल से इस फ़ॉर्म में नतीजे मिलते हैं:

{
  "results":[
    {
      "series":[
        {
          "name":"proxy",
        "tags":
             {
                "env":"prod",
                "intervalSeconds":"60",
                "org":"myorg",
                "region":"myregion"
              },
            "columns":["time","tps"],
            "values":[
              ["2018-08-15T13:10:00Z",5.03],
              ["2018-08-15T13:20:00Z",5.01],
              ["2018-08-15T13:30:00Z",5.81],
              ["2018-08-15T13:40:00Z",5.95],
              
            ]
          },
       
       }
    }]
}

देखें कि columns प्रॉपर्टी, values के फ़ॉर्मैट के बारे में कैसे बताती है. values प्रॉपर्टी में, पिछले 10 मिनट के इंटरवल के लिए हर 10 मिनट में tps का हिसाब लगाया जाता है.

interval क्वेरी पैरामीटर से यह तय होता है कि नतीजों में मेट्रिक कितनी बार सेव की जाए. साथ ही, इससे नतीजों में वैल्यू के लिए सैंपलिंग विंडो भी तय होती है. ऊपर दिए गए उदाहरण में, मेट्रिक का हिसाब पिछले 10 मिनट के आधार पर लगाया जाता है और हर 10 मिनट में नतीजों में लिखा जाता है.

ISO फ़ॉर्मैट में समयसीमा तय करने के लिए, from और to क्वेरी पैरामीटर का इस्तेमाल करें. from और to के लिए, ज़्यादा से ज़्यादा 24 घंटे की अवधि तय की जा सकती है.

तारीख का फ़ॉर्मैट इनमें से कोई एक हो सकता है:

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

उदाहरण के लिए:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/traffic?from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z&select=tps&interval=1m&groupBy=env&org=myorg&proxy=PublicAPI" \
-H "accept: application/json"  \
-H "Authorization: Bearer $ACCESS_TOKEN"

इसके अलावा, from और to क्वेरी पैरामीटर का इस्तेमाल करके, किसी समयसीमा के बारे में बताया जा सकता है. उदाहरण के लिए, पिछले घंटे के लिए:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/traffic?from=-1h&to=now&select=tps&interval=1m&groupBy=env&org=myorg&proxy=PublicAPI" \
-H "accept: application/json"  \
-H "Authorization: Bearer $ACCESS_TOKEN"

एक अन्य विकल्प यह है कि किसी एक प्रॉक्सी के लिए, हर सेकंड में होने वाले लेन-देन (टीपीएस) को दिखाने के लिए, proxy क्वेरी पैरामीटर का इस्तेमाल करें:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/traffic?from=-1h&to=now&select=tps&interval=1m&groupBy=env&org=myorg&proxy=PublicAPI" \
-H "accept: application/json"  \
-H "Authorization: Bearer $ACCESS_TOKEN"

इंतज़ार का समय मेट्रिक के लिए, ट्रैफ़िक मेट्रिक के लिए तय की गई कई शर्तें बताएं. हालांकि, /latency संसाधन के लिए:

  • आपको percentile क्वेरी पैरामीटर को 50, 90, 95 या 99 के तौर पर बताना होगा. उदाहरण के लिए, अगर आपने 90 तय किया है, तो एपीआई 90वें पर्सेंटाइल में रिस्पॉन्स में लगने वाले कुल समय की वैल्यू दिखाता है.
  • windowsize एक मिनट पर सेट है.

उदाहरण के लिए, एक मिनट की विंडो के लिए, 90वें पर्सेंटाइल में कुल इंतज़ार का समय दिखाने वाली मेट्रिक देखने के लिए:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/latency?percentile=90&select=totalLatency&from=-1h&to=now&interval=5m&windowsize=1m&groupBy=org,env,region&org=myorg" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

ज़्यादा विकल्पों के लिए, Metrics API देखें.

सूचनाओं के लिए मेट्रिक कैप्चर करना

Metrics API, सभी सूचनाओं, किसी खास सूचना या सूचना की खास जानकारी के लिए मेट्रिक दिखाता है. उदाहरण के लिए, किसी संगठन के लिए पिछले एक घंटे की सूचनाओं का इतिहास देखने के लिए:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/alerthistory?org=myorg&from=-1h&to=now" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें, जैसा कि OAuth 2.0 ऐक्सेस टोकन पाना में बताया गया है.

इस एपीआई कॉल से, इस फ़ॉर्मैट में जवाब मिलता है:

[
  {
"id":"983c4c7a-c301-4697-95cc-9a7c53e05fac",
"organization":"myorg",
"environment":"prod",
"name":"Public Api 5xx error rate",
"type":"Alert",
"source":"https://www.apigee.net/sonar",
"raw_payload":"
{
    \"reportUUID\":\"\",
    \"reportEnabled\":false,
    \"organization\":\"myorg\",
    \"name\":\"Public Api 5xx error rate\",
    \"self\":\"/alerts/95cc9ef4-345f-11e8-9fd3-12774584e062\",
    \"description\":\"\",
    \"conditions\":[
    {
        \"comparator\":\"\u003e\",
        \"metric\":\"rate\",
        \"durationSeconds\":3600,
        \"name\":\"\",
        \"description\":\"\",
        \"threshold\":0.01,
        \"dimensions\":
        {
            \"proxy\":\"myAPI\",
            \"org\":\"myorg\",
            \"env\":\"prod\",
            \"region\":\"myRegion\",
            \"statusCode\":\"5xx\"
            }
        }],
        \"uuid\":\"95cc9ef4-345f-11e8-9fd3-12774584e062\",
    \"playbook\":\"This is a test alert.\"
    }",
"time":"2018-08-14T12:45:28Z"
 },
 
]

इसके बाद, किसी खास सूचना के बारे में जानकारी पाने के लिए, दिखाए गए कलेक्शन में id का इस्तेमाल किया जा सकता है:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/alertinstance/983c4c7a-c301-4697-95cc-9a7c53e05fac" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

ज़्यादा विकल्पों के लिए, Metrics API देखें.