Service Mesh Metrics
You monitor the health, capacity, and performance of Service Mesh by using metrics, alarms, and notifications.
This topic describes the metrics emitted by the metric namespace
oci_servicemesh
.
Overview
Metrics help you monitor Service Mesh resources.
- Namespace
- A namespace is a container for metrics. The namespace identifies the service
sending the metrics. The namespace for Service Mesh is
oci_servicemesh
. - Metrics
- Metrics are the fundamental concept in telemetry and monitoring. Metrics define a time-series set of datapoints. Each metric has a namespace, metric name, compartment identifier, one or more dimensions, and a unit of measure. Each datapoint has a timestamp, value, and count associated with it.
- Dimensions
- A dimension is a key-value pair that defines the characteristics associated
with the metric. For example,
resourceId
is the OCID of the resource that was scanned. - Statistics
- Statistics are 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
- Alarms are used to automate operations monitoring and performance. An alarm tracks changes that occur over a specific time period and performs one or more defined actions, based on the rules defined for the metric.
Required IAM Policy
To monitor resources in Oracle Cloud Infrastructure, you must be given the required type of access. An IAM administrator must write the required policies 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 and the resources being monitored. If you get a "you don't have permission" or an "unauthorized" message, confirm with your administrator the type of access you were granted. Also, ensure you are working in the correct compartment.
Ingress Gateway Metrics
Service Mesh includes the following metrics and dimensions for ingress gateways.
resourceId
: The OCID of the ingress gateway resource.meshId
: The OCID of the parent mesh resource for this ingress gateway resource.meshComponent - "IngressGateway"
: The Service Mesh resource type.
Metric | Metric Display Name | Unit | Description |
---|---|---|---|
ActiveProxyConnections |
Number of connected proxies | count |
The number of active connected proxies at any given time. This metric is updated every minute. |
OutdatedProxyConnections |
Number of outdated proxies | count |
The number of connected proxies not running the latest image version. This metric is updated every minute. |
Virtual Deployment Metrics
Service Mesh includes the following metrics and dimensions for virtual deployments.
resourceId
: The OCID of the ingress gateway resource.virtualDeploymentId
: The OCID of the parent virtual service resource for this virtual deployment resource.meshId
: The OCID of the parent mesh resource for this virtual deployment resource.meshComponent - "VirtualDeployment"
: The Service Mesh resource type.
Metric | Metric Display Name | Unit | Description |
---|---|---|---|
ActiveProxyConnections |
Number of connected proxies | count |
The number of active connected proxies at any given time. This metric is updated every minute. |
OutdatedProxyConnections |
Number of outdated proxies | count |
The number of connected proxies not running the latest image version. This metric is updated every minute. |
Using the Console
View the metric charts for Service Mesh.
- In the Console, open the navigation menu and click Observability & Management. Under Monitoring, click Service Metrics.
- For Compartment, select the compartment that contains the mesh that you're interested in.
- For Metric namespace, select oci_servicemesh.
- Select a Metric name, Interval,
and Statistic.
For example, select the metric named
ActiveProxyConnections
and set Interval to 1 minute. - (Optional) To view the raw data points for the selected metric, click Show Data Table.
The Service Metrics page dynamically updates to show charts for each metric emitted by the selected metric namespace.
Using the API
Use the following APIs for monitoring.
- Monitoring API for metrics and alarms
- Notifications API for notifications (used with alarms)
For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.