आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
एपीआई मॉनिटरिंग के आंकड़े पाने के लिए, यहां दिए गए एपीआई का इस्तेमाल करें. मेट्रिक, एपीआई मॉनिटरिंग की ओर से एग्रीगेट की गई डेटा वैल्यू होती हैं. ये वैल्यू, एपीआई मॉनिटरिंग के लॉग में मौजूद रॉ डेटा से मिलती हैं.
यहां दिए गए सेक्शन में, एपीआई का इस्तेमाल करके मेट्रिक मैनेज करने का तरीका बताया गया है.
- Metrics API
- गड़बड़ी की जानकारी पाना
- ट्रैफ़िक और लेटेन्सी के लिए मेट्रिक कैप्चर करना
- सूचनाओं के लिए मेट्रिक कैप्चर करना
मेट्रिक एपीआई के बारे में ज़्यादा जानने के लिए, Metrics API देखें.
इन उदाहरणों में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.
Metrics API
मेट्रिक एपीआई को GET अनुरोध भेजने के लिए, इस बेस यूआरएल का इस्तेमाल करें:
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 मिनट के लिए लेन-देन प्रति सेकंड (टीपीएस) मेट्रिक देखने के लिए:
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 मिनट में कैलकुलेट किए गए टीपीएस की जानकारी होती है.
interval क्वेरी पैरामीटर से यह तय होता है कि मेट्रिक को नतीजों में कितनी बार सेव किया जाएगा. साथ ही, इससे नतीजों में वैल्यू के लिए सैंपलिंग विंडो भी तय होती है. ऊपर दिए गए उदाहरण में, मेट्रिक की गिनती पिछले 10 मिनट के हिसाब से की जाती है. साथ ही, हर 10 मिनट में नतीजों को अपडेट किया जाता है.
आईएसओ फ़ॉर्मैट में समय की सीमा तय करने के लिए, from और to क्वेरी पैरामीटर का इस्तेमाल करें.
from और to के लिए, ज़्यादा से ज़्यादा 24 घंटे की अवधि तय की गई है.
तारीख का फ़ॉर्मैट इनमें से कोई भी हो सकता है:
yyyy-mm-ddThh:mm:ssZyyyy-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 देखें.