Watch the calls
APIM 3 · 3:33
The gateway logs each request, and its figures show who calls an API and which calls failed. A row in the request list opens the trace of that call into the integration behind the API.
This part of the video couldn't be loaded.
What it covers
- The last day of calls and the Behind it line in
weikio describe api - One row per caller with
weikio metrics, split by subscription - Failures on Weik.io's side and failures on the caller's side
- The API's overview tiles and the Behind it link in the admin UI
- The Requests section, with one row per call
- Opening the trace of a call into the integration behind the API
Commands in this video
Terminal
$ weikio describe api finance/invoices
$ weikio metrics --api finance/invoices --env production
$ weikio metrics --api finance/invoices --env production --by subscription
$ curl http://api.example.com/invoices/1.0/orders/42 -H "X-Api-Key: $API_KEY"Transcript
- 0:02One caller has been calling a published API for a day. This video reads what your Weik.io installation kept of that day,
- 0:10from the terminal and from the admin UI.
- 0:17The drawing is your installation as the earlier APIM videos left it:
- 0:22the gateway serves the invoices API on the production host name to partner-x, under its per-minute limit.
- 0:30Each call leaves an access line the commands and pages read.
- 0:34The tiles count the last day.
- 0:40weikio describe api for the invoices API prints what it is,
- 0:44how its last day went, and who may call it.
- 0:48The version row names 1.0 as a proxy in production, with the address it answers at.
- 0:54The last-day line repeats the tiles' count: calls,
- 0:58failures on the server side and the callers' side.
- 1:02The Behind it line names the integration behind the API, orders-api.
- 1:07The platform reads it from the API's traces,
- 1:10because nothing in the installation configures what stands behind an API.
- 1:15The only subscription is partner-x's, active with an API key under its limit.
- 1:25weikio metrics for that API in production reads the gateway's figures.
- 1:31It sums a window: calls, failures on each side, response times.
- 1:36Split by subscription, it prints a row per caller.
- 1:41The finance/partner-x row is its share: calls made with its key,
- 1:46how many its rate limit refused, its last call.
- 1:50A call with no key counts for the API but for nobody.
- 1:54The server side says the gateway or the integration behind the API is at fault.
- 2:00The callers' side says the caller erred: a missing key,
- 2:03a limit overrun, a bad request.
- 2:09curl sends another call to the API's address, with partner-x's key in the header.
- 2:14It goes into the gateway's lines as the newest one.
- 2:22Every API gets a page in the admin UI. Its overview is the same last day the terminal read.
- 2:29The tiles carry the call count, the failures on both sides, and how long calls took.
- 2:34The details name the same integration, from the API's traces, with a link to it.
- 2:43The Requests section gives every recorded call a row:
- 2:47how it came in, who made it, how it ended.
- 2:50The newest row is the call from the terminal.
- 2:55From any row you open the trace of that call.
- 2:58The trace follows the call from the gateway to orders-api,
- 3:02timing the gateway's span and the integration's span.
- 3:10Each call passes the gateway and leaves an access line.
- 3:14The lines add up to figures: who called, how many, how many failed.
- 3:19Any row opens a trace down to the integration that answered.
Next in this track
APIM 4 · 3:09 Webhooks Watched