
Reviewing a gateway's processing status
Review the processing status for the Gateway services that are enabled in your API Connect Catalogs and Spaces.
About this task
Sometimes you might want to check the status of an API event that is being processed by the gateway. For example, you might want to ensure that a Product was published before and is available on the gateway before you invoke one of its APIs. Or perhaps it appears that API events are being processed too slowly and you want to see if all of the events for a particular gateway service are affected.
You can review a gateway's processing status in the API Manager user interface, or by using the toolkit CLI to retrieve the information.
- You can only obtain processing status information for the DataPower® API Gateway. This feature is not supported for the DataPower Gateway (v5 compatible) service.
- Processing information is collected for each Catalog. If you view information for a particular Space, the display shows the results for the entire Catalog instead.
You can view the gateway processing status using the UI or the CLI.
Using the UI to view the gateway processing status
About this task
Procedure
Using the CLI to obtain a gateway's processing status
About this task
You can use the developer toolkit CLI to obtain information about the processing status for the Gateway services that are enabled in your Catalogs and Spaces.
Field | Description |
---|---|
service_up_to_date |
If true then all outstanding events have been processed by the Gateway
service. |
service_state |
An overall status summary of the various states of events and processing by the Gateway
service:
|
last_processed_event |
Details of the last event that was processed by the Gateway service, helping to provide a timeline of when the last event was processed, and some statistics about how long ago it was and how long the processing took. |
last_sent_event |
Details of the last event that was sent to the gateway service |
number_of_outstanding_sent_events |
The number of events that have been sent but not yet processed by the Gateway service. |
number_of_outstanding_queued_events |
The number of events that have been queued but not yet sent to the Gateway service. |
gateway_processing_status:
service_up_to_date: false
service_state: green
last_processed_event:
event_id: 40e1a564-2aea-429b-9d35-f588218688a1
title: None provided
processed_at: '2020-06-02 22:40:04.671+00'
generated_at: '2020-06-02 22:39:33.856769+00'
filter: product_replace
event_processing_time: 24526
elapsed_time_since_last_processed_event: 13682
last_sent_event:
event_id: 3bb52860-29f8-41a9-93d0-c9465a0a30e0
title: None provided
sent_at: '2020-06-02T22:40:15.820Z'
generated_at: '2020-06-02 22:40:12.980079+00'
number_of_outstanding_sent_events: 9
number_of_outstanding_queued_events: 0
events:
sent_events:
- title: >-
Update Product (name-version:lts-cat0-product-14:1.0.0, id:
0df5bf4b-6706-4c36-aa0c-9c8ba2f15254) by user shavon0
filter: product_update
generated_at: '2020-06-02 22:39:45.430744+00'
- title: >-
Update Product (name-version:lts-cat0-product-64:1.0.0, id:
4795106e-787d-41e6-bb94-9e6506719529) by user shavon0
filter: product_lifecycle
generated_at: '2020-06-02 22:39:46.11499+00'
- title: None provided
filter: product_replace
generated_at: '2020-06-02 22:39:46.862433+00'
- title: >-
Update Product (name-version:lts-cat0-product-15:1.0.0, id:
6c7bf5ef-dca4-4b63-8060-2cc3c4d91d3b) by user shavon0
filter: product_update
generated_at: '2020-06-02 22:39:58.397278+00'
- title: >-
Update Product (name-version:lts-cat0-product-65:1.0.0, id:
4019df05-27a6-4ac2-83c8-6dd5da100105) by user shavon0
filter: product_lifecycle
generated_at: '2020-06-02 22:39:59.02833+00'
- title: None provided
filter: product_replace
generated_at: '2020-06-02 22:39:59.740152+00'
- title: >-
Update Product (name-version:lts-cat0-product-16:1.0.0, id:
4435a953-3c8d-4814-ada8-c71409cabcaf) by user shavon0
filter: product_update
generated_at: '2020-06-02 22:40:11.571056+00'
- title: >-
Update Product (name-version:lts-cat0-product-66:1.0.0, id:
fb9239d5-6064-4500-9a7b-63b841f5321a) by user shavon0
filter: product_lifecycle
generated_at: '2020-06-02 22:40:12.199838+00'
- title: None provided
filter: product_replace
generated_at: '2020-06-02 22:40:12.980079+00'
queued_events: []
The following example shows a "red" response:
gateway_processing_status:
service_up_to_date: false
service_state: red
last_processed_event:
event_id: 07387d98-dbfc-494b-af12-d7db91208e4c
title: >-
Update Product (name-version:lts-cat0-product-49:1.0.0, id:
25eba540-0cb1-4808-be3d-f22f65540cb2) by user shavon0
processed_at: '2020-06-02 22:32:10.838+00'
generated_at: '2020-06-02 22:31:43.38615+00'
filter: product_del
event_processing_time: 22597
elapsed_time_since_last_processed_event: 18427
last_sent_event:
event_id: 93d0bf8f-ebfb-4a8b-aa22-7f805719d5c8
title: >-
Update Product (name-version:lts-cat0-product-11:1.0.0, id:
d0bf799f-7f3a-4546-b267-a85c6a7f4b10) by user shavon0
sent_at: '2020-06-02 22:32:28.426+00'
generated_at: '2020-06-02 22:32:25.505109+00'
number_of_outstanding_sent_events: 37
number_of_outstanding_queued_events: 1
The result includes events that were not processed yet, as well as the last event processed. If a particular event is not listed as Sent or Queued, then that event was already processed.
Procedure
To obtain processing status information for a Gateway service, complete the following steps: