API Connect

 View Only
  • 1.  Email Notification and Error Logging

    Posted Mon May 01, 2023 01:28 PM

    Hi ,

    currently I am working on some POC.

    I need to create some custom module for some functionality.

    So I am checking how to implement this or does APIC 10 provides this out of box

    1. Sending error details/message to Splunk. I see this Planning to offload data to a third-party system , is this where it provides info to connect to Splunk

    Ibm remove preview
    Planning to offload data to a third-party system
    Considerations for offloading data from your IBM API Connect analytics deployment to a third-party system.
    View this on Ibm >

     
    Or do I have to create some custom module to connect to Splunk 

    2. Sending email also for certain error message. Do I have to create custom email module to send email for certain scenario like lets say there was some failure in that custom module that I created and during that handling of that error I also want to log to Splunk and send email with those error message with other details.




    ------------------------------
    Syed Imtiyaz Alam
    ------------------------------


  • 2.  RE: Email Notification and Error Logging

    IBM Champion
    Posted Tue May 02, 2023 06:56 AM

    Hi Syed,

    it all depends on you requirements, but for offloading to splunk start indeed with https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=topology-planning-offload-data-third-party-system to see if it meets your requirements.

    For sending mails, I would recommend that you manage that outside APIC/DP, but if needed you can user either Datapower Log Targets or configure it via XSLT (or gwscript calling an XSLT).



    ------------------------------
    Jeroen Willems
    Integration Architect - Managing Partner
    Integration Designers
    ------------------------------



  • 3.  RE: Email Notification and Error Logging

    Posted Tue May 02, 2023 08:34 PM

    Thank you Jeroen, So if I understand correctly , the logs will be visible to the APIC DataPower gateway and I can setup some log targets for those and handle it to send email.



    ------------------------------
    Syed Imtiyaz Alam
    ------------------------------



  • 4.  RE: Email Notification and Error Logging

    Posted Wed May 03, 2023 06:34 AM

    Hi my statement about bottlenecks only applies to the gateway when handling API traffic.

    If you have GWS generating a log message which is then handled by a log target & sent to splunk then that is very fast.

    If you have a GWS/XSLT that is using url-open to send multiple smtp log messages per api call then that is much slower.



    ------------------------------
    Matthias Siebler
    MA
    ------------------------------



  • 5.  RE: Email Notification and Error Logging

    Posted Tue May 02, 2023 05:25 PM

    Use IBM DataPower Operations Dashboard to monitor APIC transactions, troubleshoot errors and latency issues and get alerted via email.

    Quick overview video here: https://montier.atlassian.net/wiki/spaces/DpodDocumentation/overview



    ------------------------------
    Amit Munwes
    ------------------------------



  • 6.  RE: Email Notification and Error Logging

    Posted Tue May 02, 2023 08:31 PM

    Thank you Amit, but I am more looking for a suggestions related to sys logs that internally happens lets says during APP creation if anything fails then I want to send email to the user with error details etc. and as well as send the error details to Splunk.

    And currently I am working in creating some custom module for which I am trying to understand and gather some direction/suggestion for implementing error scenarios.



    ------------------------------
    Syed Imtiyaz Alam
    ------------------------------



  • 7.  RE: Email Notification and Error Logging

    Posted Tue May 02, 2023 06:15 PM

    Hi Syed, FYI for offbox logging; while Splunk integration w/ APIC is very high scale, email not as much; so take care when designing your solution, whether you use a log target or a gws/xslt, so that the log messages subscribed by the email log target & rate limit are set so that is does not become a bottleneck.



    ------------------------------
    Matthias Siebler
    MA
    ------------------------------



  • 8.  RE: Email Notification and Error Logging

    Posted Tue May 02, 2023 08:38 PM

    Could you please elaborate on the bottleneck issue ?

    And please help me understand this creating custom email module for implement hook_email , is there any issue using this ?

    Initially my ask was to check if APIC itself provides some email notification based on the error logs then I don't have to implement. I am asking similar to the notification lets says email is sent when they subscribe to Product etc.



    ------------------------------
    Syed Imtiyaz Alam
    ------------------------------