Troubleshooting issues when sending notification to an external application by using AR System webhook


When you register the AR System webhook, you might face issues when sending notifications to the external application. 

Use the following guidelines to troubleshoot the issue or create a BMC Support case.

Related topic

Symptom

  • The external application is not reachable.
  • The HTTP connection has timed out.
  • The webhook payload size limit set is not working as intended.
  • Gzip compression is not working as intended.

Scope

In a server group environment, this might impact one or more servers.

Resolution

Perform the following steps to troubleshoot the issues that may occur when sending notifications to an external application:

Step

Task

Description

1

Troubleshooting when the external application is not reachable

When AR System server runs the webhook, the server stores the records in the AR System Webhook Pending form. The following screenshot shows the AR System Webhook Pending form:

WebhookPending_4thMarch.jpg

The pending records are not processed if the external application is not reachable. 

  • The  Webhook-Callback-Retry-Interval parameter in the Centralized Configuration enables you to set the interval for processing the pending records. 
    The default value is 5 minutes.
  • The  Webhook-Callback-Max-Retries  parameter in the Centralized Configuration enables you to set the maximum number of attempts to retry the processing of pending records.
    The default value is 288 times.

On the AR System Webhook pending form, check the Error Details field:

  • When the external application is not available, the  Error Details  field shows the following information:
    • java.net.ConnectException
    • javax.ws.rs.ServiceUnavailableException
    • HTTP 503 Service Unavailable
  • When the HTTP connection timeout occurs, the  Error Details  field shows the following exception:
    java.net.SocketTimeoutException
    You can set the connection timeout by using the Outbound-Http-Client-Read-Timeout parameter in the Centralized Configuration.
    The default value is 60 seconds.
  • When any other error occurs, the AR System server moves the records from the AR System Webhook Pending form to the AR System Webhook Pending Error form. The following screenshot shows the AR System Webhook Pending Error form:
    WebhookPendingError_4thMarch.jpg
    You can search the record and check the exact error in the Error Details field.

2

Enabling additional logging

The log displays details such as Transaction ID and other system activities. You can enable additional logging by performing the following steps:

  1. Edit the logback_server.xml file by using ConfigMaps.
    For more information, see the topic Using ConfigMaps to access the configuration files.
  2. In the logback_server.xml file, change the log level to DEBUG
    Refer to the following example:

    </logger>  
    <logger
    name="com.bmc.arsys.server.domain.ebo.webhook.impl.WebhookPendingServiceImpl"
    level="debug" additivity="false">     
    <appender-ref ref="WebhookLog"></appender-ref>  
    </logger>  
    <logger
    name="com.bmc.arsys.server.thread.webhook.WebhookCallbackThreadLocalStorage"
    level="debug" additivity="false">     
    <appender-ref ref="WebhookLog"></appender-ref>  
    </logger> 

                    

                  

  3. In a browser, open the AR System Administration Console, and click System > General > Server Information.
    The AR System Administration: Server Information form appears.
  4. Click the Log Files tab.
  5. Select the Reload Log Conf File check box:Xml2.png
  6. Click Apply, and then click OK .

The log level is updated.

AR System server stores the AR System webhook logs in the  arwbhk.log  file located in the  <Install Directory>\BMC Software\ARSystem\Arserver\Db  folder.

3

The set webhook payload size limit is not working as expected.

Contact BMC Support to check whether the capability to set the webhook payload size limit has been enabled.

4

Gzip compression is not working as intended.

Confirm that the external application receiving the data also supports Gzip.

5

Creating a BMC Support Case

Collect and send logs and detailed information when creating a case with BMC Support:

  1. Provide the following information as part of your case:
    • Name of the user who performed the search
    • The search criteria used
    • Time when the problem occurred
    • Any error message received
  2. Run the Viewing-and-collecting-logs-by-using-the-Support-Assistant-tool
  3. Attach the zip file to your case. You can attach the zip file up to 2 GB. You can also upload the files on FTP.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*