ResourceMonitor¶
Snowflake Documentation | Snowcap CLI label: resource_monitor
Manages the monitoring of resource usage within an account.
Examples¶
YAML¶
resource_monitors:
- name: some_resource_monitor
credit_quota: 1000
frequency: DAILY
start_timestamp: "2049-01-01 00:00"
end_timestamp: "2049-12-31 23:59"
notify_users:
- user1
- user2
triggers:
- threshold: 75
action: NOTIFY
- threshold: 100
action: SUSPEND
- threshold: 110
action: SUSPEND_IMMEDIATE
Python¶
resource_monitor = ResourceMonitor(
name="some_resource_monitor",
credit_quota=1000,
frequency="DAILY",
start_timestamp="2049-01-01 00:00",
end_timestamp="2049-12-31 23:59",
notify_users=["user1", "user2"],
triggers=[
{"threshold": 75, "action": "NOTIFY"},
{"threshold": 100, "action": "SUSPEND"},
{"threshold": 110, "action": "SUSPEND_IMMEDIATE"},
],
)
Fields¶
name(string, required) - The name of the resource monitor.credit_quota(int) - The amount of credits that can be used within the monitoring period.frequency(string or ResourceMonitorFrequency) - The interval at which the credit usage resets. Valid values:MONTHLY,DAILY,WEEKLY,YEARLY,NEVER. Defaults toMONTHLYwhenstart_timestampis set.start_timestamp(string) - The start time for the monitoring period (e.g.,"2024-01-01 00:00").end_timestamp(string) - The end time for the monitoring period.notify_users(list) - A list of user names to notify when thresholds are reached. Snowcap uppercases an unquoted name, as Snowflake does. Quote a name to keep its case, for example'"alice"'.triggers(list) - The actions to take at a percentage of the credit quota. Each trigger has athreshold, a whole percentage of 0 or more that can exceed 100, and anaction:NOTIFY,SUSPEND, orSUSPEND_IMMEDIATE. Snowflake replaces every trigger whenever one changes. Omittriggersto leave the triggers unmanaged. An empty list is rejected, because Snowflake has no statement that removes every trigger.owner(string or Role) - The role that owns the monitor. Defaults toACCOUNTADMIN. Snowcap creates the monitor asACCOUNTADMINand transfers it to this role. Later changes run as this role, because Snowflake lets only the owner alter or drop a monitor.