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

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

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

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

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

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

मेट्रिक एपीआई

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

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

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

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

और बैकएंड टारगेट तक पहुंच सकते हैं. प्रॉक्सी नाम, अंतराल, टारगेट, स्थिति कोड और कई दूसरे फ़िल्टर तय करें.

/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 देखें.

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

मेट्रिक 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"

दूसरा विकल्प यह है कि किसी एक प्रॉक्सी के लिए ट्रांज़ैक्शन प्रति सेकंड (tps) दिखाने के लिए, 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 देखें.

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

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

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 देखें.