WSO2 APIM | Sequence to print throttlling messages

-

Hi everyone, I will be sharing my another experience with the WSO2 API Manager sample use case for API throttling.

Scenario
So I had a situation encountered where I have to see the throttling messages in my wso2carbon.log file. By default, it has not been enabled and we have to make some changes to see the required output in the wso2carbon log file.
 
API Manager Version 3.2.0

Changes done

WSO2 Sequence to print throttling messages in wso2carbon.log file

  1. Navigate to <APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences directory.
  2. Open the file named _throttle_out_handler_.xml.
  3. Update the contents of file _throttle_out_handler_.xml as per the below custom changes

<sequence name="_throttle_out_handler_" xmlns="http://ws.apache.org/ns/synapse">    
    <property name="X-JWT-Assertion" scope="transport" action="remove"/>
    <class name="org.wso2.carbon.apimgt.gateway.handlers.analytics.APIMgtThrottleUsageHandler"/>
    <sequence key="_cors_request_handler_"/>
</sequence>
<!-- Custom sequence added starts -->
<sequence name="_throttle_out_handler_" xmlns="http://ws.apache.org/ns/synapse">    
    <property name="X-JWT-Assertion" scope="transport" action="remove"/>
    <class name="org.wso2.carbon.apimgt.usage.publisher.APIMgtThrottleUsageHandler"/>
    <sequence key="_cors_request_handler_"/>
    <log level="custom">
    <property name="API_NAME:VERSION" expression="get-property('api.ut.api_version')"/>
    <property name="USER_NAME" expression="get-property('api.ut.userName')"/>
    <property name="APPLICATION_NAME" expression="get-property('api.ut.application.name')"/>
    <property name="THROTTLED_OUT_REASON" expression="get-property('THROTTLED_OUT_REASON')"/>
       <property name="NEXT_ACCESS_UTC_TIME" expression="get-property('NEXT_ACCESS_UTC_TIME')"/>
    </log>
<!-- Custom sequence added ends -->     
</sequence>

 

[2022-02-28 12:10:13,409]  INFO - LogMediator API_NAME:VERSION = PizzaShackAPI:v1.0.0, USER_NAME = admin@carbon.super, APPLICATION_NAME = DefaultApplication, THROTTLED_OUT_REASON = APPLICATION_LIMIT_EXCEEDED, NEXT_ACCESS_UTC_TIME = 2022-Feb-11 12:15:00+0000 UTC 

This log message indicates that the Application Quota has been exhausted i.e. let's say we have provided the quota for Default Application as 10 Req/Min; so if the API subscribed to this application has been called more than 10 times within a minute, the request is throttled out and the API consumer will get HTTP 429 error (too many requests). 

 

Comments

  1. bhanuOctober 7, 2022 at 6:07 PM

    This comment has been removed by a blog administrator.

    ReplyDelete

Post a Comment

Popular posts from this blog

Oracle SOA Suite- Implementing Email Notification

-
Image
In this post, I am going to show how to implement email notifications in Oracle SOA Suite using BPEL process. So let's get started- Implementing email notification in Oracle SOA Suite consists of below steps: Environment- IDE- Oracle jDeveloper 11g Weblogic Server 12c Oracle SOA Suite 12c High Level Steps Keep ready email server settings. Configure & enable usermessagingdriver-email for target SOA servers via console. Setting up Email driver (usermessagingdriver-email )with email server settings via enterprise manager. Enable notifications for SOA workflows(make sure either All or EMail option is selected).. Create SOA composite application Deploy it on SOA server. Testing & done. 1. Keep ready email server settings. Keep ready your below email server settings: Outgoing Mail Server          : smtp.domain.com Outgoing Mail Server Port   : xxx Default From Address         : username@doamin...
Read more

Oracle SOA Suite 12c- PKIX path building failed & unable to find valid certification path to requested target

-
Image
Hi Everyone, in this blog I'll be writing one of the strange issue that has been encountered while working with a Oracle SOA composite running in Oracle IDAM environment and trying to invoke a SSL based remote service where SSL certification based exception has been thrown during the service invocation. Environment Oracle SOA Suite 12c  (HA Mode) Oracle IDAM 12c (HA Mode) Oracle Linux 7 External Web Service (SOAP Service) Problem Below is the exception thrown when trying to invoke an external webservice (SSL Based) via BPEL process- <bpelFault><faultType>0</faultType><remoteFault xmlns="http://schemas.oracle.com/bpel/extension"><part name="summary"><summary>oracle.fabric.common.FabricInvocationException: Unable to invoke endpoint URI "https://idam.uppclonline.com/soa-infra/services/default/DefaultOperationalApproval!5.12*soa_69e4734b-d8fe-4edf-b44e-e287f61c2ddf/SMSNotification%23ApprovalProcess/SMSNotification" succe...
Read more

Migration of Oracle SOA Suite Composite from 11g to 12c

-
Image
Recently I have came across a scenario where I have a business requirement of  migration of Oracle SOA Suite 11g(11.1.1.7.0) to 12c(12.1.3.0). Below are the different mechanisms I have tried to do, few of them failed and one succeeded. Working in Oracle SOA Suite 11g is completely different from 12c. In 11g, we need to install the jDeveloper(11.1.1.7) then SOA extension separately to be installed either via offline file  (download available at  https://www.oracle.com/ocom/groups/public/@otn/documents/webcontent/156082.xml ) or through jDeveloper top menu >>  Help >> Check for Updates >> SOA Extension.  While working with 12c doesn't involves such tedious job. Only single installer is required for jDeveloper/SOA/Weblogic and is available as QuickStart Installer(download available at https://www.oracle.com/technetwork/middleware/soasuite/downloads/index.html). Approach 1- Compress(Zip) SOA composite ...
Read more