Oracle Cloud Infrastructure Documentation

Monitor OIC Integrations with APM

You can monitor Oracle Integration Cloud (OIC) integrations with Application Performance Monitoring (APM) by connecting an OIC activity stream log to the APM Log Sender pre-built Function and moving service logs to an APM Domain. For details, see APM Log Sender Function.

Application Performance Monitoring can be used to monitor Oracle Integration 3 instances.
Note

Oracle Integration 2 instances are not supported.

Configuration

Follow these steps to configure monitoring of an Integration instance by an APM Domain:

  1. Capture the integration's activity stream in a Log instance. Follow the steps outlined in Capture the Activity Stream of Integrations in the Oracle Cloud Infrastructure Console.
  2. Create an instance of the APM Log Sender function from the pre-built Functions catalog and point it to the APM Domain that will monitor the Integration. For details, follow the instructions in the APM Log Sender Function documentation.
  3. Connect the Log of step 1 to the Function of step 2 by creating a Connector in the Connector Hub.

    To create a connector, follow the instructions below:

    • Open the navigation menu and click Analytics and AI. Under Messaging click Connector Hub.
    • Click the Create connector button.
    • Enter a name and optional description.
    • Select a compartment.
    • Under Configure connector set the Source to Logging, and the Target to Functions.
    • Under Configure source select the Log Group and Logs to the Activity Stream log that was configured in step 1.
    • Under Configure target set the Function application and Function to the Function that was created in step 2.
    • Note: Do not configure a Task.
    • Click the Create button.
    • You should now have a connector:
  4. Connector policies.

    The following policies are automatically created when creating the Connector:

    • Allow any-user to use fn-function in compartment id <target_function_compartment_ocid> where all
{request.principal.type='serviceconnector', request.principal.compartment.id='<serviceconnector_compartment_ocid>'}
    • Allow any-user to use fn-invocation in compartment id <target_function_compartment_ocid> where all
 {request.principal.type='serviceconnector', request.principal.compartment.id='<serviceconnector_compartment_ocid>'}

Span Attributes

A list of attributes for OIC spans is provided in the following table. This table includes:

  • Name: Name of the attribute.
  • Description: Brief description of the attribute.
  • Type: Type of attribute: Dimension or Metric.
They may not be immediately recorded for OIC spans. You can add them manually in the APM Domain configuration, or enable auto-activation if that's the case.
Name Description Type
ActionName A name for the action, often the one that was configured in the OIC integration. Dimension
ActionType A one-word classifier for the OIC operation that the span represents. For instance Switch, Mapper or Notification. Dimension
AuditMessage Additional message text when the OIC application runs in debug or audit mode. Dimension
EndpointConnectionId The id of the endpoint that is invoked. Dimension
EndpointName The name of the endpoint that is invoked. Dimension
EndpointType The kind of endpoint that is invoked (rest, atpdatabase, ...). Dimension
InstanceCompletionState Set for the end-of-flow span, indicating whether the flow completed successfully. Dimension
IntegrationId The OCID of the OIC integration. Dimension
IntegrationVersion The version number of the OIC integration. Dimension
Key The key of a tracking event. Also see Value. Dimension
Message The message that the OIC Activity Stream logged for the operation. Dimension
OpcRequestId The opc-request-id of the OIC integration flow. Dimension
ProjectCode The OIC project code. Dimension
RecordType Set on certain important spans indicating the kind of action that the span represents. You can filter on the presence of this field to reduce the noise from less important spans. Dimension
UserId The user that created the OIC integration. Dimension
Value The value of a tracking event. Also see Key. Dimension
EventId The OIC event ID Dimension
ParentEventId The ID of the previous event in the Activity stream. Dimension
InstanceId The OIC flow ID Dimension
ParentInstanceId The OIC flow ID of the parent flow Dimension
ParentFlowParentEventId The OIC event ID of the parent event in the parent flow. Dimension

Use APM Trace Explore for Monitoring

Once you completed all the configuration steps, the traces are visible in Trace Explorer under the APM Domain that was configured for the APM Log Sender function.