Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

ENABLE_DIAGNOSTIC_INSTRUCTIONS

Stored procedure ENABLE_DIAGNOSTIC_INSTRUCTIONS is a Snowflake SQL stored procedure that prints out instructions on how to enable diagnostics and share it with Sundeck helps us know when users are experiencing any errors in the Snowflake Native App so we can fix them as soon as possible.

This procedure is defined in the database SUNDECK (database where Snowflake NativeApp is installed) schema ADMIN. ACCOUNTADMIN privilege is required to run this stored procedure.

Syntax

ENABLE_DIAGNOSTIC_INSTRUCTIONS()

Arguments

None

Returns

text with instructions
instructions on how to set up and enable diagnostics

Example:

coral#COMPUTE_WH@SUNDECK.ADMIN>call ADMIN.ENABLE_DIAGNOSTIC_INSTRUCTIONS();
+----------------------------------------------------------------------------------------------------------------------------------------+
| ENABLE_DIAGNOSTIC_INSTRUCTIONS                                                                                                         |
|----------------------------------------------------------------------------------------------------------------------------------------|
|                                                                                                                                        |
| If you haven't already configured an event table for your account, follow these steps:                                                 |
|                                                                                                                                        |
| # Enable Event Table                                                                                                                   |
|                                                                                                                                        |
| These commands will create an event table and set it as the default event                                                              |
| table for your account. Be sure to include use a database and schema that exists in your account.                                      |
|                                                                                                                                        |
| -- Double check that there is no event table already set for your account before proceeding!                                           |
| SHOW PARAMETERS LIKE 'EVENT_TABLE' IN ACCOUNT;                                                                                         |
|                                                                                                                                        |
| -- Create a database                                                                                                                   |
| CREATE DATABASE my_database;                                                                                                           |
|                                                                                                                                        |
| -- Create the event table in that database                                                                                             |
| CREATE EVENT TABLE my_database.public.my_events;                                                                                       |
|                                                                                                                                        |
| -- Set this event table as the default for your account                                                                                |
| ALTER ACCOUNT SET EVENT_TABLE = my_database.public.my_events;                                                                          |
|                                                                                                                                        |
| You can also follow the Snowflake instructions https://docs.snowflake.com/en/developer-guide/logging-tracing/event-table-setting-up to |
| set up an event table if you prefer.                                                                                                   |
|                                                                                                                                        |
| # Enable Diagnostic Sharing with Sundeck for the Sundeck Native App                                                                                 |
|                                                                                                                                        |
| Sharing diagnostics with Sundeck helps us know when users are experiencing any errors in the Sundeck Native App                                     |
| so we can fix them as soon as possible. To enable this, please run the following:                                                      |
|                                                                                                                                        |
| ALTER APPLICATION SUNDECK SET SHARE_EVENTS_WITH_PROVIDER = true;                                                                     |
|                                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------------------------------+
1 Row(s) produced.