Statistics logged

To monitor the performance of the integration process when integrating with other applications by using IBM Data Exchange (ODX), Sterling™ Order Management System Software publishes certain metrics to the existing Statistics framework.

Statistics for transactional events

For each of the transactional events such as orderCreated, orderModified or orderShipped, when messages are posted to a JMS queue, the following statistics are logged with default context parameters of the respective API.
  • UBXNumOrderCreatedEvent
  • UBXNumOrderModifiedEvent
  • UBXNumOrderShippedEvent
When the integration server invokes the service to publish to ODX, the following statistics are logged when each event is published. These statistics are logged for custom context type and service type. The details are as follows:
  • ServiceType = 'HTTP'
  • ServiceName = default (It is PublishUBXEvent)
  • ContextName = different for each event.
  • When the orderCreated event is published, statistics are logged with PublishUBXEvent as the service name and UBXEventPublish_OrderCreated as the context name.
  • When the orderModified event is published, statistics are logged with PublishUBXEvent as the service name and UBXEventPublish_OrderModified as the context name.
  • When the orderShipped event is published, statistics are logged with PublishUBXEvent as the service name and UBXEventPublish_OrderShipped as the context name.
Statistics published
  • UBXNumEventPublishSuccess: Count of successful publishing to ODX.
  • UBXNumEventPublishFailed: Count of failures while publishing to ODX.
  • Invocations: Count of the ODX event publish HTTP calls. For each event, this count is 1.
  • Min: The minimum response time observed during the configured time interval when ODX HTTP API is called.
  • Max: The maximum response time observed during the configured time interval when ODX HTTP API is called.
  • Average: The average response time observed during the configured time interval when ODX HTTP API is called.
Note: Since the response time is logged, aggregation is performed and the Min/Max/Average times is also published.

The Success or Failed attribute count logged for each API event is based on the response code of 200 or non-200 as applicable.

Statistics for non-transactional events

For the events published by the Data Publish agent for Configuration or Master data, the following statistics are logged when the getJobs creates execute messages. These are count statistic attributes for the number of entity records picked up in the batch by getJobs.
  • UBXNumProductSyncRecordsProcessed
  • UBXNumShipNodeSyncRecordsProcessed
  • UBXNumEnterpriseSyncRecordsProcessed
Additionally the service invoked by the agent to publish ODX event message for each entity type publishes the following statistic attributes. These statistics are logged for custom context type and service type. The details are as follows:
  • ServiceType = 'HTTP'
  • ServiceName = default (It is PublishUBXEvent)
  • ContextName = different for each event.
  • When the enterpriseSync event is published, statistics are logged with PublishUBXEvent as the service name and UBXEventPublish_EnterpriseSync as the context name.
  • When the productSync event is published, statistics are logged with PublishUBXEvent as the service name and UBXEventPublish_ProductSync as the context name.
  • When the shipNodeSync event is published, statistics are logged with PublishUBXEvent as the service name and UBXEventPublish_NodeSync as the context name.
Statistics published
  • UBXNumEventPublishSuccess: Count of successful publishing to ODX.
  • UBXNumEventPublishFailed: Count of failures while publishing to ODX.
  • Invocations: Count of the ODX event publish HTTP calls. At each invocation, the count is the number of batch events contained in the compound batch.
  • Min: The minimum response time observed during the configured time interval when ODX HTTP API is called.
  • Max: The maximum response time observed during the configured time interval when ODX HTTP API is called.
  • Average: The average response time observed during the configured time interval when ODX HTTP API is called.
Notes:
  • Since the response time is logged, aggregation is performed and the Min/Max/Average times is also published.
  • The Success or Failed attribute count logged for each API event is based on the response code of 200 or non-200 as applicable.
  • The HTTP related statistics are logged for every HTTP call made whether it is successful or not.

For more details about statistics logging in Sterling Order Management System Software, refer Statistics.