Working with resource monitors¶

Resource monitor properties¶

A resource monitor is a first-class object in Snowflake, consisting of the following properties:

Assignment of resource monitors¶

A single monitor can be set at the account level to control credit usage for all warehouses in your account.

In addition, a one or more warehouses can be assigned to a resource monitor, thereby controlling the credit usage for each assigned warehouse. Note, however, that a warehouse can be assigned to only a single resource monitor below the account level.

The following diagram illustrates a scenario in which one resource monitor is set at the account level and individual warehouses are assigned to two other resource monitors:

Based on this diagram:

• The credit quota for the entire account is 5000 for the interval (month, week, etc.), as controlled by Resource Monitor 1; if this quota is reached within the interval, the actions defined for the resource monitor (Suspend, Suspend Immediate, etc.) are enforced for all five warehouses.

• Warehouse 3 can consume a maximum of 1000 credits within the interval.

• Warehouse 4 and 5 can consume a maximum combined total of 2500 credits within the interval.

Note that the actual credits consumed by Warehouses 3, 4, and 5 may be less than their quotas if the quota for the account is reached first.

Warehouse suspension and resumption¶

The used credits for a resource monitor reflect the sum of credits consumed by all assigned warehouses within the specified interval, along with the cloud services used to support those warehouses during the same interval. If a monitor has a Suspend or Suspend Immediately action defined and its used credits reach the threshold for the action, any warehouses assigned to the monitor are suspended and cannot be resumed until one of the following conditions is met:

• The next interval, if any, starts, as dictated by the start date for the monitor.

• The credit quota for the monitor is increased.

• The credit threshold for the suspend action is increased.

• The warehouses are no longer assigned to the monitor.

• The monitor is dropped.

Resource monitor notifications¶

When a resource monitor reaches the threshold for an action, it generates a notification similar to the following notification:

Resource Monitor MY_ACCOUNT_MONITOR has reached 50% of its MONTHLY
quota of 500 credits which has triggered a <action> action.

The <action> is one of the following actions:

• NOTIFY

• SUSPEND

• SUSPEND_IMMEDIATE

Notification behavior depends on the type of resource monitor and whether or not notifications are enabled for an individual user. Notifications are sent as follows:

• For warehouse monitors, a notification is sent to the following users:

  • All account administrators who have enabled resource monitor notifications.

  • Non-administrator users in the notification list for the resource monitor.

• For account monitors, a notification is sent to the following users:

  • The account administrator with the OWNERSHIP privilege on the resource monitor if they have enabled notifications.

  • All account administrators who have enabled notifications using Classic Console.

  Note

  A non-administrator user can’t be added to the notification list for an account monitor.

DDL for resource monitors¶

Snowflake provides the following DDL commands for creating and using/managing resource monitors:

• CREATE RESOURCE MONITOR

• ALTER RESOURCE MONITOR

• SHOW RESOURCE MONITORS

• DROP RESOURCE MONITOR

In addition, the following DDL commands can be used to assign a resource monitor to a warehouse and determine whether a warehouse is assigned to a monitor:

• CREATE WAREHOUSE or ALTER WAREHOUSE

• SHOW WAREHOUSES

Access control privileges for resource monitors¶

By default, resource monitors can only be created by account administrators and, therefore, can only be viewed and maintained by them.

However, roles that have been granted the following privileges on specific resource monitors can view and modify the resource monitor as needed using SQL:

• MONITOR

• MODIFY

For more information, see Access control privileges and GRANT <privileges>.

Note that only account administrators can view and manage resource monitors via the Classic Console.

Enabling receipt of notifications¶

Before you can receive any notifications from resource monitors, you must enable notifications in the web interface and verify your email.

Snowsight:

To enable notifications, follow these steps:

1. Verify your email address if you haven’t already done so. For instructions on how to verify your email address, see Verify your email address.

2. Select your username, then select Profile

3. For Notifications, select Enable notifications from resource monitors.

   Note

   • If you haven’t verified your email address, the Notifications option isn’t available until you verify your email.

   • In Notifications, the Enable notifications from resource monitors option is only available to users with the ACCOUNTADMIN role in the following cases:

     • If there is a resource monitor assigned to the account and the account administrator has the OWNERSHIP privilege on the account monitor.

     • If there are warehouse monitors in the account. All account administrators can receive notifications for warehouse monitors.

Classic Console:

To enable notifications, follow these steps:

1. Verify your email address if you haven’t already done so. For instructions on how to verify your email address, see Verifying Your Email Address in the Classic Console.

2. Select the drop-down menu next to your name in the upper-right corner, and then select Preferences » Notifications.

3. Select one of the options.

Note

All account administrators who have enabled receipt of notifications using Classic Console receive notifications for account and warehouse monitors.

Creating resource monitors¶

Resource monitors can be created through either the web interface or SQL; however, only account administrators (i.e. users with the ACCOUNTADMIN role) can create resource monitors.

Modifying a resource monitor¶

You can modify the following properties for an existing resource monitor:

• Increase or decrease the credit quota for the monitor.

• Customize the schedule (frequency, start timestamp, and end timestamp) for the monitor.

• Add or remove actions, or modify the threshold percentages for existing actions.

• If the monitor is monitoring your account, convert it to monitor individual warehouses.

• If the monitor is monitoring individual warehouses:

  • Add or remove warehouses from the list.

  • Convert it to monitor your account.

Resource monitors can be modified through the web interface or SQL.

Snowsight:

1. Sign in to Snowsight and navigate to Admin » Cost Management.

2. Select Resource Monitors, then select a resource monitor.

3. Select the More menu (…) in top right corner. Select Edit.

Classic Console:

1. Select Account » Resource Monitors.

2. Select a resource monitor.

3. Select Edit.

SQL:

• To change the quota, customize the schedule, or add/remove/modify actions, execute an ALTER RESOURCE MONITOR statement.

  For example, to increase the credit quota for resource monitor limit1 to 3000, execute the following statement:

  ALTER RESOURCE MONITOR limit1 SET CREDIT_QUOTA=3000;
  

  Copy

  For more examples, see Examples.

• To change the monitor type, execute an ALTER WAREHOUSE or ALTER ACCOUNT statement.

  For example, to change resource monitor my_rm which currently monitors warehouses to monitor the account my_account, execute the following steps:

  1. Find all the warehouses the resource monitor my_rm is monitoring. Check the resource_monitor column for my_rm:

     SHOW WAREHOUSES;
     

     Copy

     Returns the following results:

     +--------+-----------+----------+---------+---------+--------+------------+------------+--------------+-------------+-----------+--------------+-----------+-------+-------------------------------+-------------------------------+-------------------------------+--------------+---------+------------------+---------+----------+--------+-----------+------------+--------+-----------------+
     | name   | state     | type     | size    | running | queued | is_default | is_current | auto_suspend | auto_resume | available | provisioning | quiescing | other | created_on                    | resumed_on                    | updated_on                    | owner        | comment | resource_monitor | actives | pendings | failed | suspended | uuid       | budget | owner_role_type |
     |--------+-----------+----------+---------+---------+--------+------------+------------+--------------+-------------+-----------+--------------+-----------+-------+-------------------------------+-------------------------------+-------------------------------+--------------+---------+------------------+---------+----------+--------+-----------+------------+--------+-----------------|
     | MY_WH1 | STARTED   | STANDARD | X-Small |       0 |      0 | N          | N          |          600 | true        |           |              |           |       | 2024-01-17 14:37:36.223 -0800 | 2024-01-17 14:37:36.325 -0800 | 2024-01-17 14:47:49.854 -0800 | MY_ROLE      |         | null             |       0 |        0 |      0 |         1 | 1222706972 | NULL   | ROLE            |
     | MY_WH2 | SUSPENDED | STANDARD | X-Small |       0 |      0 | N          | Y          |          600 | true        |           |              |           |       | 2023-12-20 13:50:50.972 -0800 | 2024-01-17 14:28:39.170 -0800 | 2024-01-17 14:37:57.560 -0800 | ACCOUNTADMIN |         | MY_RM            |       0 |        0 |      0 |         1 | 1222706948 | NULL   | ROLE            |
     | MY_WH3 | SUSPENDED | STANDARD | Small   |       0 |      0 | N          | N          |          600 | true        |           |              |           |       | 2024-01-17 14:26:26.911 -0800 | 2024-01-17 14:33:39.260 -0800 | 2024-01-17 14:38:31.192 -0800 | ACCOUNTADMIN |         | MY_RM            |       0 |        0 |      0 |         2 | 1222706960 | NULL   | ROLE            |
     +--------+-----------+----------+---------+---------+--------+------------+------------+--------------+-------------+-----------+--------------+-----------+-------+-------------------------------+-------------------------------+-------------------------------+--------------+---------+------------------+---------+----------+--------+-----------+------------+--------+-----------------+
     

     Resource monitor my_rm is monitoring two warehouses my_wh2 and my_wh3.

  2. Remove the resource monitor for both warehouses by executing the following statements:

     ALTER WAREHOUSE my_wh2 UNSET RESOURCE_MONITOR;
     
     ALTER WAREHOUSE my_wh3 UNSET RESOURCE_MONITOR;
     

     Copy

  3. Change the resource monitor to monitor the account by executing the following statement:

     ALTER ACCOUNT my_account SET RESOURCE_MONITOR = my_rm;
     

     Copy

Send resource monitor notifications to non-administrator users¶

Non-administrator users can only receive email notifications for warehouse monitors. Each non-administrator user must have a verified email address. You can add up to five non-administrator users to a warehouse monitor using the CREATE RESOURCE MONITOR or ALTER RESOURCE MONITOR command.

For example, to add users user1 and user2 to the warehouse monitor my_warehouse_rm, execute the following statement:

ALTER RESOURCE MONITOR my_warehouse_rm
  SET NOTIFY_USERS = (USER1, USER2);

For more information, see the NOTIFY_USERS parameter and Usage notes in the ALTER RESOURCE MONITOR topic.

To add non-administrator users to the notification list for a resource monitor when you create a resource monitor using SQL, see CREATE RESOURCE MONITOR.

Setting a resource monitor for your account¶

A resource monitor can be set for your account through the web interface or SQL.

Snowsight:

You can set the monitor type to account when you create a resource monitor. For more information, see Creating resource monitors.

Classic Console:

You can set the monitor type to Account when you create or modify a resource monitor:

• For more information about creating a resource monitor, see Creating resource monitors.

• For more information about modifying a resource monitor, see Modifying a resource monitor.

SQL:

In SQL, this task is performed in two steps:

1. Use the CREATE RESOURCE MONITOR command to create the resource monitor (if it doesn’t already exist).

   If the resource monitor does exist, to change a warehouse level resource monitor to monitor an account, see the example in the Modifying a Resource Monitor section.

2. Use the ALTER ACCOUNT command to set the resource monitor you created as the monitor for your account.

   For example, to set the account resource monitor to my_account_rm, execute the following statements:

   USE ROLE ACCOUNTADMIN;
   
   CREATE RESOURCE MONITOR my_account_rm WITH CREDIT_QUOTA=10000
     TRIGGERS ON 100 PERCENT DO SUSPEND;
   
   ALTER ACCOUNT SET RESOURCE_MONITOR = my_account_rm;
   

   Copy

To change the monitor type of an existing resource monitor from a warehouse monitor to an account monitor, see the example in the Modifying a Resource Monitor section.

To view whether a resource monitor is set for your account, use the web interface or the SHOW RESOURCE MONITORS command. The LEVEL column for a resource monitor displays whether it is set for your account or individual warehouses.

Assigning warehouses to a resource monitor¶

Warehouses can be assigned to an existing resource monitor through the web interface or SQL.

Snowsight:

1. Sign in to Snowsight and navigate to Admin » Cost Management.

2. Select Resource Monitors, then select a resource monitor.

3. Select the More menu (…) in top right corner. Select Edit.

4. If Monitor Type is Account, select Warehouse.

5. Select Warehouse to choose the warehouses to monitor.

Classic Console:

1. Select Account » Resource Monitors.

2. Select a resource monitor.

3. Select Edit.

4. If the monitor does not already have any warehouses assigned, select Monitor Level, then select Warehouse.

5. Select Warehouse and choose the warehouses to monitor.

SQL:

Use the ALTER WAREHOUSE command to assign a warehouse to a resource monitor.

For example, to monitor warehouse my_wh with the resource monitor my_rm, execute the following statement:

ALTER WAREHOUSE my_wh SET RESOURCE_MONITOR = my_rm;

Copy

Viewing resource monitors¶

Resource monitors can be viewed through the web interface or SQL.

Snowsight:

1. Sign in to Snowsight and navigate to Admin » Cost Management.

2. Select Resource Monitors to see a list of resource monitors for which your role has been granted the MODIFY or MONITOR privilege. Account administrator users can see all resource monitors.

3. Select a resource monitor to view detailed information about resource monitor settings, current credit usage, and a list of roles with privileges on the resource monitor.

Classic Console:

Note

Only users with the ACCOUNTADMIN role can view resource monitors using Classic Console.

1. Select Account » Resource Monitors.

SQL:

Using the ACCOUNTADMIN role or a role that has been granted the MONITOR or MODIFY privilege on the resource monitor, execute a SHOW RESOURCE MONITORS statement.

In addition, using any role, you can execute a SHOW WAREHOUSES statement to view the warehouses owned by the role (or for which the role has been granted USAGE privilege). The output includes the resource monitor, if any, to which the warehouse is assigned.

Replicating resource monitors¶

Resource monitors can be replicated from a source account to target accounts using a replication or failover group. For more information, see Resource monitor replication.