APIM manage workflow with multiple roles APIM 3.0.0 per API based subscription workflow Logging internal HTTP requests Log APIM analytics events to a file Monetization and sample with WSO2 API Manager 2.6.0 Share application and subscription among a set of specific groups or roles WSO2 APIM Correlating analytics event with correlationID APIM analytics distinguish production and sandbox traffic APIM 2.x.x analytics internal and analytics tuneup Configure APIM(Next release) Key Manager User stores APIM(Next release) working with key manager DAS 3.x Parse system variables to Spark Context Revoke OAuth application In APIM 2.1.0 Next WSO2 APIM powered by WSO2 Ballerina Configure WSO2 APIM Analytics on Cluster environment Configure WSO2 DAS 3.1.0 for WSO2 APIM 2.0.0 Analytics WSO2 APIM publishing custom statistics WSO2 APIM Error codes Working with WSO2 message tracer Use DAS admin service to query using Spark SQL Configure WSO2 APIM Analytics using XML WSO2 APIM Generating and Retrieving Custom Statistics Understanding WSO2 APIM Statistics Model Publishing WSO2 APIM 1.10.x Runtime Statistics to DAS with RDBMS Publishing_APIM_1100_Runtime_Statistics_to_DAS Aggregate functions with WSO2 DAS REST API Create a cApp for WSO2 DAS Debugging WSO2 Products using OSGI console. Publishing APIM Runtime Statistics to DAS Deploy cApp on WSO2 DAS How to configure and start the Accumulo minicluster How to setup DNS server on Ubuntu and Ubuntu server How to use Java Reflection how to install apache web server on ubuntu and ubuntu server How to install Mail server on Ubuntu and Ubuntu server How to install squirrelmail webmail client on Ubuntu and Ubuntu Server Pass and return String value to JNI method Pass and return numeric value to JNI method Calling a C Function from the Java Programming Language using JNI AXIS 2 Sample web service Client with maven and eclipse How to setup AXIS 2 with Apache Tomcat AXIS 2 Sample web service with maven and eclipse Robot framework Sample with Selenium Robot framework Custom Library Sample Behaviour-Driven Development with JBehave and Eclipse Play Audio with Netbeans and linking with LibVLC Implement LibVLC based player with QT-part2 Simple Audio playing sample with LibVLC How to install LibVLC on Ubuntu Implement LibVLC based player with QT-part1
WSO2 APIM Correlating analytics event with correlationID

Sometimes it is required to correlate request and response in the gateway messages. This is required if you try to debug, monitor and analyze the messages. But this feature is not supported APIM out of the box. But still, you can use the APIM extension point to extract required information to implement custom monitoring mechanism. Also, note that this CorrelationID is introduced to the event since APIM 2.2.0.

We can list down following use cases,

  1. Analyze request/response messages
  2. Analyze the request and fault, throttled requests
  3. Troubleshoot apim analytics
  4. Analyze the request path

correlationID is a UUID which is APIM introduced to the synapse context and it is unique to the complete API request path. Which mean a request come to gateway can identify with UUID and it not get changed and will be consistent whether it is faulty or throttled out. So it is easy to identify a request with its response path.

More importantly, which can be used to identify the message attributes like headers and payload. But this is not possible to analyze with Analytics since those are not publisher to the analyzer. In such cases, it is better to analyze with gateway itself using tools available in the synapse, like message ID, transaction ID or wire logs.

In order to analyze further with the analyzer, correlationID is published to the analyzer. it is included into the all gateway to analyzer events. Unfortunately, this feature is not used any out of the box dashboards. But this is very useful if you have an idea to implement custom dashboards with a cumulative analytics event.

Here the sample request analytics event gateway publishes to the analyzer. correlationID is include in the meta_clientType attribute as a JSON. And all other event used the same format to include correlationID.

 
    meta_clientType: {"keyType":"SANDBOX","correlationID":"97e758f7-0ac0-4cbc-aa0a-84a4fe9f96f1"},
    consumerKey:ivhMcN6YdASfwFIpfhvQjps2jbMa,
    context:/pizzashack/1.0.0,
    api_version:admin--PizzaShackAPI:v1.0.0,
    api:PizzaShackAPI,
    resourcePath:/menu,
    resourceTemplate:/menu,
    method:GET,
    version:1.0.0,
    request:1,
    requestTime:1526717879778,
    userId:admin@carbon.super,
    tenantDomain:carbon.super,
    hostName:192.168.56.1,
    apiPublisher:admin,
    applicationName:DefaultApplication,
    applicationId:1,
    userAgent:curl/7.47.0,
    tier:Unlimited,
    throttledOut:false,
    clientIp:192.168.56.1,
    applicationOwner:admin

Add Comment

* Required information
1000
Powered by Commentics

Comments (0)

No comments yet. Be the first!