Monitoring

IBM Cloud® Data Engine is deprecated. As of 18 February 2024 you can't create new instances, and access to free instances will be removed. Existing Standard plan instances are supported until 18 January 2025. Any instances that still exist on that date will be deleted.

IBM Cloud® Monitoring is a cloud-native, and container-intelligence management system that you can include as part of your IBM Cloud architecture. Use it to gain operational visibility into the performance and health of your applications, services, and platforms. It offers administrators, DevOps teams, and developers full stack telemetry with advanced features to monitor and troubleshoot, define alerts, and design custom dashboards.

Opting in to and enabling Data Engine metrics

Before you can start to use IBM Cloud® Data Engine metrics, you must first opt in, and then enable platform metrics by completing the following steps.

Enable platform metrics for Data Engine. For more information, see Enabling platform metrics. The owner of the account has full access to the metrics data. For more information about managing access for other users, see Getting started tutorial for IBM Cloud® Monitoring.
To navigate from the Data Engine instance page to the IBM Cloud Monitoring dashboard, click the overflow menu (three vertical dots) of the instance page (Service instance options) and select Monitoring.

On your first usage, you might see a welcome wizard. To advance to the dashboard selection menu, select Next and then Skip on the Choosing an installation method page. Accept the prompts that follow. You can then select the Data Engine dashboard.

Dashboards are available only after metrics start to be recorded, which might take a few minutes to initialize.

Data Engine metrics cost information

Before you opt in to using IBM Cloud® Monitoring metrics, be aware of the cost of doing so. Every instance of Data Engine makes four metrics available, each time series has a monthly cost of $0.08, which leads to a monthly cost of $0.32 per instance.

For more information, see IBM Cloud Monitoring pricing External link icon .

Data Engine metrics details

The following tables describe the specific metrics that are provided by Data Engine.

Table 1. Available metrics.
Metric name
Number of bytes read by completed jobs
Number of completed jobs
Number of failed jobs
Number of jobs in progress

Number of bytes read by completed jobs

The following table shows the cumulative number of bytes read by all Data Engine jobs that completed successfully.

Table 2. Number of bytes read by completed jobs metric metadata.
Metadata	Description
`Metric name`	`ibm_sqlquery_bytes_read`
`Metric type`	`gauge`
`Value type`	`byte`
`Segment by`	`Service instance, Service instance name`

Number of completed jobs

The following table shows the number of Data Engine jobs that were completed successfully.

Table 3. Number of completed jobs metric metadata.
Metadata	Description
`Metric name`	`ibm_sqlquery_completed_jobs`
`Metric type`	`gauge`
`Value type`	`none`
`Segment by`	`Service instance, Service instance name`

Number of failed jobs

The following table shows the number of Data Engine jobs that failed.

Table 4. Number of failed jobs metric metadata.
Metadata	Description
`Metric name`	`ibm_sqlquery_failed_jobs`
`Metric type`	`gauge`
`Value type`	`none`
`Segment by`	`Service instance, Service instance name`

Number of jobs in progress

The following table shows the number of submitted Data Engine jobs that are in progress (queued or running).

Table 5. Number of jobs in progress metric metadata.
Metadata	Description
`Metric name`	`ibm_sqlquery_jobs_in_progress`
`Metric type`	`gauge`
`Value type`	`none`
`Segment by`	`Service instance, Service instance name`

Attributes for segmentation

Global attributes

The following attributes are available for segmenting all of the listed metrics.

Table 6. Global attributes.
Attribute	Attribute name	Attribute description
`Cloud type`	`ibm_ctype`	The cloud type is a value of public, dedicated, or local.
`Location`	`ibm_location`	The location of the monitored resource, which can be a region, a data center, or global.
`Resource group`	`ibm_resource_group_name`	The resource group where the service instance was created.
`Scope`	`ibm_scope`	The scope is the account, organization, or space GUID associated with this metric.
`Service name`	`ibm_service_name`	Name of the service that generates this metric.

More attributes

The following attributes are available for segmenting one or more attributes as described in the preceding reference. See the individual metrics for segmentation options.

Table 5. More attributes.
Attribute	Attribute name	Attribute description
`Service instance`	`ibm_service_instance`	The service instance segment identifies the instance that the metric is associated with.
`Service instance name`	`ibm_service_instance_name`	The service instance name provides the user-provided name of the service instance that isn't necessarily a unique value, depending on the name provided by the user.

Next Steps

You can manage the data that the Monitoring instance collects for you. From management to setting alerts, you can get started External link icon monitoring your data quickly and efficiently.