Data Integration Metrics

You monitor the health, capacity, and overall performance and management of your Data Integration instances by using metrics, alarms, and notifications.

This topic describes the metrics emitted by the metric namespace oci_dataintegration (the Data Integration service).

Resources: workspaces

Overview

The Data Integration metrics help you measure the number of objects stored in your Data Integration instance, the number of bytes read from sources and number of failed task runs, if any.

Terminology

The following terms help understand metrics:

Namespace
A container for Data Integration metrics. The namespace identifies the service sending the metrics. The namespace for Data Integration is oci_dataintegration.
Metrics
The fundamental concept in telemetry and monitoring. Metrics define a time-series set of datapoints. Each metric is uniquely defined by namespace, metric name, compartment identifier, and a set of one or more dimensions, and a unit of measure. Each datapoint has a time stamp, a value, and a count associated with it.
Dimensions
A key-value pair that defines the characteristics associated with the metric; for example, resourceId, which is the Data Integration workspace OCID.
Statistics
Metric data aggregations over specified periods of time. Aggregations are done using the namespace, metric name, dimensions, and the data point unit of measure within the time period specified.
Alarms
Used to automate operations monitoring and performance. An alarm keeps track of changes that occur over a specific period of time and performs one or more defined actions, based on the rules defined for the metric.

Prerequisites

  • IAM policies: To monitor resources, you must be given the required type of access in a policy written by an administrator, whether you're using the Console or the REST API with an SDK, CLI, or other tool. The policy must give you access to the monitoring services as well as the resources being monitored. If you try to perform an action and get a message that you don’t have permission or are unauthorized, confirm with your administrator the type of access you've been granted and which compartment you should work in. For more information on user authorizations for monitoring, see the Authentication and Authorization section for the related service: Monitoring or Notifications.

  • The metrics listed on this page are automatically available for any Data Integration instance you create. You do not need to enable monitoring on the resource to get these metrics.

Available Metrics

Data Integration metrics may include the following dimensions:

RESOURCEID
For BytesRead and BytesWritten, RESOURCEID is the Task Run ID. For NumberOfSuccessfulJobs and NumberOfFailedJobs, RESOURCEID is workspace OCID.
TASKID
The ID of the Task Run that ran the task.
TASKNAME
The name of the Task Run that ran the task.
WORKSPACEID
OCID of the workspace where the Task Run was executed.
Metric Metric Display Name Unit Description Dimensions
BytesRead Bytes Read bytes Total number of bytes read from sources.

resourceId

workspaceId

taskName

BytesWritten Bytes Written bytes Total number of bytes written to targets

taskRunName

workspaceId

taskId

NumberOfSuccessfulTaskRuns Number of Successful Task Runs count Total number of Task Runs completed successfully.

resourceId

workspaceId

NumberOfFailedTaskRuns Number of Failed Task Runs count Total number of Task Runs that failed.

resourceId

workspaceId

Note

For Oracle Database, BytesWritten will not display any data.

Using the Console

Here's how you view metric charts:

  1. In the Console, open the navigation menu. Under Solutions and Platform, go to Monitoring and click Service Metrics.
  2. For Compartment, select the compartment that contains the Data Integration workspaces that you're interested in.
  3. For Metric Namespace, select oci_dataintegration.

The Service Metrics page dynamically updates the page to show charts for each metric that is emitted by the selected metric namespace.