About Notebook Session Metrics

You can monitor the health, capacity, and performance of Data Science notebook sessions by using metrics, alarms, and notifications.

There are metrics emitted by the oci_datascience metric namespace, which is the Data Science service. Data Science monitors running notebook sessions and collects and reports metrics including:

  • CPU Utilization
  • Memory Utilization
  • Network Bytes In
  • Network Bytes Out

Prerequisites

IAM policies:

To monitor resources, you must be given the required access in a policy. This is true 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 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.

For more information about the policy statement required to access metrics emitted by Data Science, see Creating Policies to Control Access to Network and Data Science Related Resources.

Data Science Metrics

Metrics are automatically available for any Data Science notebook session that you create in the oci_datascience namespace. You don't need to enable monitoring on OCI resources to get these metrics.

Data Science notebook session metrics include these dimensions:

RESOURCEID

The OCID of the notebook session.

RESOURCEDISPLAYNAME

The user-supplied display name of the notebook session.

SHAPE

The compute instance shape of the notebook session.

Metric Display Name Unit Description Dimensions
CpuUtilization CPU Utilization Percent Activity level from the CPU. Expressed as a percentage of the total time (busy and idle) compared with the idle time.

resourceId

resourceDisplayName

shape

MemoryUtilization Memory Utilization Percent Space currently in use. Measured by pages. Expressed as a Percentage of used pages compared with unused pages.

resourceId

resourceDisplayName

shape

NetworkBytesIn Network Bytes In Byte Network receipt throughput. Expressed as bytes received per second.

resourceId

resourceDisplayName

shape

NetworkBytesOut Network Bytes Out Byte Network transmission throughput. Expressed as bytes transmitted per second.

resourceId

resourceDisplayName

shape

Viewing Metrics from the Monitoring Service

You can view the default metric charts for all the notebook sessions in a compartment using the Monitoring service.

  1. In the Console, select the region you are using with Data Science.
  2. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Service Metrics.
  3. Select the compartment that contains the project of the notebook session that you want to view the metrics for.
  4. Select oci_datascience as the Metric Namespace.

    The Service Metrics page dynamically updates the page to show charts for each that is emitted by the selected metric namespace, see Data Science Metrics.

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

Viewing Metrics from the Notebook Details Page

You can view the default metric charts using the a notebook session details page in the Data Science service.

  1. In the Console, select the region you are using with Data Science. Open the navigation menu. Under Data and AI, go to Data Science and click Projects.
  2. Select the compartment that contains the project of the notebook session that you want to view the metrics for.
  3. Click the name of the project associated with the notebook session for which you want to view metrics.
  4. Click the name of the notebook session that you want to view metrics for.
  5. Under Resources, click Metrics.

    The Metrics page displays a chart for each metric that is emitted by the metric namespace for Data Science. For more information about the emitted metrics, see Data Science Metrics.

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

If you don't see the metrics data for a notebook session that you expect, see the following possible causes and solutions.

Problem Possible Cause Solution
No data: Notebook creation date. The notebook session was created before the metrics feature was available. Deactivate then reactivate the notebook session to start the flow of metrics data.
No data: Permissions issue. The user is missing a policy for metrics. An administrator user needs to add a policy statement to read metrics for your user group.
No data: Misaligned chart time range. The chart range (time period or x-axis window) doesn't cover the time of notebook session use. Adjust the chart range or time period as necessary.