PageRenderTime 48ms CodeModel.GetById 20ms RepoModel.GetById 1ms app.codeStats 0ms

/articles/api-management/api-management-howto-api-inspector.md

https://gitlab.com/yeah568/azure-content
Markdown | 262 lines | 220 code | 42 blank | 0 comment | 0 complexity | 930a7551165ffa129596a8f64c1059d8 MD5 | raw file
    

  1. <properties 
    2. 

  2. 	pageTitle="How to use the API Inspector to trace calls in Azure API Management" 
    3. 

  3. 	description="Learn how to trace calls using the API Inspector in Azure API Management." 
    4. 

  4. 	services="api-management" 
    5. 

  5. 	documentationCenter="" 
    6. 

  6. 	authors="steved0x" 
    7. 

  7. 	manager="erikre" 
    8. 

  8. 	editor=""/>
    9. 

  9. 

  10. <tags 
    11. 

  11. 	ms.service="api-management" 
    12. 

  12. 	ms.workload="mobile" 
    13. 

  13. 	ms.tgt_pltfrm="na" 
    14. 

  14. 	ms.devlang="na" 
    15. 

  15. 	ms.topic="article" 
    16. 

  16. 	ms.date="05/25/2016" 
    17. 

  17. 	ms.author="sdanie"/>
    18. 

  18. 

  19. # How to use the API Inspector to trace calls in Azure API Management
    20. 

  20. 

  21. API Management provides an API Inspector tool to help you with debugging and troubleshooting your APIs. The API Inspector can be used programmatically and can also be used directly from the developer portal. 
    22. 

  22. 

  23. In addition to tracing operations, API Inspector also traces [policy expression](https://msdn.microsoft.com/library/azure/dn910913.aspx) evaluations. For a demonstration, see [Cloud Cover Episode 177: More API Management Features](https://azure.microsoft.com/documentation/videos/episode-177-more-api-management-features-with-vlad-vinogradsky/) and fast-forward to 21:00.
    24. 

  24. 

  25. This guide provides a walk-through of using API Inspector.
    26. 

  26. 

  27. >[AZURE.NOTE] API Inspector traces are only generated and made available for requests containing subscription keys that belong to the [administrator](api-management-howto-create-groups.md) account.
    28. 

  28. 

  29. ## <a name="trace-call"> </a> Use API Inspector to trace a call
    30. 

  30. 

  31. To use API Inspector, add an **ocp-apim-trace: true** request header to your operation call, and then download and inspect the trace using the URL indicated by the **ocp-apim-trace-location** response header. This can be done programatically, and can also be done directly from the developer portal.
    32. 

  32. 

  33. This tutorial shows how to use the API Inspector to trace operations using the Basic Calculator API that is configured in the [Manage your first API](api-management-get-started.md) getting started tutorial. If you haven't completed that tutorial it only takes a few moments to import the Basic Calculator API, or you can use another API of your choosing such as the Echo API. Each API Management service instance comes pre-configured with an Echo API that can be used to experiment with and learn about API Management. The Echo API returns back whatever input is sent to it. To use it, you can invoke any HTTP verb, and the return value will simply be what you sent. 
    34. 

    35. 

  35. 

  36. 

  37. To get started, click **developer portal** in the Azure Classic Portal for your API Management service. Operations can be called directly from the developer portal which provides a convenient way to view and test the operations of an API.
    38. 

  38. 

  39. >If you haven't yet created an API Management service instance, see [Create an API Management service instance][] in the [Get started with Azure API Management][] tutorial.
    40. 

    41. 

  41. ![API Management developer portal][api-management-developer-portal-menu]
    42. 

  42. 

  43. Click **APIs** from the top menu, and then click **Basic Calculator**.
    44. 

  44. 

  45. ![Echo API][api-management-api]
    46. 

  46. 

  47. Click **Try it** to try the **Add two integers** operation.
    48. 

  48. 

  49. ![Try it][api-management-open-console]
    50. 

  50. 

  51. Keep the default parameter values, and select the subscription key for the product you want to use from the **subscription-key** drop-down.
    52. 

  52. 

  53. By default in the developer portal the **Ocp-Apim-Trace** header is already set to **true**. This header configures whether or not a trace is generated.
    54. 

  54. 

  55. ![Send][api-management-http-get]
    56. 

  56. 

  57. Click **Send** to invoke the operation.
    58. 

  58. 

  59. ![Send][api-management-send-results]
    60. 

  60. 

  61. In the response headers will be an **ocp-apim-trace-location** with a value similar to the following example.
    62. 

  62. 

  63. 	ocp-apim-trace-location : https://contosoltdxw7zagdfsprykd.blob.core.windows.net/apiinspectorcontainer/ZW3e23NsW4wQyS-SHjS0Og2-2?sv=2013-08-15&sr=b&sig=Mgx7cMHsLmVDv%2B%2BSzvg3JR8qGTHoOyIAV7xDsZbF7%2Bk%3D&se=2014-05-04T21%3A00%3A13Z&sp=r&verify_guid=a56a17d83de04fcb8b9766df38514742
    64. 

  64. 

  65. The trace can be downloaded from the specified location and reviewed as demonstrated in the next step.
    66. 

  66. 

  67. ## <a name="inspect-trace"> </a>Inspect the trace
    68. 

  68. 

  69. To review the values in the trace, download the trace file from the **ocp-apim-trace-location** URL. It is a text file in JSON format, and contains entries similar to the following example.
    70. 

  70. 

  71. 	{
    72. 

  72. 	    "traceId": "abcd8ea63d134c1fabe6371566c7cbea",
    73. 

  73. 	    "traceEntries": {
    74. 

  74. 	        "inbound": [
    75. 

  75. 	            {
    76. 

  76. 	                "source": "handler",
    77. 

  77. 	                "timestamp": "2015-06-23T19:51:35.2998610Z",
    78. 

  78. 	                "elapsed": "00:00:00.0725926",
    79. 

  79. 	                "data": {
    80. 

  80. 	                    "request": {
    81. 

  81. 	                        "method": "GET",
    82. 

  82. 	                        "url": "https://contoso5.azure-api.net/calc/add?a=51&b=49",
    83. 

  83. 	                        "headers": [
    84. 

  84. 	                            {
    85. 

  85. 	                                "name": "Ocp-Apim-Subscription-Key",
    86. 

  86. 	                                "value": "5d7c41af64a44a68a2ea46580d271a59"
    87. 

  87. 	                            },
    88. 

  88. 	                            {
    89. 

  89. 	                                "name": "Connection",
    90. 

  90. 	                                "value": "Keep-Alive"
    91. 

  91. 	                            },
    92. 

  92. 	                            {
    93. 

  93. 	                                "name": "Host",
    94. 

  94. 	                                "value": "contoso5.azure-api.net"
    95. 

  95. 	                            }
    96. 

  96. 	                        ]
    97. 

  97. 	                    }
    98. 

  98. 	                }
    99. 

  99. 	            },
    100. 

  100. 	            {
    101. 

  101. 	                "source": "mapper",
    102. 

  102. 	                "timestamp": "2015-06-23T19:51:35.2998610Z",
    103. 

  103. 	                "elapsed": "00:00:00.0726213",
    104. 

  104. 	                "data": {
    105. 

  105. 	                    "configuration": {
    106. 

  106. 	                        "api": {
    107. 

  107. 	                            "from": "/calc",
    108. 

  108. 	                            "to": {
    109. 

  109. 	                                "scheme": "http",
    110. 

  110. 	                                "host": "calcapi.cloudapp.net",
    111. 

  111. 	                                "port": 80,
    112. 

  112. 	                                "path": "/api",
    113. 

  113. 	                                "queryString": "",
    114. 

  114. 	                                "query": {},
    115. 

  115. 	                                "isDefaultPort": true
    116. 

  116. 	                            }
    117. 

  117. 	                        },
    118. 

  118. 	                        "operation": {
    119. 

  119. 	                            "method": "GET",
    120. 

  120. 	                            "uriTemplate": "/add?a={a}&b={b}"
    121. 

  121. 	                        },
    122. 

  122. 	                        "user": {
    123. 

  123. 	                            "id": 1,
    124. 

  124. 	                            "groups": [
    125. 

  125. 	                                "Administrators",
    126. 

  126. 	                                "Developers"
    127. 

  127. 	                            ]
    128. 

  128. 	                        },
    129. 

  129. 	                        "product": {
    130. 

  130. 	                            "id": 1
    131. 

  131. 	                        }
    132. 

  132. 	                    }
    133. 

  133. 	                }
    134. 

  134. 	            },
    135. 

  135. 	            {
    136. 

  136. 	                "source": "handler",
    137. 

  137. 	                "timestamp": "2015-06-23T19:51:35.2998610Z",
    138. 

  138. 	                "elapsed": "00:00:00.0727522",
    139. 

  139. 	                "data": {
    140. 

  140. 	                    "message": "Request is being forwarded to the backend service.",
    141. 

  141. 	                    "request": {
    142. 

  142. 	                        "method": "GET",
    143. 

  143. 	                        "url": "http://calcapi.cloudapp.net/api/add?a=51&b=49",
    144. 

  144. 	                        "headers": [
    145. 

  145. 	                            {
    146. 

  146. 	                                "name": "Ocp-Apim-Subscription-Key",
    147. 

  147. 	                                "value": "5d7c41af64a44a68a2ea46580d271a59"
    148. 

  148. 	                            },
    149. 

  149. 	                            {
    150. 

  150. 	                                "name": "X-Forwarded-For",
    151. 

  151. 	                                "value": "33.52.215.35"
    152. 

  152. 	                            }
    153. 

  153. 	                        ]
    154. 

  154. 	                    }
    155. 

  155. 	                }
    156. 

  156. 	            }
    157. 

  157. 	        ],
    158. 

  158. 	        "outbound": [
    159. 

  159. 	            {
    160. 

  160. 	                "source": "handler",
    161. 

  161. 	                "timestamp": "2015-06-23T19:51:35.4256650Z",
    162. 

  162. 	                "elapsed": "00:00:00.1960601",
    163. 

  163. 	                "data": {
    164. 

  164. 	                    "response": {
    165. 

  165. 	                        "status": {
    166. 

  166. 	                            "code": 200,
    167. 

  167. 	                            "reason": "OK"
    168. 

  168. 	                        },
    169. 

  169. 	                        "headers": [
    170. 

  170. 	                            {
    171. 

  171. 	                                "name": "Pragma",
    172. 

  172. 	                                "value": "no-cache"
    173. 

  173. 	                            },
    174. 

  174. 	                            {
    175. 

  175. 	                                "name": "Content-Length",
    176. 

  176. 	                                "value": "124"
    177. 

  177. 	                            },
    178. 

  178. 	                            {
    179. 

  179. 	                                "name": "Cache-Control",
    180. 

  180. 	                                "value": "no-cache"
    181. 

  181. 	                            },
    182. 

  182. 	                            {
    183. 

  183. 	                                "name": "Content-Type",
    184. 

  184. 	                                "value": "application/xml; charset=utf-8"
    185. 

  185. 	                            },
    186. 

  186. 	                            {
    187. 

  187. 	                                "name": "Date",
    188. 

  188. 	                                "value": "Tue, 23 Jun 2015 19:51:35 GMT"
    189. 

  189. 	                            },
    190. 

  190. 	                            {
    191. 

  191. 	                                "name": "Expires",
    192. 

  192. 	                                "value": "-1"
    193. 

  193. 	                            },
    194. 

  194. 	                            {
    195. 

  195. 	                                "name": "Server",
    196. 

  196. 	                                "value": "Microsoft-IIS/8.5"
    197. 

  197. 	                            },
    198. 

  198. 	                            {
    199. 

  199. 	                                "name": "X-AspNet-Version",
    200. 

  200. 	                                "value": "4.0.30319"
    201. 

  201. 	                            },
    202. 

  202. 	                            {
    203. 

  203. 	                                "name": "X-Powered-By",
    204. 

  204. 	                                "value": "ASP.NET"
    205. 

  205. 	                            }
    206. 

  206. 	                        ]
    207. 

  207. 	                    }
    208. 

  208. 	                }
    209. 

  209. 	            },
    210. 

  210. 	            {
    211. 

  211. 	                "source": "handler",
    212. 

  212. 	                "timestamp": "2015-06-23T19:51:35.4256650Z",
    213. 

  213. 	                "elapsed": "00:00:00.1961112",
    214. 

  214. 	                "data": {
    215. 

  215. 	                    "message": "Response headers have been sent to the caller. Starting to stream the response body."
    216. 

  216. 	                }
    217. 

  217. 	            },
    218. 

  218. 	            {
    219. 

  219. 	                "source": "handler",
    220. 

  220. 	                "timestamp": "2015-06-23T19:51:35.4256650Z",
    221. 

  221. 	                "elapsed": "00:00:00.1963155",
    222. 

  222. 	                "data": {
    223. 

  223. 	                    "message": "Response body streaming to the caller is complete."
    224. 

  224. 	                }
    225. 

  225. 	            }
    226. 

  226. 	        ]
    227. 

  227. 	    }
    228. 

  228. 	}
    229. 

  229. 

  230. ## <a name="next-steps"> </a>Next steps
    231. 

  231. 

  232. -	Check out the other topics in the [Get started with advanced API configuration][] tutorial.
    233. 

  233. -	Watch a demo of tracing policy expressions in [Cloud Cover Episode 177: More API Management Features](https://azure.microsoft.com/documentation/videos/episode-177-more-api-management-features-with-vlad-vinogradsky/). Fast-forward to 21:00 to see the demo.
    234. 

  234. 

  235. >[AZURE.VIDEO episode-177-more-api-management-features-with-vlad-vinogradsky]
    236. 

  236. 

  237. [Use API Inspector to trace a call]: #trace-call
    238. 

  238. [Inspect the trace]: #inspect-trace
    239. 

  239. [Next steps]: #next-steps
    240. 

  240. 

  241. [Configure API settings]: api-management-howto-create-apis.md#configure-api-settings
    242. 

  242. [Responses]: api-management-howto-add-operations.md#responses
    243. 

  243. [How create and publish a product]: api-management-howto-add-products.md
    244. 

  244. 

  245. [Get started with Azure API Management]: api-management-get-started.md
    246. 

  246. [Create an API Management service instance]: api-management-get-started.md#create-service-instance
    247. 

  247. [Get started with advanced API configuration]: api-management-get-started-advanced.md
    248. 

  248. [Azure Classic Portal]: https://manage.windowsazure.com/
    249. 

  249. 

  250. 

  251. [api-management-developer-portal-menu]: ./media/api-management-howto-api-inspector/api-management-developer-portal-menu.png
    252. 

  252. [api-management-api]: ./media/api-management-howto-api-inspector/api-management-api.png
    253. 

  253. [api-management-echo-api-get]: ./media/api-management-howto-api-inspector/api-management-echo-api-get.png
    254. 

  254. [api-management-developer-key]: ./media/api-management-howto-api-inspector/api-management-developer-key.png
    255. 

  255. [api-management-open-console]: ./media/api-management-howto-api-inspector/api-management-open-console.png
    256. 

  256. [api-management-http-get]: ./media/api-management-howto-api-inspector/api-management-http-get.png
    257. 

  257. [api-management-send-results]: ./media/api-management-howto-api-inspector/api-management-send-results.png
    258. 

  258. 

  259. 

  260. 

  261. 

  262.  
    263.