Service Connector Hub Metrics

You can monitor the health, capacity, and performance of your service connectors by using metrics , alarms , and notifications.

This topic describes the metrics emitted by the Service Connector Hub service in the oci_service_connector_hub metric namespace.

Resources: Service connectors.

Overview of the Service Connector Hub Service Metrics

The Service Connector Hub service metrics help you measure the number and type of connections between services in Oracle Cloud Infrastructure. You can use metrics data to diagnose and troubleshoot service connector issues.

To view a default set of metrics charts in the Console, navigate to the service connector you're interested in, and then click Metrics. You also can use the Monitoring service to create custom queries.

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.

Administrators: For common policies that give groups access to Service Connector Hub, see Allow a group to manage service connectors.

Available Metrics: oci_service_connector_hub

The metrics listed in the following tables are automatically available for any service connectors you create. You do not need to enable monitoring on the resource to get these metrics.

Service Connector Hub service metrics include the following dimensions :

connectorId
The OCID of the service connector that the metrics apply to.
connectorName
The name of the service connector that the metrics apply to.
errorType
The type of error.
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.
Metric Metric Display Name Unit Description Dimensions
BytesReadFromSource Bytes Read from Source Bytes Number of bytes read from the source
Note

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

connectorId

connectorName

region

sourceName

BytesWrittenToTarget Bytes Written to Target Bytes

Number of bytes written to the target

Note

Use this metric as a general indicator of success. BytesWrittenToTarget may not match BytesReadFromSource for data read from Logging to the following target services.
  • Monitoring may translate multiple records into a single metric data point.
  • Object Storage compresses data. For example, 10MB read may be converted into 1MB written.

connectorId

connectorName

region

targetName

DataFreshness Data Freshness Milliseconds

Indicates age of the oldest processed record of the most recent set

For example, let's say you check this metric at 10:30. At 10:00, you received your last set of records at 10:00. Of the five records, three have a 10:00 timestamp while two have a 9:55 timestamp. In this example, the most recent set was received at 10:00; the oldest processed record had a 9:55 timestamp. At 10:35, the age is 35 minutes.

connectorId

connectorName

region

sourceName

targetName

ErrorsAtSource Errors at Source Count Number of errors that affect retrieving data from source

connectorId

connectorName

errorType

region

sourceName

ErrorsAtTarget Errors at Target Count Number of errors that affect writing data to target

connectorId

connectorName

errorType

region

targetName

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

region

sourceName

LatencyAtTarget Latency at Target Milliseconds Time-to-first-byte when writing data to target

connectorId

connectorName

region

targetName

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 service connector reads a single message from the source, the service connector emits a MessagesReadFromSource metric with a value of 1. However, let's say that the service connector is unable to write to the target. The next time the service connector reads (1 message) from the source, it will emit a MessagesReadFromSource metric with a cumulative value of 2, which includes the message from the first read. Let's say the service connector successfully writes to the target. The third time the service connector reads (1 message) from the source, it will emit the MessagesReadFromSource metric with a cumulative value of 1.

connectorId

connectorName

region

sourceName

MessagesWrittenToTarget Messages Written to Target Count

Number of records written to the target

Note

Use this metric as a general indicator of success. MessagesWrittenToTarget may not match MessagesReadFromSource for messages read from Logging to the following target services.
  • Monitoring may translate multiple records into a single metric data point.
  • Object Storage compresses data. For example, 10MB read may be converted into 1MB written.

connectorId

connectorName

region

targetName

ServiceConnectorHubErrors Service Connector Hub Errors Count Number of errors in Service Connector Hub that affect moving data from source to target

connectorId

connectorName

region

Using the Console

To view default metric charts for a single service connector
  1. Open the navigation menu. Under Data and AI, click Service Connector Hub.
  2. Choose the Compartment that contains the service connector you want to view, and then click the service connector's name.
  3. In the Resources menu, click Metrics (if necessary).

    The Metrics page displays a default set of charts for the current service connector.

For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.

To view default metric charts for multiple service connectors
  1. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Service Metrics.
  2. For Metric Namespace, select oci_service_connector_hub.

    The Service Metrics page displays a default set of charts for the selected metric namespace. For more information about the emitted metrics, see the foregoing table. You can also use the Monitoringservice to create custom queries.

For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.