Oracle Cloud Infrastructure Documentation

Create Custom Metrics Charts

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

  1. If you're not already viewing the metrics for an Oracle Integration instance, in the Oracle Cloud Infrastructure Console, open an Oracle Integration instance, and scroll down to the Metrics section.
  2. In the top right of a chart, click Options, and then click View query in Metrics Explorer.
  3. On the Metrics Explorer page, at the bottom of the chart, click Edit queries.
  4. Edit the query or add new ones by configuring the following parameters:
    Parameter Description
    Compartment The compartment in which your Oracle Integration instance is stored.
    Metric namesapce The namespace identifies the service sending the metrics. Leave oci_integration, the namespace for Oracle Integration.
    Metric name The metric you want to chart. For a list of metrics available for Oracle Integration, see Oracle Integration Dimensions for Custom Charts.
    Interval The time window for aggregating data points.
    Statistic The aggregation function applied to the data.
    Dimension name The filter you want applied to the selected metric. Dimensions vary by metric. For a list of dimensions available for each Oracle Integration metric, see Oracle Integration Dimensions for Custom Charts.
    Dimension value The value that you want to use for the specified dimension, for example, the resource identifier for an 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.
  5. When you're done editing your query, click Update Chart.

For more information on custom metrics charts, see Viewing a Custom Metric Chart in the Oracle Cloud Infrastructure documentation.

Oracle Integration Metrics for Custom Charts

Oracle Integration includes the following metrics that you can use in custom charts.

Metric Unit Description Available dimensions Commonly used statistics
BilledMessageCount count Number of billing messages that the service instance used for incoming and outgoing messages for trigger and invoke requests.
  • adapterIdentifier
  • integrationFlowIdentifier
  • resourceid
  • Max
BilledMessageCountDataRetention count Number of billing messages used for extended data retention.
  • resourceid
  • resourcename
  • Max
BilledMessagePackCount count Number of message packs that you purchased.
  • resourceid
  • resourcename
  • Max
ConfiguredMessages count Number of billing messages that were configured.
  • 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
OPABilledDecisionMessageCount count Number of billing messages that decisions used.
  • OPAInstanceId
  • resourceid
  • resourcename
  • Max
OPABilledProcessMessageCount count Number of process billing messages that Process Automation used
  • OPAInstanceId
  • resourceid
  • resourcename
  • Max
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
RPABilledMessageCount count Number of billing messages that robotic process automation used.
  • resourceid
  • RPAInstanceId
  • Max
TotalBilledMessageCount count Total number of billing messages used by all components except Visual Builder. This total doesn't include disaster recovery.
  • resourceid
  • resourcename
  • Max

Oracle Integration Dimensions for Custom Charts

Oracle Integration includes the following dimensions that you can use in custom metrics charts.

Note

Each metric has its own dimensions. Not all dimensions are available on all metrics. See Oracle Integration Metrics for Custom Charts.
Dimension How it filters data in the chart
adapterIdentifier Shows 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 Shows data in the chart for a specific account type, such as a universal credit model (UCM) account, an Oracle Integration for Saas account, or a government account.
flowCode Shows data in the chart for a specific integration in Oracle Integration.
flowVersion Shows 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 Shows data in the chart for a specific functional request received from the client. Provides a concise summary of the adapter trigger configuration.

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.
inboundProcessingResponseStatus Shows data in the chart for a specific status sent by the trigger to the external client.
instanceName Shows 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 Shows data in the chart for a specific license type, such as BYOL, Cloud, or SaaS.
outboundInvocationEndpointInformation Shows data in the chart for a specific functional request made to the external system. Provides a concise summary of the adapter invoke configuration.

For example, 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.
outboundInvocationResponseStatus Shows data in the chart for a specific status received from the external system.
integrationFlowIdentifier Shows 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 Shows data in the chart for a specific OCID of an integration instance. You can use this value to uniquely track the instance.

How Adapters Map to Dimension Values

This table lists each adapter and its associated dimension values.

Adapter display name Value for adapterIdentifier dimension Values for inboundProcessingEndpointInformation dimension Values for outboundInvocationEndpointInformation dimension
Adobe Sign Adapter adobeesign 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
Apache Kafka Adapter apachekafka
  • 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
AS2 Adapter as2adapter N/A N/A
Box Adapter box N/A N/A
DocuSign Adapter docusign 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 Marketplace Adapter ebay 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
EDI Translate Action bbtranslationadapter N/A
  • B2B EDI Translation
Eventbrite Adapter eventbrite N/A N/A
Facebook Adapter facebook N/A N/A
File Adapter file
  • 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 Adapter ftp 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
Google Calendar Adapter googlecalendar N/A N/A
Google Gmail Adapter gmail N/A
  • Get email attachment from Gmail
  • List emails from Gmail
Google Tasks Adapter googletask N/A N/A
IBM DB2 Adapter db2database
  • 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
IBM MQ Series JMS Adapter mqjms
  • Consume message from Queue: <queue name> in MQSeries JMS
  • Produce message (Persistent) in Queue: <Queue Name> using MQSeries JMS
LinkedIn Adapter linkedin N/A N/A
Mailchimp Adapter mailchimp N/A N/A
Marketo Adapter Marketo N/A
  • Create Or Update Lead in Marketo
  • Import Lead in Marketo
Microsoft Contact Adapter microsoftcontact N/A N/A
Microsoft Office 365 Calendar Adapter microsoftcalendar N/A N/A
Microsoft Office 365 Outlook Adapter microsoftemail N/A N/A
Microsoft SQL Server Adapter sqlserverdatabase
  • 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
MySQL Adapter mysqldatabase
  • 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
Oracle Advanced Queuing (AQ) Adapter aq
  • 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)
Oracle Autonomous Data Warehouse Adapter adwdatabase
  • 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
Oracle Autonomous Transaction Processing Adapter atpdatabase
  • 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
Oracle Cloud Infrastructure Streaming Service Adapter ocistreaming N/A
  • Message produced to: Sales-SP with Partition/s: <Partitions> of MessageType <Message Type>
Oracle Commerce Cloud Adapter rest_oraclecommercecloud N/A N/A
Oracle CPQ Adapter cpq N/A N/A
Oracle CX Sales and B2B Service Adapter (formerly Oracle Sales Cloud) Adapter osc
  • 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
Oracle Database Adapter database
  • 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
Oracle Database Cloud Service Adapter dbaasdatabase
  • 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
Oracle E-Business Suite Adapter ebusiness N/A N/A
Oracle Eloqua Cloud Adapter eloqua N/A N/A
Oracle Enterprise Performance Management Cloud Adapter epm N/A N/A
Oracle ERP Cloud Adapter erp
  • 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
Oracle Field Service Cloud Adapter ofsccloudadapter

  • 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
Oracle HCM Cloud Adapter hcm 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
Oracle Intelligent Advisor Adapter (formerly Oracle Policy Automation) Adapter rest_opa
  • Receive ${load/save} request for <interview> from Intelligent Advisor
  • Send assessment request for <interview> to Intelligent Advisor.
Oracle JD Edwards EnterpriseOne Adapter jdeeone N/A
  • Call JD Edwards SOAP Service <SOAP Service> : <Operation>
Oracle Logistics Adapter logistics N/A N/A
Oracle Messaging Cloud Service Adapter oms N/A N/A
Oracle NetSuite Adapter netsuite N/A
  • Update Superseded Items in Netsuite
  • Update EBS Item Details in Netsuite
  • Add Invoice to Netsuite
  • Search <search> in Netsuite
Oracle Responsys Adapter responsys N/A N/A
Oracle Service Cloud (RightNow) Adapter rightnow
  • 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
Oracle Siebel Adapter siebel N/A
  • Call Siebel SOAP Service OS FS Get Stock Oracle Integration <Service>:<Operation>
Oracle SOA Suite Adapter (includes Oracle Service Bus and Oracle SOA Cloud Service) SOAAdapter N.A. Call a << REST / SOAP >> service on a << SOA Composite / Service Bus project >>
Oracle Taleo Enterprise Edition Adapter otac N/A
  • Get request status from Oracle Talent Acquisition Cloud (Taleo EE)
Oracle Utilities Adapter oracleutilities
  • <Description of the business object from the service catalog> in Oracle Utilities
  • <Description of the service from the service catalog> in Oracle Utilities
Oracle WebLogic JMS Adapter jms
  • 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
PayPal Adapter paypal
  • Receive <business object event> notification from PayPal
  • For Query : <operation>from PayPal
  • For Create/Update/Delete:<operation> in PayPal
REST Adapter rest
  • 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 >
Salesforce Adapter salesforce
  • Receive <business object> notifications from Salesforce.com
SAP Adapter sap
  • Receive <business object> from SAP
  • Invoke <business object> from SAP
SAP Ariba Adapter ariba
  • 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
SAP Commerce Cloud (Hybris) Adapter hybriscommerce N/A
  • Query/ Create/ Update / Delete <business object> in SAP Commerce Cloud
SAP Concur Adapter concur 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
SAP S/4HANA Cloud Adapter saps4hana 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
SAP SuccessFactors Adapter Successfactors
  • 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
ServiceNow Adapter servicenow
  • Receive <business object> notifications from ServiceNow
  • For Query : <operation>from ServiceNow
  • For Create/Update/Delete:<operation> in ServiceNow
  • Upload Attachment to ServiceNow
Shopify Adapter shopify
  • Receive <business object event> from Shopify
  • For Query : <<operationName>> from Shopify
  • For Create/Update/Delete:<<operationName>> in Shopify
Slack Adapter slack N/A N/A
SOAP Adapter soap
  • Trigger Oracle Integration SOAP Integration for the interface <Port Type> : <operation name>
  • Call External SOAP API <Port Type> : <operation-name>
SugarCRM Adapter sugarcrm N/A
  • For Query(Retrive single/list of Records) : <operation>from SugarCRM
  • For Create/Update/Delete:<operation> in SugarCRM
SurveyMonkey Adapter surveymonkey N/A N/A
Trello Adapter trello N/A N/A
Twilio Adapter twilio N/A N/A
Twitter Adapter twitter N/A N/A
Workday Adapter workday N/A
  • Create, Update, Delete, and Import records in Workday
  • Extract bulk data from workday
Zendesk Adapter zendesk 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 a Custom Metrics Chart

The following custom metrics chart example shows adapter inbound request processing times.
Description of processing_time.png follows
Description of the illustration processing_time.png