Monitoring metrics for Schematics

IBM Cloud services, such as Schematics, generate platform metrics that you can use to gain operational visibility into the performance and health of the service in your account.

IBM Cloud Monitoring is a third-party cloud-native, and container-intelligence management system that can be included as part of your IBM Cloud architecture. It offers administrators, DevOps teams, and developers full-stack telemetry with advanced features to monitor and troubleshoot, define alerts, and design custom dashboards. For more information, see Monitoring in IBM Cloud.

You can use IBM Cloud Metrics Routing, a platform service to route platform metrics in your account to a destination of your choice by configuring targets and routes that define where platform metrics are sent. For more information, see About IBM Cloud Metrics Routing in IBM Cloud.

You can use IBM Cloud® Monitoring to visualize and alert on metrics that are generated in your account and routed by IBM Cloud Metrics Routing to an IBM Cloud Monitoring instance.

Locations where metrics are generated

Schematics sends metrics in the regions that are indicated in the following table.

Regions where metrics are sent in Americas locations
Dallas (`us-south`)	Washington (`us-east`)
Yes	Yes

Regions where metrics are sent in Europe locations
Frankfurt (`eu-de`)	London (`eu-gb`)
Yes	Yes

Enabling platform metrics for Schematics

Viewing metrics

To monitor Schematics metrics, you must launch the IBM Cloud Monitoring web UI for the instance that is enabled for platform metrics in the region where your Schematics instance is provisioned.

Launching and monitoring IBM Cloud® Monitoring from the Observability page

You can monitor your services instance in the IBM Cloud console. For more information about launching the IBM Cloud Monitoring UI, see Launching the UI in the IBM Cloud Monitoring documentation and Monitoring in IBM Cloud.

Creating a custom dashboard

You can create custom dashboard in the web UI to edit the metrics that you want to monitor, the counts of your Terraform state, Ansible, and its success and failure status.

For more information about deleting a dashboard, see Deleting a dashboard.

IBM Cloud Schematics metrics dictionary

Schematics supports three metrics that you can use to configure in your dashboard for monitoring. The tables provide the details about the metrics.

Metrics details
Metric name	Enterprise	Lite	Standard
`ibm_schematics_workspace_actions_count`	Yes	No	Yes
`ibm_schematics_workspace_count`	Yes	No	Yes
`ibm_schematics_workspace_vulnerability_count`	Yes	No	Yes

`ibm_schematics_workspace_count`

The number of workspaces states and actions count is stated in the table.

Workspace state and action count
Metadata	Description
`Metric Name`	`ibm_schematics_workspace_count`
`Metric Type`	`gauge`
`Frequency`	`60 seconds`
`Unit`	`none`
`Labels`	`ibm_schematics_workspace_status such as Active, Draft, Inactive, and Template Error are derived.`

For the Schematics instance, the following five different time series counts or charts are derived from ibm_schematics_workspace_count metric.

Workspace time series count
Status	Query
Number of workspaces created	`Sum(ibm_schematics_workspace_count{})`
Number of active workspaces	`ibm_schematics_workspace_count{ibm_schematics_workspace_status = ”Active”}`
Number of workspaces in draft state	`ibm_schematics_workspace_count{ibm_schematics_workspace_status = ”Draft”}`
Number of inactive workspaces	`ibm_schematics_workspace_count{ibm_schematics_workspace_status = ”Inactive”}`
Number of workspaces deleted	`ibm_schematics_workspace_count{ibm_schematics_workspace_status = ”Template Error”}`

`ibm_schematics_workspace_actions_count`

The numbers of workspace actions that are counted are stated in the table.

Workspace actions count
Metadata	Description
`Metric Name`	`ibm_schematics_workspace_actions_count`
`Metric Type`	`gauge`
`Frequency`	`60 seconds`
`Unit`	`none`
`Labels`	`[ibm_schematics_workspace_action are apply, destroy, and plan ibm_schematics_workspace_action_status such as failure or success are supported.]`

For the Schematics instance, the following six different time series counts or charts are derived from ibm_schematics_workspace_actions_count metric.

Schematics time series counts
Status	Query
Number of workspace actions	`Sum(ibm_schematics_workspace_actions_count {})`
Number of successful workspace actions	`ibm_schematics_workspace_actions_count{ibm_schematics_workspace_action_status="success"}`
Number of failure workspace actions	`ibm_schematics_workspace_actions_count{ibm_schematics_workspace_action_status="failure"}`
Number of planned actions	`ibm_schematics_workspace_count{ibm_schematics_workspace_action = "Plan"}`
Number of successful plan actions	`ibm_schematics_workspace_count{ibm_schematics_workspace_action = ”Plan”, ibm_schematics_workspace_action_status="success"}`
Number of failure plan actions	`ibm_schematics_workspace_count{ibm_schematics_workspace_action = ”Plan”, ibm_schematics_workspace_action_status="failure"}`

You can create similar queries to fetch apply, destroy, and plan actions.

`ibm_schematics_vulnerability_count`

The average vulnerability count of the workspaces is stated in the table.

Vulnerability count
Metadata	Description
`Metric Name`	`ibm_schematics_workspace_vulnerability_count`
`Metric Type`	`gauge`
`Frequency`	`60 minutes`
`Unit`	`none`
`Labels`	`[ibm_schematics_vulnerability_count, such as average]`

For the Schematics instance, the following time series counts and charts are derived from ibm_schematics_workspace_vulnerability_count metric.

Vulnerability count of Schematics workspace
Status	Query
Number of workspaces currently managed	`avg(avg(ibm_schematics_vulnerability_count))`