Petals Distribution

Improve the identification of the service endpoint initiating a timeout

Details

  • Type: Improvement Request Improvement Request
  • Status: In Progress In Progress
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: 5.2.0, CP-5.2.0
  • Fix Version/s: 5.2.1, CP-5.2.1, 5.3.1, CP-5.3.1
  • Component/s: Components
  • Security Level: Public
  • Description:
    Hide

    When a timeout occurs it could be difficult to identify which service endpoint is too slow and initiates a timeout without enabling fine log traces.

    With a log configuration limited to level 'INFO', we have following traces:

    • at level 'MONIT': it is a trace explaining why the processing fails without identifying the service endpoint initiating the timeout 
      petals-05-node-1 2022/11/16 09:47:40,838 GMT+0100 MONIT [Petals.Container.Components.petals-se-camel.su-camel-bordereau-provide-1.2] :  traceCode = 'provideFlowStepFailure', flowInstanceId = '2d0ed640-658b-11ed-b338-005056a2c4e5', flowStepId = '2da83010-658b-11ed-b338-005056a2c4e5', failureMessage = 'A timeout happened while Camel sent an exchange to a JBI service', dumpFile = './flow-monitoring/2d0ed640-658b-11ed-b338-005056a2c4e5/2da83010-658b-11ed-b338-005056a2c4e5_provideFlowStepFailure.log'
    • at level 'WARNING': traces are component-dependent

    For all components, please add a trace with level 'WARNING', identifying clearly the invoked service operation and the flow step associated to service consumer, as following:

    2024/02/27 16:53:05,389 GMT+0100 WARNING [org.ow2.petals.component.framework.UnderTestWithDefaultConf] : A timeout expired (10000 ms) sending a message to a service provider ({http://petals.ow2.org/se-flowable/unit-test/timeout-on-service/archivageService}archiver|{http://petals.ow2.org/se-flowable/unit-test/timeout-on-service/archivageService}archiverService|edpArchiver|{http://petals.ow2.org/se-flowable/unit-test/timeout-on-service/archivageService}archiverShortSync) in the context of the flow step '41c656d0-d588-11ee-96b8-024200dc0afc/41c656d1-d588-11ee-96b8-024200dc0afc'

    For each binding component providing service consumer, update the failure trace with level 'MONIT' to identify clearly the invoked service operation and the flow step associated to service consumer, as following:

    2024/02/28 12:19:19,512 GMT+0100 MONIT [org.ow2.petals.component.framework.UnderTestWithDefaultConf] :  traceCode = 'consumeExtFlowStepFailure', flowInstanceId = '333a4a60-d62b-11ee-9e2e-024200dc0afc', flowStepId = '333a4a61-d62b-11ee-9e2e-024200dc0afc', failureMessage = 'A timeout expired (5000 ms) sending a message to a service provider ({http://testProvideService}testProvideInterfaceName|{http://testProvideService}testServiceName|testEndpointName|{http://petals.ow2.org/components/filetransfer/version-5}put) in the context of the flow step '333a4a60-d62b-11ee-9e2e-024200dc0afc/333a4a61-d62b-11ee-9e2e-024200dc0afc''

    For each service engine invoking service consumer, improve the error message returned to its service consume to identify clearly the invoked service operation and the flow step associated to service consumer, as following:

    A timeout expired (5000 ms) sending a message to a service provider ({http://testProvideService}testProvideInterfaceName|{http://testProvideService}testServiceName|testEndpointName|{http://petals.ow2.org/components/filetransfer/version-5}put) in the context of the flow step '333a4a60-d62b-11ee-9e2e-024200dc0afc/333a4a61-d62b-11ee-9e2e-024200dc0afc'
    Show
    When a timeout occurs it could be difficult to identify which service endpoint is too slow and initiates a timeout without enabling fine log traces. With a log configuration limited to level 'INFO', we have following traces:
    • at level 'MONIT': it is a trace explaining why the processing fails without identifying the service endpoint initiating the timeout 
      petals-05-node-1 2022/11/16 09:47:40,838 GMT+0100 MONIT [Petals.Container.Components.petals-se-camel.su-camel-bordereau-provide-1.2] :  traceCode = 'provideFlowStepFailure', flowInstanceId = '2d0ed640-658b-11ed-b338-005056a2c4e5', flowStepId = '2da83010-658b-11ed-b338-005056a2c4e5', failureMessage = 'A timeout happened while Camel sent an exchange to a JBI service', dumpFile = './flow-monitoring/2d0ed640-658b-11ed-b338-005056a2c4e5/2da83010-658b-11ed-b338-005056a2c4e5_provideFlowStepFailure.log'
    • at level 'WARNING': traces are component-dependent
    For all components, please add a trace with level 'WARNING', identifying clearly the invoked service operation and the flow step associated to service consumer, as following: 
    2024/02/27 16:53:05,389 GMT+0100 WARNING [org.ow2.petals.component.framework.UnderTestWithDefaultConf] : A timeout expired (10000 ms) sending a message to a service provider ({http://petals.ow2.org/se-flowable/unit-test/timeout-on-service/archivageService}archiver|{http://petals.ow2.org/se-flowable/unit-test/timeout-on-service/archivageService}archiverService|edpArchiver|{http://petals.ow2.org/se-flowable/unit-test/timeout-on-service/archivageService}archiverShortSync) in the context of the flow step '41c656d0-d588-11ee-96b8-024200dc0afc/41c656d1-d588-11ee-96b8-024200dc0afc'
    For each binding component providing service consumer, update the failure trace with level 'MONIT' to identify clearly the invoked service operation and the flow step associated to service consumer, as following: 
    2024/02/28 12:19:19,512 GMT+0100 MONIT [org.ow2.petals.component.framework.UnderTestWithDefaultConf] :  traceCode = 'consumeExtFlowStepFailure', flowInstanceId = '333a4a60-d62b-11ee-9e2e-024200dc0afc', flowStepId = '333a4a61-d62b-11ee-9e2e-024200dc0afc', failureMessage = 'A timeout expired (5000 ms) sending a message to a service provider ({http://testProvideService}testProvideInterfaceName|{http://testProvideService}testServiceName|testEndpointName|{http://petals.ow2.org/components/filetransfer/version-5}put) in the context of the flow step '333a4a60-d62b-11ee-9e2e-024200dc0afc/333a4a61-d62b-11ee-9e2e-024200dc0afc''
    For each service engine invoking service consumer, improve the error message returned to its service consume to identify clearly the invoked service operation and the flow step associated to service consumer, as following: 
    A timeout expired (5000 ms) sending a message to a service provider ({http://testProvideService}testProvideInterfaceName|{http://testProvideService}testServiceName|testEndpointName|{http://petals.ow2.org/components/filetransfer/version-5}put) in the context of the flow step '333a4a60-d62b-11ee-9e2e-024200dc0afc/333a4a61-d62b-11ee-9e2e-024200dc0afc'
  • Environment:
    -

Issue Links

Depends
 

Activity

People

Dates

  • Created:
    Wed, 28 Feb 2024 - 11:07:30 +0100
    Updated:
    Fri, 15 Mar 2024 - 17:55:00 +0100
Atlassian JIRA (v4.1.2#531) | Report a problem | Request a feature | Contact administrators
Powered by a free Atlassian JIRA open source license for Petals ESB. Try JIRA - bug tracking software for your team.