View Message Metrics and Billable Messages

View and analyze message data, processing and invocation times, adapter requests, and configured and consumed messages on the Metrics page. Use the data to monitor resources associated with Oracle Integration and the applications that you integrate with Oracle Integration.

Monitoring helps you detect anomalies and bottlenecks occurring within the Oracle Integration instances and connected applications. Actively and passively monitor cloud resources using the metrics and alarms features of the Oracle Cloud Infrastructure Monitoring, available with Oracle Integration. See Monitoring Overview in the Oracle Cloud Infrastructure documentation.

View the Monitoring Charts

  1. Ensure you have permission to view message metrics for the compartment.
    • If you are an administrator with manage access, you can automatically view message metrics for the compartment. For manage access, you must be part of an Oracle Cloud Infrastructure group assigned a manage policy.
    • If you are an administrator with read only access, you must be part of an Oracle Cloud Infrastructure group assigned a read metrics policy.

    For example:

    • Syntax: allow group group_name to verb resource-type in compartment compartment-name
    • Policy: allow group oci-integration-admins to read metrics in compartment OICPMCompartment

    See Set Up Users, Groups, and Policies.

  2. Open the navigation menu and click Developer Services. Under Application Integration, click Integration.
  3. Select an instance in the Oracle Cloud Infrastructure Console.

    A Metrics section shows graphs with default values.


    Description of oci_monitoring_metrics.bmp follows

Modify the Charts and Create Custom Charts

You can change the metrics that appear in each chart. Additionally, you can create custom charts to further analyze your data. For instance, imagine you created two compartments for your organization, one for your engineering team and another for your finance team. Using custom charts, you can measure the resources that each compartment has used and determine whether you purchased an appropriate number of message packs.

  1. Change the message metrics displayed for each chart, if needed.

    Start Time and End Time are selected at the top of each chart. Change these values to select a different time period.

    Metric counts occur every five minutes.

  2. To change the metrics displayed, change the Interval and Statistic fields for each chart.
  3. To create custom dashboards and alerts, or to see data for all instances in a compartment: In the top right of a chart, from the Options drop-down list, select View Query in Metrics Explorer. For more information, see Viewing Default Metric Charts.

About the Charts

Chart Description

Received messages

Shows the message requests that the instance received.

Successful messages

Shows the message requests that completed successfully.

Failed messages

Shows the message requests that did not complete successfully for the instance.

Inbound request processing time

Shows adapter inbound processing times for the instance.

Outbound request invocation time

Shows adapter outbound message invocation times for the instance.

Inbound requests

Shows the number of adapter inbound requests for the instance.

Outbound requests

Shows the number of adapter outbound requests for the instance.

Consumed messages

Configured messages

These two charts show the following information:
  • Consumed messages: Shows the messages that the instance used.
  • Configured messages: Show the messages that you purchased.
Use this data to make informed decisions about the number of message packs to purchase for the instance.

The type of license you choose determines how message packs are defined and metered.

  • For Oracle Integration:
    • BYOL: For Bring Your Own License users, one message pack is defined as 20,000 messages per hour. You can select up to 3 message packs if you bring an existing Oracle Fusion Middleware license to the cloud.
    • Non-BYOL: For these license types, one message pack is defined as 5,000 messages per hour. You can select up to 12 message packs if you create a new Oracle Integration license in the cloud.

For details on how Integration billable messages are calculated, see About Integrations Usage.

Options for Configuring the Charts

You can configure and view metrics charts that show adapter inbound request processing times, outbound request invocation times, adapter inbound request numbers, and adapter outbound request numbers.

Endpoint metrics include the following dimensions that are available for selection in the Metrics Explorer.

Note

Each endpoint metric has its own dimensions. Not all dimensions are available on all endpoint metrics.
  • adapterIdentifier: Show data in the chart for a single adapter (internal name) that is used either as a trigger for receiving or as an invoke for sending the request to the external system.
  • account_subscription: Show data in the chart for a specific account type, such as a universal credit model (UCM) account.
  • flowCode: Show data in the chart for a specific integration in Oracle Integration.
  • flowVersion: Show data in the chart for a specific integration version, which you can specify at various times, including when you create or clone an integration.
  • inboundProcessingEndpointInformation: Show data in the chart for a specific functional request received from the client.
  • inboundProcessingResponseStatus: Show data in the chart for a specific status sent by the trigger to the external client.
  • instanceName: Show data in the chart for a specific instance. This value matches the name that an administrator specified when creating the instance as well as the URL of the instance. This value is a more user-friendly value than the resourceid.
  • meterType: Show data in the chart for a specific license type, such as BYOL or Cloud.
  • outboundInvocationEndpointInformation: Show data in the chart for a specific functional request made to the external system.
  • outboundInvocationResponseStatus: Show data in the chart for a specific status received from the external system.
  • integrationFlowIdentifier: Show data in the chart for the integration receiving an incoming request or sending an outgoing request. The dimension includes both the identifier and the version.
  • resourceid: Show data in the chart for a specific OCID of an integration instance. You can use this value to uniquely track the instance.

Tip:

To filter a chart by multiple metric dimensions, first select a dimension name and dimension value. Then, click Additional dimension and select another dimension name and value. Don't forget to click Update Chart after updating the query.

The metrics listed in the following tables are automatically available for selection for any instance you create.

The inboundProcessingEndpointInformation or outboundInvocationEndpointInformation dimension provides a concise summary of the adapter trigger or invoke configurations. For example, the inboundProcessingEndpointInformation dimension can look for ‘Receive Incident Created notification from ServiceNow’ for an integration that is triggered when an incident is created in the ServiceNow application. On the invoke side, the outboundInvocationEndpointInformation dimension can look for ‘Create Account in Salesforce.com’ if the invoke activity in the integration is configured to create an Account object in Salesforce.com.

The following table describes the available metrics and dimensions. The Commonly Used Statistics in Metrics Explorer column provides the following information.

  • Mean: Average processing time (latency) taken for incoming requests received during the time interval and average invocation time taken by outbound requests sent during the time interval.
  • Min: Minimum processing time (latency) taken for incoming requests received during the time interval and minimum invocation time taken by outbound requests sent during the time interval.
  • Max: Maximum invocation time taken by outbound requests sent during the time interval and maximum processing time (latency) taken for incoming requests received during the time interval.
  • P50: Maximum invocation time (latency) taken by 50% of outbound requests sent during the time interval and maximum processing time (latency) taken by 50% of incoming requests received during the time interval.
  • P90: Maximum invocation time (latency) taken by 90% of outbound requests sent during the time interval and maximum processing time (latency) taken by 90% of incoming requests received during the time interval.
  • P95: Maximum invocation time (latency) taken by 95% of outbound requests sent during the time interval and maximum processing time (latency) taken by 95% of incoming requests received during the time interval.
  • P99: Maximum invocation time (latency) taken by 99% of outbound requests sent during the time interval and maximum processing time (latency) taken by 99% of incoming requests received during the time interval.
  • Count: Total number of requests received during the time interval and total number of outbound requests made during the time interval.

Endpoint Metrics

Metric Name in Metrics Explorer Unit Description Dimension Name in Metrics Explorer Commonly Used Statistics in Metrics Explorer

ConfiguredMessages

count

Number of messages that were configured. This number determines billing.

  • account_subscription
  • instanceName
  • meterType
  • resourceId

Max

InboundRequestProcessingTime Duration in milliseconds

The time taken for processing inbound requests. In case of synchronous requests, it is the total time taken for processing a request and sending the response. In case of fire-and-forget inbound requests, it is the time taken to persist the request and send the acknowledgment.

This metric captures the time elapsed (in milliseconds) by the trigger in processing the incoming request.

  • adapterIdentifier
  • inboundProcessingEndpointInformation
  • inboundProcessingResponseStatus
  • integrationFlowIdentifier
  • resourceid

Mean

Min

Max

P95

P99

MessagesFailedCount

count

Number of messages that could not be processed. For example, a message can't be processed when an external endpoint that is used in an integration goes down.

  • flowCode
  • flowVersion
  • resourceId

Max

MessagesReceivedCount

count

Number of messages that were received. This count doesn't indicate whether the messages processed successfully.

  • flowCode
  • flowVersion
  • resourceId

Min

Max

MessagesSuccessfulCount

count

Number of messages that were processed successfully.

  • flowCode
  • flowVersion
  • resourceId

Min

Max

NumberofInboundRequests

count

Number of requests received by Oracle Integration using any adapter-specific trigger connection. This metric includes the HTTPs requests posted to Oracle Integration and the messages polled by adapters such as Oracle Advanced Queuing (AQ) Adapter, IBM MQ Series JMS Adapter, Apache Kafka Adapter, Oracle Database Adapter, and so on.

  • adapterIdentifier
  • inboundProcessingEndpointInformation
  • inboundProcessingResponseStatus
  • integrationFlowIdentifier
  • resourceid

Count

NumberOfOutboundRequests

count

Number of outbound requests sent by the adapter as part of the invoke activity in Oracle Integration.
  • adapterIdentifier
  • integrationFlowIdentifier
  • outboundProcessingEndpointInformation
  • outboundProcessingResponseStatus
  • resourceid

Count

OutboundRequestInvocationTime

Duration in milliseconds

Time (in milliseconds) spent by the adapter during the invocation of the target endpoint.

  • adapterIdentifier
  • integrationFlowIdentifier
  • outboundProcessingEndpointInformation
  • outboundProcessingResponseStatus
  • resourceid
  • Mean
  • Min
  • Max
  • P50
  • P90
  • P95
  • P99

How Adapters Map to Dimension Values

The following table describes how each adapter maps to its dimension value in the Metrics Explorer.

Dimension Value in Metrics Explorer Adapter Display Name Inbound Processing Event Information Naming Conventions in Dimension Value Field Outbound Invocation Endpoint Information Naming Conventions in Dimension Value Field
adobeesign Adobe Sign Adapter N/A
  • Retrieve status of agreement from Adobe eSign
  • Upload a document in Adobe eSign
  • Retrieve IDs of agreement from Adobe eSign
  • Retrieve URL of the document from Adobe eSign
adwdatabase Oracle Autonomous Data Warehouse Adapter
  • New row is inserted into <table name> in Oracle ADW
  • Insert rows into <table name> in Oracle ADW
  • Merge rows into < table name> in Oracle ADW
  • Update rows into <table name> in Oracle ADW
apachekafka Apache Kafka Adapter
  • Consume latest message from Topic: [TopicName=<Topic>,Partitions={<Partition>}] in Apache Kafka
  • Produce message(JSON) in Topic: [TopicName=<Topic>,Partitions={<Partition>}] using Apache Kafka
  • Consume latest message from Topic: [TopicName=<Topic>,Partitions={<Partition>}] in Apache Kafka
aq Oracle Advanced Queuing (AQ) Adapter
  • Consume <message type> message from Queue: <queue name> in Oracle Advanced Queueing (AQ)
  • Produce <message type> message in Queue: <queue name> using Oracle Advanced Queuing (AQ)

ariba SAP Ariba Adapter
  • Receive notification from <operation name> from Ariba
  • Create <business object> in SAP Ariba
  • Bulk upload for the task - <task name> <Data Mode: Master/Transactional, Operation Mode: Incremental/Full> in SAP Ariba
  • Bulk extract for the task - <task name> <Data Mode: Master/Transactional, Operation Mode: Incremental/Full> from SAP Ariba
atpdatabase Oracle Autonomous Transaction Processing Adapter
  • New row is inserted into <table name> in Oracle ATP
  • insert rows into <table name> in Oracle ATP
  • Merge rows into < table name> in Oracle ATP
  • Update rows into <table name> in Oracle ATP
box Box Adapter N/A N/A
concur SAP Concur Adapter NA
  • Create/Update/Delete/Retrieve <business object> in SAP Concur.
  • Extracts reports of available data objects in SAP Concur.
  • Manage payment batches and retrieve their batch files in SAP Concur.
  • Get status for the Job in Concur
  • Download file from Concur application
  • Bulk data extract request for AP/GL Extract V.3.04 submitted in Concur
cpq Oracle CPQ Adapter N/A N/A
database Oracle Database Adapter
  • New row is inserted into <table name> in Oracle Database
  • Insert rows into <table name> in Oracle Database
  • Merge rows into < table name> in Oracle Database
  • Update rows into <table name> in Oracle Database
dbaasdatabase Oracle Database Cloud Service Adapter
  • New row is inserted into <table name> in DBCS
  • Insert rows into <table name> in DBCS
  • Merge rows into < table name> in DBCS
  • Update rows into <table name> in DBCS
db2database IBM DB2 Adapter
  • New row is inserted into <table name> in DB2
  • Insert rows into <table name> in DB2
  • Merge rows into < table name> in DB2
  • Update rows into <table name> in DB2
docusign DocuSign Adapter N/A
  • Create and send an envelope in DocuSign
  • Send an envelope created from an existing template in DocuSign
  • Get status changes of an envelope from DocuSign
ebay eBay Marketplace Adapter N/A
  • Get Single Record: <Entity_NAME>s from eBay
  • Get List of Records: <Entity_NAME>s from eBay
  • Create a Record: <Entity_NAME> in eBay
  • Update a Record: <Entity_NAME> in eBay
  • Delete a Record: <Entity_NAME> from eBay
ebusiness Oracle E-Business Suite Adapter N/A N/A
erp Oracle ERP Cloud Adapter
  • Receive notification for business event <event name> from ERP Cloud
  • Receive Status of ERP Import Job from ERP Cloud

  • Receive notification for business event OIC_MAT_349_FSCM_PARENT from ERP Cloud

  • Request Object Account from ERP Cloud

  • Request Object Item from ERP Cloud

  • Get ESS Job Status in ERP Cloud

  • Submit Contract For Approval in ERP Cloud

  • Bulk Import of data into ERP Cloud using FBDI Job: <Job Name>

  • Upload File to UCM in ERP Cloud

eventbrite Eventbrite Adapter N/A N/A
facebook Facebook Adapter N/A N/A
file File Adapter
  • Read file from server
  • Read and delete file from server
  • Read file recursively in directory from server
  • Read file recursively in directory and delete from server
  • Read file from Server
  • Write file <FileName>in directory <DirName>
  • Listing file with minimum age <N> seconds, maximum files in response <M> Recursive <True|False>
  • Move file with Overwrite option <True|False>
  • Delete file in Server
  • Download file in Oracle Integration from agent
ftp FTP Adapter NA
  • Read file from FTP Server in (binary|ASCII) format
  • Write(append) file to FTP Server in (binary|ASCII) format
  • (Encrypt|decrypt|Sign\Verify) and Write file to FTP Server
  • List (Recursive) files from FTP Server
  • Move (Overwrite) files from FTP Server
  • Delete file in FTP Server
  • Download file from FTP Server in (binary|ASCII) format
  • Download and (unzip|decrypt|Verify) file from FTP Server in (binary|ASCII) format
gmail Google Gmail Adapter N/A
  • Get email attachment from Gmail
  • List emails from Gmail
googlecalendar Google Calendar Adapter N/A N/A
googletask Google Tasks Adapter N/A N/A
hcm Oracle HCM Cloud Adapter Receive <business object> from Client
  • <verb> <business object / noun> in HCM Cloud
  • <verb> <rest resource> from HCM Cloud
  • Subscribe <atom feed> from HCM Cloud
  • Download bulk extract <extract name> from HCM Cloud
  • Upload File to UCM in HCM Cloud
hybriscommerce SAP Commerce Cloud (Hybris) Adapter N/A
  • Query/ Create/ Update / Delete <business object> in SAP Commerce Cloud
jdeeone Oracle JD Edwards EnterpriseOne Adapter N/A
  • Call JD Edwards SOAP Service <SOAP Service> : <Operation>
jms Oracle WebLogic JMS Adapter
  • Consume message from Queue: <queue name> in Oracle Weblogic JMS
  • Consume message from Topic: <topic name> in Oracle Weblogic JMS
  • Produce message in Queue: <queue name> using Oracle Weblogic JMS
  • Produce message in Topic: <topic name> using Oracle Weblogic JMS
linkedin LinkedIn Adapter N/A N/A
mailchimp Mailchimp Adapter N/A N/A
Marketo Marketo Adapter N/A
  • Create Or Update Lead in Marketo
  • Import Lead in Marketo
microsoftcalendar Microsoft Office 365 Calendar Adapter N/A N/A
microsoftcontact Microsoft Contact Adapter N/A N/A
microsoftemail Microsoft Office 365 Outlook Adapter N/A N/A
mqjms IBM MQ Series JMS Adapter
  • Consume message from Queue: <queue name> in MQSeries JMS
  • Produce message (Persistent) in Queue: <Queue Name> using MQSeries JMS
mysqldatabase MySQL Adapter
  • New row is inserted into <table name> in MySQL DB
  • Insert rows into <table name> in My SQL DB
  • Merge rows into < table name> in My SQL DB
  • Update rows into <table name> in My SQL DB
netsuite Oracle NetSuite Adapter N/A
  • Update Superseded Items in Netsuite
  • Update EBS Item Details in Netsuite
  • Add Invoice to Netsuite
  • Search <search> in Netsuite
ocistreaming Oracle Cloud Infrastructure Streaming Service Adapter N/A
  • Message produced to: Sales-SP with Partition/s: <Partitions> of MessageType <Message Type>
ofsccloudadapter Oracle Field Service Cloud Adapter
  • Receive <event-name> notification from Oracle Field Service Cloud

    or

  • Receive <event1, event2...> notification from Oracle Field Service Cloud
  • Get <resource-name> in Oracle Field Service Cloud
  • Get <resource-name> <sub-resource-name> in Oracle Field Service Cloud
  • <custom-action> <resource-name> in Oracle Field Service Cloud
oms Oracle Messaging Cloud Service Adapter N/A N/A
rest REST Adapter
  • Trigger Oracle Integration REST Integration: <HTTP verb> <resource path>
  • Call External REST API: <verb> <relative-path>

  • Call <App-name>: <verb> <relative-path>

  • Call Oracle Integration REST Integration: <integration flow >
rest_oraclecommercecloud Oracle Commerce Cloud Adapter N/A N/A
rightnow Oracle Service Cloud (RightNow) Adapter
  • Receive <event name> Notification from Oracle Service Cloud
  • Receive <object name> (Oracle Service Cloud Object) from Client
  • Query <object name> objects from Oracle Service Cloud
  • Query CSV records for <object name> from Oracle Service Cloud
  • Get file attachment from Oracle Service Cloud
  • Invoke Batch Operation in Oracle Service Cloud
  • Get <object name> from Oracle Service Cloud
  • Create <object name> in Oracle Service Cloud
  • Update <object name> in Oracle Service Cloud
  • Destroy <object name> in Oracle Service Cloud
oracleutilities Oracle Utilities Adapter
  • <Description of the business object from the service catalog> in Oracle Utilities
  • <Description of the service from the service catalog> in Oracle Utilities
osc Oracle CX Sales and B2B Service Adapter (formerly Oracle Sales Cloud) Adapter
  • Request object <object name > from Engagement Cloud
  • Request Object Account from Engagement Cloud

  • Receive notification for business event FoundationParties_Person_Created from Engagement Cloud

  • Request Object Opportunity from Engagement Cloud

  • Create Opportunity in Engagement Cloud
  • Create ICS Sales Custom Obj CO in Engagement Cloud
logistics Oracle Logistics Adapter N/A N/A
paypal PayPal Adapter
  • Receive <business object event> notification from PayPal
  • For Query : <operation>from PayPal
  • For Create/Update/Delete:<operation> in PayPal
salesforce Salesforce Adapter
  • Receive <business object> notifications from Salesforce.com
sap SAP Adapter
  • Receive <business object> from SAP
  • Invoke <business object> from SAP
saps4hana SAP S/4HANA Cloud Adapter N/A
  • GET : Get specific item from the collection<Entity_NAME> from SAP S/4HANA
  • GET : GetAll entities in the collections of <Entity_NAME> from SAP S/4HANA
  • POST : Create new item in the collection <Entity_NAME> from SAP S/4HANA
  • PATCH : Update new item in the collection <Entity_NAME> from SAP S/4HANA
  • DELETE : Delete specific entity in the collection from SAP S/4HANA
servicenow ServiceNow Adapter
  • Receive <business object> notifications from ServiceNow
  • For Query : <operation>from ServiceNow
  • For Create/Update/Delete:<operation> in ServiceNow
  • Upload Attachment to ServiceNow
shopify Shopify Adapter
  • Receive <business object event> from Shopify
  • For Query : <<operationName>> from Shopify
  • For Create/Update/Delete:<<operationName>> in Shopify
siebel Oracle Siebel Adapter N/A
  • Call Siebel SOAP Service OS FS Get Stock Oracle Integration <Service>:<Operation>
slack Slack Adapter N/A N/A
SOAAdapter Oracle SOA Suite Adapter (includes Oracle Service Bus and Oracle SOA Cloud Service) N.A. Call a << REST / SOAP >> service on a << SOA Composite / Service Bus project >>
soap SOAP Adapter
  • Trigger Oracle Integration SOAP Integration for the interface <Port Type> : <operation name>
  • Call External SOAP API <Port Type> : <operation-name>
sqlserverdatabase Microsoft SQL Server Adapter
  • New row is inserted into <table name> in MS SQL Server DB
  • Insert rows into <table name> in MS SQL Server DB
  • Merge rows into < table name> in MS SQL Server DB
  • Update rows into <table name> in MS SQL Server DB
Successfactors SAP SuccessFactors Adapter
  • Receive <<operationName>> <<BusinessObject>> from SuccessFactors
  • Query data from SuccessFactors using SFQL query
  • Create <<BusinessObject>> in SuccessFactors
  • Update <<BusinessObject>>in SuccessFactors
  • Delete <<BusinessObject>>in SuccessFactors
  • Create or update <<BusinessObject>> in SuccessFactors
sugarcrm SugarCRM Adapter N/A
  • For Query(Retrive single/list of Records) : <operation>from SugarCRM
  • For Create/Update/Delete:<operation> in SugarCRM
surveymonkey SurveyMonkey Adapter N/A N/A
otac Oracle Taleo Enterprise Edition Adapter N/A
  • Get request status from Oracle Talent Acquisition Cloud (Taleo EE)
  • Get request status from Oracle Talent Acquisition Cloud (Taleo EE)
trello Trello Adapter N/A N/A
twilio Twilio Adapter N/A N/A
twitter Twitter Adapter N/A N/A
workday Workday Adapter N/A
  • Create, Update, Delete, and Import records in Workday
  • Extract bulk data from workday
zendesk Zendesk Adapter N/A
  • Get Single Record: Get <Entity_NAME> from Zendesk
  • Get List of Records: Get <Entity_NAME>s from Zendesk
  • Create a Record: Create <Entity_NAME> in Zendesk
  • Update a Record: Update <Entity_NAME> in Zendesk
  • Update multiple Records: Update <Entity_NAME>s in Zendesk
  • Update multiple Records in batches: Update <Entity_NAME>s in batches in Zendesk
  • Search multiple Records: Search <Entity_NAME>s in Zendesk
  • Delete a Record: Delete <Entity_NAME> from Zendesk
  • Create or Update a Record: Create or Update <Entity_NAME> in Zendesk
  • Upload an Attachment: Upload Attachment in Zendesk
  • Redact Attachment: Redact Comment Attachment in Zendesk

Example of an Endpoint Metric Chart

The following example of an endpoint metrics chart is provided. The chart shows adapter inbound request processing times. A metrics namespace is provided that is a container for message metrics. The namespace identifies the service sending the metrics. The namespace for message metrics is oci_integration.
Description of processing_time.bmp follows

Adapters with Limited Dimensions

The following adapters do not publish inboundProcessingEndpointInformation and outboundInvocationEndpointInformation dimensions in the Metrics Explorer.
  • Google Tasks Adapter
  • Microsoft Office 365 People Adapter
  • Oracle Commerce Cloud Adapter
  • Oracle CPQ Adapter
  • Oracle E-Business Suite Adapter
  • Oracle Eloqua Cloud Adapter
  • Oracle Logistics Adapter
  • Oracle Messaging Cloud Service Adapter
  • Slack Adapter