View & Query Metrics
How to query and view metrics in GUI and CLI

Notebooks, Experiments & Deployment Metrics

Web GUI
CLI

Deployments

Deployment metrics are a Gradient Private Cluster feature. Contact Sales for inquiries!
To view Deployment metrics, navigate to the Metrics tab of the individual deployment.

Notebooks

Notebook metrics are a Gradient Private Cluster feature. Contact Sales for inquiries!
To view Notebook metrics, you will see a minimal version in the Notebook header and you can also open a more robust display with detailed information.
Detailed view
Collapsed view in Notebook header

Workflows

Coming soon!
To query the metrics for a given workload using the CLI, here's an example using Experiments (the Deployments and Notebooks syntax are the same).
1
Usage: gradient experiments metrics [OPTIONS] COMMAND [ARGS]...
2
3
Read experiment metrics
4
5
Options:
6
--help Show this message and exit.
7
8
Commands:
9
get Get experiment metrics
10
stream Watch live experiment metrics
11
Copied!

Get a single value for a given metric:

Syntax

1
gradient experiments metrics get --id <experiment id>
Copied!

Parameters

1
Usage: gradient experiments metrics get [OPTIONS]
2
3
Get experiment metrics. Shows CPU and RAM usage by default
4
5
Options:
6
--id TEXT ID of the experiment [required]
7
--metric [cpuPercentage|memoryUsage|gpuMemoryFree|gpuMemoryUsed|gpuPowerDraw|gpuTemp|gpuUtilization|gpuMemoryUtilization]
8
One or more metrics that you want to read.
9
Defaults to cpuPercentage and memoryUsage
10
--interval TEXT Interval
11
--start [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
12
Timestamp of first time series metric to
13
collect
14
--end [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
15
Timestamp of last time series metric to
16
collect
17
--apiKey TEXT API key to use this time only
18
--optionsFile PATH Path to YAML file with predefined options
19
--createOptionsFile PATH Generate template options file
20
--help Show this message and exit.
21
Copied!

Example command to get CPU usage in %:

1
gradient experiments metrics get --id <experiment id> --metric cpuPercentage
Copied!

Stream metrics:

Syntax

1
gradient experiments metrics stream --id <experiment id>
Copied!

Parameters

1
Usage: gradient experiments metrics stream [OPTIONS]
2
3
Get experiment metrics. Shows CPU and RAM usage by default
4
5
Options:
6
--id TEXT ID of the experiment [required]
7
--metric [cpuPercentage|memoryUsage|gpuMemoryFree|gpuMemoryUsed|gpuPowerDraw|gpuTemp|gpuUtilization|gpuMemoryUtilization]
8
One or more metrics that you want to read.
9
Defaults to cpuPercentage and memoryUsage
10
--interval TEXT Interval
11
--start [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
12
Timestamp of first time series metric to
13
collect
14
--end [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
15
Timestamp of last time series metric to
16
collect
17
--apiKey TEXT API key to use this time only
18
--optionsFile PATH Path to YAML file with predefined options
19
--createOptionsFile PATH Generate template options file
20
--help Show this message and exit.
Copied!
Last modified 3mo ago
Copy link