<service_name>!SPCS_GET_METRICS¶

Returns the metrics that Snowflake collected for the specified service. For more information, see Access platform metrics.

Note

The function is supported only for services and jobs created in release 9.20 or later.

See also:: Monitoring Services

Syntax¶

<service_name>!SPCS_GET_METRICS(
    [ START_TIME => <constant_expr> ],
    [ END_TIME => <constant_expr> ] )

Copy

Arguments¶

START_TIME => constant_expr

Start time (in TIMESTAMP_LTZ format) for the time range from which to retrieve metrics. For available functions to construct data, time, and timestamp data, see Date & time functions.

If the START_TIME isn’t specified, it defaults to one day ago.

END_TIME => constant_expr

End time (in TIMESTAMP_LTZ format) for the time range from which to retrieve metrics.

If END_TIME isn’t specified, it defaults to the current timestamp.

Output¶

The function returns the following columns:

Column	Data Type	Description
`TIMESTAMP`	TIMESTAMP_NTZ	Universal Coordinated Time (UTC) timestamp when Snowflake collected the metric.
`METRIC_NAME`	VARCHAR	Name of the metric.
`VALUE`	VARCHAR	Value of the metric.
`UNIT`	VARCHAR	Unit of the metric returned.
`INSTANCE_ID`	NUMBER	Name of the service instance if the metric is related to the service instance.
`CONTAINER_NAME`	VARCHAR	Name of the container if the metric is related to the container. For example, a volume metric won’t have container name.
`RESOURCE`	VARCHAR	Hardware — for example, GPU — the metrics is about. This column isn’t populated.
`RECORD`	OBJECT	Key-value pairs that provide metric information.
`RECORD_ATTRIBUTES`	OBJECT	Key-value pairs that provide additional information about the metric.

Access control requirements¶

A role used to execute this operation must have the following privileges at a minimum:

Privilege	Object	Notes
OWNERSHIP	Service

The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage notes¶

It can take a few minutes before metrics appear in the output.

Examples¶

Retrieve the metrics that Snowflake collected for the my_test_job job over the past day, the default.

SELECT * FROM TABLE(my_test_job!SPCS_GET_METRICS());

Copy

Retrieve the metrics that Snowflake collected for the my_test_job job over the past three days.

SELECT * from TABLE(my_test_job!SPCS_GET_METRICS(start_time => DATEADD('day', -3, CURRENT_TIMESTAMP())));

Copy

Retrieve metrics from the past day for the spcs_get_metrics job instance 0 in the container named main.

SELECT * FROM TABLE(my_test_job!SPCS_GET_METRICS())
 WHERE instance_id = 0 AND container_name = 'main';

Copy