Oracle Cloud Infrastructure Documentation

Connector Hub Metrics Reference

Review details about the metrics emitted for the metric namespace oci_service_connector_hub (the Connector Hub service).

Before You Begin

IAM policies: To monitor resources, you must be granted 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 both the monitoring services and the resources being monitored. If you try to perform an action and get a message that you don't have permission or are unauthorized, contact the administrator to find out what type of access you were granted and which compartment  you need to work in. For more information about user authorizations for monitoring, see IAM Policies.

Administrators: For common policies that give groups access to metrics, see Metric Access for Groups (Securing Monitoring). For common policies that give groups access to Connector Hub, see IAM Policies (Securing Connector Hub).

The metrics in oci_service_connector_hub are automatically available for any connectors you create. You don't need to enable monitoring on the resource to get these metrics.

Available Metrics: oci_service_connector_hub

Dimensions

Connector Hub service metrics include the following dimensions :

connectorId
The OCID of the connector that the metrics apply to.
connectorName
The name of the connector that the metrics apply to.
errorCode
The error code. Examples: 404, 500, -1
Error code -1 indicates a client error, such as a time-out or network error.
Note

For information about common errors, see API Errors.
errorType
The type of error. Examples: NotAuthorizedOrNotFound, TooManyRequests
Note

For information about common errors, see API Errors.
region
The region that the metrics apply to.
sourceName
The name of the source service that the metrics apply to.
targetName
The name of the target service that the metrics apply to.
taskName
The name of the task service that the metrics apply to.

Descriptions

Following are descriptions of the Connector Hub service metrics:

Metric Metric Display Name Unit Description Dimensions
BytesReadFromSource Bytes read from source Bytes

Number of bytes read from the source.

Note: This value is emitted each time Connector Hub reads data from the source. If failures occur at the task or destination and Connector Hub needs to reread data from the source, the value is emitted again.

connectorId

connectorName

partitionId

region

sourceName

BytesReadFromTask Bytes read from task Bytes

Number of bytes moved from the task to Connector Hub.

connectorId

connectorName

region

taskName

BytesWrittenToTarget Bytes written to target Bytes

Number of bytes written to the target.

Note:

  • Use this metric as a general indicator of success.
  • BytesWrittenToTarget might not match BytesReadFromSource or BytesReadFromTask. For example, consider a 10MB read intended for an Object Storage target. Connector Hub might compress the data, converting 10MB read into 1MB written.
  • BytesWrittenToTarget isn't emitted for connectors with Monitoring targets.

connectorId

connectorName

region

targetName

BytesWrittenToTask Bytes written to task Bytes

Number of bytes moved by Connector Hub to the task.

connectorId

connectorName

region

taskName

DataFreshness Data freshness Milliseconds

Indicates age of the latest processed record of the most recent set.

For example, let's say that the connector received a set of five records at 10:00. Three records have a 09:55 timestamp, while the other two records have a 09:45 timestamp. Because the most recent record has a 09:55 timestamp, the calculated lag is 5 minutes.

connectorId

connectorName

region

sourceName

targetName

ErrorsAtSource Errors at source Count

Number of errors that affect retrieving data from source.

Tip: To troubleshoot errors, view the errorCode and errorType dimension values. For example, an errorCode value that starts with 5, such as 500, implies a partner service outage, while the errorCode value โ€“1 implies a network outage or timeout. The errorType value NotAuthorizedOrNotFound (for errorCode value 404) might indicate missing customer policies.

connectorId

connectorName

errorCode

errorType

partitionId

region

sourceName

ErrorsAtTarget Errors at target Count

Number of errors that affect writing data to target.

Tip: To troubleshoot errors, view the errorCode and errorType dimension values. For example, an errorCode value that starts with 5, such as 500, implies a partner service outage, while the errorCode value โ€“1 implies a network outage or timeout. The errorType value NotAuthorizedOrNotFound (for errorCode value 404) might indicate missing customer policies.

connectorId

connectorName

errorCode

errorType

region

targetName

ErrorsAtTask Errors at task Count

Number of errors while writing to the task.

Tip: To troubleshoot errors, view the errorCode and errorType dimension values. For example, an errorCode value that starts with 5, such as 500, implies a partner service outage, while the errorCode value โ€“1 implies a network outage or timeout. The errorType value NotAuthorizedOrNotFound (for errorCode value 404) might indicate missing customer policies.

connectorId

connectorName

errorCode

errorType

region

taskName

LatencyAtSource Latency at source Milliseconds

Time-to-first-byte when retrieving data from source. Useful for customers to troubleshoot with complex tasks (log rules).

connectorId

connectorName

partitionId

region

sourceName

LatencyAtTarget Latency at target Milliseconds

Time-to-first-byte when writing data to target.

connectorId

connectorName

region

targetName

LatencyAtTask Latency at task Milliseconds

Time-to-first-byte for task; includes latency reading from the source, errors at the task, and errors writing to the target.

connectorId

connectorName

region

taskName

MessagesReadFromSource Messages read from source Count

Number of records read from the source.

Note: The value for this metric is cumulative. For example, when a connector reads a single message from the source, the connector emits a MessagesReadFromSource metric with a value of 1. However, let's say that the connector is unable to write to the target. The next time the connector reads (1 message) from the source, it emits a MessagesReadFromSource metric with a cumulative value of 2, which includes the message from the first read. Let's say the connector successfully writes to the target. The third time the connector reads (1 message) from the source, it emits the MessagesReadFromSource metric with a cumulative value of 1.

connectorId

connectorName

partitionId

region

sourceName

MessagesReadFromTask Messages read from task Count

Number of messages moved from the task to Connector Hub.

connectorId

connectorName

region

taskName

MessagesWrittenToTask Messages written to task Count

Number of messages moved by Connector Hub to the task.

connectorId

connectorName

region

taskName

MessagesWrittenToTarget Messages written to target Count

Number of records written to the target.

connectorId

connectorName

region

targetName

ServiceConnectorHubErrors Connector Hub Errors Count

Number of errors in Connector Hub that affect moving data from source to target.

connectorId

connectorName

region