アプリのイベントトレースを設定する¶

アプリのログメッセージ、トレースイベント、メトリクスの表示¶

アプリが発行するログメッセージやトレースイベントを表示するには、コンシューマーは自分のアカウントでイベントテーブルを設定し、これらの情報を収集する必要があります。詳細については、 イベントテーブルの設定 をご参照ください。

イベント定義について¶

イベント定義は、アプリがプロバイダーとログメッセージやトレースイベントを共有する方法を指定します。イベント定義は、プロバイダーによって設定されたログメッセージおよびトレースイベントレベルのフィルターとして機能します。プロバイダーは、新しいバージョンまたはパッチが公開されたときにアプリのイベント定義を指定します。

プロバイダーは、イベント定義を必須またはオプションに設定できます。

• アプリがインストールされると、必要なイベント定義が自動的に有効になります。アプリによって発行されたイベント定義を収集するには、コンシューマーはイベントテーブルを作成し、それを自分のアカウントのアクティブなイベントテーブルとして設定する必要があります。

• オプションのイベント定義は、必要に応じてコンシューマーが有効化または無効化できます。オプションのイベント定義にはアクティブなイベントテーブルが必要ですが、アプリのインストールや使用には必要ありません。

サポートされるイベント定義¶

次の表に、現在サポートされているイベント定義を示します。

型	名前	説明	フィルター
All	SNOWFLAKE$ALL	アプリが発行するすべてのログメッセージとトレースイベントを共有します。	*
Errors and warnings	SNOWFLAKE$ERRORS_AND_WARNINGS	エラー、警告、致命的なイベントに関連するログを共有します。	RECORD_TYPE = ‘LOG’ AND RECORD:severity_text in (‘FATAL’, ‘ERROR’, ‘WARN’)
Metrics	SNOWFLAKE$METRICS	Snowflakeが生成する CPU とメモリメトリクスを共有します。	RECORD_TYPE = ‘LOG’ AND RECORD:severity_text in ('ALWAYS', 'ON_EVENT', 'OFF')
Traces	SNOWFLAKE$TRACES	アプリケーション内のユーザーアクティビティと移動の詳細なトレースを共有します。	RECORD_TYPE in (‘SPAN’, ‘SPAN_EVENT’)
Usage logs	SNOWFLAKE$USAGE_LOGS	ユーザーアクションとアプリイベントに関連する高レベルのログを共有します。	RECORD_TYPE = LOG AND RECORD:severity_text = ‘INFO’
Debug logs	SNOWFLAKE$DEBUG_LOGS	アプリのトラブルシューティングに使用される技術ログを共有します。	RECORD_TYPE = ‘LOG’ AND RECORD:severity_text in (‘DEBUG’, ‘TRACE’)

コンシューマーがイベント定義を使用する際の考慮事項¶

コンシューマーは既存の SHARE_EVENTS_WITH_PROVIDER プロパティを引き続き使用できますが、次の制限があります。

• アプリが OPTIONALALL イベント定義のみを使用する場合、 SHARE_EVENTS_WITH_PROVIDER プロパティを true に設定するとイベント共有が有効になり、 false に設定するとイベント共有が無効になります。

  これは、プロバイダーがマニフェストファイルに OPTIONAL ALL イベント定義を明示的に追加した場合、またはアプリが既存のイベント共有機能から移行された場合に適用されます。

• プロバイダーがマニフェストファイルに必須およびオプションのイベント定義を追加する場合、 SHARE_EVENTS_WITH_PROVIDER プロパティを true に設定すると、すべてのイベント定義が有効になります。対照的に、プロバイダーがオプションのイベント定義のみを追加する場合にのみ、 SHARE_EVENTS_WITH_PROVIDER プロパティを false に設定できます。

  SHARE_EVENTS_WITH_PROVIDER は、すべてのイベント定義が有効になっている場合にのみ TRUE となり、それ以外の場合は FALSE となります。

アプリのイベント共有を有効にするための前提条件¶

アプリインスタンスのイベント共有を有効にするには、以下の前提条件を満たす必要があります。

• MANAGE EVENT SHARING グローバル権限を持つロールを使用する。ACCOUNTADMIN ロールはデフォルトでこの権限を持っており、他のロールにこの権限を付与できる。

• コンシューマーのアカウントにイベントテーブルを設定する。

Snowsight を使用してイベント共有を有効にする¶

1. Snowsight にサインインします。

2. ナビゲーションメニューで Data Products » Apps を選択します。

3. アプリを選択します。

4. ツールバーの Settings アイコンを選択します。

5. Events and logs タブを選択します。

6. Events and logs sharing エリアの基になる、キャプチャしたいイベントのスライダーを動かします。

7. プロバイダーがアプリのイベント定義を定義している場合:

   1. スライダーを使用してオプションのイベント定義を有効にします。デフォルトでは、すべてのイベントタイプが有効になっています。

   2. Save を選択します。

8. イベントテーブルが選択されていない場合は、 Event table location のリストからイベントテーブルを選択します。

   注意

   Snowsight のイベントテーブルを変更する際はご注意ください。各Snowflakeアカウントは、アカウント内で生成されたすべてのイベントに対して単一のイベントテーブルを使用します。イベントテーブルを変更すると、そのアカウントで生成されたすべてのイベントが新しい場所に保存されます。

SQL を使用してイベント共有を有効にする¶

1. アプリのイベント定義を決定するには、 SHOW TELEMETRY EVENT DEFINITIONS コマンドを使用します。

   SHOW TELEMETRY EVENT DEFINITIONS IN APPLICATION hello_snowflake;
   

   Copy

   プロバイダーがイベント定義を使用するようにアプリを構成しなかった場合、 type 列に ALL と表示されます。それ以外の場合、このコマンドはアプリに指定されたオプションのイベント定義を一覧表示します。

2. アプリに必要なイベント定義が含まれている場合は、 ALTER APPLICATION コマンドを使用して有効にします。

   ALTER APPLICATION hello_snowflake SET AUTHORIZE_TELEMETRY_EVENT_SHARING=true
   

   Copy

   このコマンドは、必須のイベント定義をすべて有効にしますが、オプションのイベント定義は有効にしません。

   注釈

   アプリに必要なイベント定義を有効にした後は、イベント共有を無効にすることはできません。

3. アプリにオプションイベント定義が含まれている場合、次の例に示すように、 ALTER APPLICATION を使用してそれらを有効にします。

   ALTER APPLICATION hello_snowflake SET SHARED TELEMETRY EVENTS ('SNOWFLAKE$TRACES', 'SNOWFLAKE$DEBUG_LOGS');
   

   Copy

   この例では、 SNOWFLAKE$TRACES と SNOWFLAKE$DEBUG_LOGS を SHOW TELEMETRY EVENT DEFINITIONS コマンドの出力に基づき、有効にしています。

4. イベントのトレースとログが有効になっていることを確認するには、 DESCRIBE APPLICATION コマンドを使用します。

   DESC APPLICATION hello_snowflake;
   

   Copy

   出力の authorize_telemetry_event_sharing 行と share_events_with_provider 行は、イベント共有が有効になっているかどうかを示します。

SQL を使用したイベント共有の有効化（非推奨関数）¶

アプリのイベント共有を有効にするには、 ALTER APPLICATION コマンドを実行して、 SHARE_EVENTS_WITH_PROVIDER を TRUE に設定します。例:

ALTER APPLICATION HelloSnowflake SET SHARE_EVENTS_WITH_PROVIDER = TRUE;

アプリのイベント共有ステータスを表示するには、次の例のように DESCRIBE APPLICATION コマンドを使用します。

DESC APPLICATION HelloSnowflake;

SHARE_EVENTS_WITH_PROVIDER は、アプリのイベント共有のステータスを示します。

イベントログメッセージとトレースイベントを表示するには、 Snowsight を使用します。¶

1. Snowsight にサインインします。

2. ナビゲーションメニューで Data Products » Apps を選択します。

3. アプリを選択します。

4. ツールバーで、 Settings を選択します。

5. App events タブを選択します。

6. Event logging セクションで、 View logs を選択します。

新しいワークシートが開き、アプリのログメッセージとトレースイベントを表示する SELECT ステートメントがあらかじめ入力されています。

イベントログメッセージとトレースイベントを表示するには、 SQL を使用します。¶

次の例に示すように、イベントログメッセージとトレースイベントをクエリするには、 SELECT コマンドを使用します。

SELECT
  TIMESTAMP as time,
  RESOURCE_ATTRIBUTES['snow.executable.name'] as executable,
  RECORD['severity_text'] as severity,
  VALUE as message
FROM
  "EVENT_LOG"."PUBLIC"."CONSUMER_EVENT_TABLE"
WHERE RESOURCE_ATTRIBUTES['snow.application.name'] = 'YOUR_APP_NAME'

このコマンドは、 YOUR_APP_NAME というアプリのイベントテーブル CONSUMER_EVENT_TABLE に保存されているログメッセージとトレースイベントをすべて返します。

ログメッセージまたはトレースイベントがプロバイダーと共有されているかどうかを判断する¶

RECORD_ATTRIBUTES 列には snow.application.shared フィールドが含まれます。このフィールドの値が TRUE の場合、ログメッセージまたはトレースイベントはプロバイダーと共有されます。それ以外の場合は、ログメッセージまたはイベントは共有されません。