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.
- 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 |
|
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.
|
|
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. |
|
ErrorsAtSource
|
Errors at Source | Count | Number of errors that affect retrieving data from source |
|
ErrorsAtTarget
|
Errors at Target | Count | Number of errors that affect writing data to target |
|
LatencyAtSource
|
Latency at Source | Milliseconds | Time-to-first-byte when retrieving data from source. Useful for customers to troubleshoot with complex tasks (log rules). |
|
LatencyAtTarget
|
Latency at Target | Milliseconds | Time-to-first-byte when writing data to target |
|
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
|
|
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.
|
|
ServiceConnectorHubErrors
|
Service Connector Hub Errors | Count | Number of errors in Service Connector Hub that affect moving data from source to target |
|
Using the Console
- Open the navigation menu. Under Data and AI, click Service Connector Hub.
- Choose the Compartment that contains the service connector you want to view, and then click the service connector's name.
-
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.
- Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Service Metrics.
-
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.
Using the API
Use the following APIs for monitoring:
- Monitoring API for metrics and alarms
- Notifications API for notifications (used with alarms)