snow app events

Snowflakeで構成されたイベントテーブルから、このアプリのイベントを取得します。デフォルトでは、このコマンドは現在の接続アカウントにインストールされているアプリによって生成されたイベントを取得します。コンシューマー・アカウントにインストールされたアプリが生成したイベントを取得するには、-consumer-org オプションと --consumer-account オプションを使用します。これには、イベントをプロバイダー・アカウントにルーティングするよう、イベント共有が設定されている必要があります。https://docs.snowflake.com/en/developer-guide/native-apps/setting-up-logging-and-events

構文

snow app events
  --since <since>
  --until <until>
  --type <record_types>
  --scope <scopes>
  --consumer-org <consumer_org>
  --consumer-account <consumer_account>
  --consumer-app-hash <consumer_app_hash>
  --first <first>
  --last <last>
  --follow
  --follow-interval <follow_interval>
  --package-entity-id <package_entity_id>
  --app-entity-id <app_entity_id>
  --project <project_definition>
  --env <env_overrides>
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --private-key-file <private_key_file>
  --token-file-path <token_file_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --format <format>
  --verbose
  --debug
  --silent
Copy

引数

なし

オプション

--since TEXT

Snowflakeインターバル構文で、この時間前より新しいイベントを取得します。

--until TEXT

Snowflakeインターバル構文で、この時間前より古いイベントを取得します。

--type [log |span| span_event]

結果を特定のレコード型に制限します。複数回指定可能です。デフォルト: []

--scope TEXT

結果を特定のスコープ名に制限します。複数回指定可能です。デフォルト: []

--consumer-org TEXT

コンシューマー組織名。

--consumer-account TEXT

コンシューマーアカウントの組織名。

--consumer-app-hash TEXT

コンシューマー・アプリケーション名の SHA-1ハッシュ。

--first INTEGER

最初のNのイベントのみを取得します。--lastでは使用できません。デフォルト: -1

--last INTEGER

直近のNのイベントのみを取得します。--firstでは使用できません。デフォルト: -1

--follow, -f

イベントのポーリングを続けます。上書きされるか、--sinceフラグが使用されない限り、--last 20を意味します。デフォルト: false。

--follow-interval INTEGER

--followフラグ使用時のポーリング間隔（秒）。デフォルト: 10

--package-entity-id TEXT

definition_versionが2以上のときに操作するパッケージ・エンティティの ID 。

--app-entity-id TEXT

definition_versionが2以上のときに操作するアプリケーション・エンティティの ID 。

-p, --project TEXT

Snowflakeプロジェクトが存在するパス。デフォルトは現在の作業ディレクトリです。

--env TEXT

key=value形式の文字列。テンプレートに使用される env セクションの変数をオーバーライドする。デフォルト: []

--connection, -c, --environment TEXT

config.toml ファイルで定義されている接続の名前。デフォルト: デフォルト

--host TEXT

接続用のホストアドレス。接続に指定された値を上書きします。

--port INTEGER

接続のポート。接続に指定された値を上書きします。

--account, --accountname TEXT

Snowflakeアカウントに割り当てられた名前。接続に指定された値を上書きします。

--user, --username TEXT

Snowflakeに接続するユーザー名。接続に指定された値を上書きします。

--password TEXT

Snowflakeのパスワード。接続に指定された値を上書きします。

--authenticator TEXT

Snowflakeの認証コード。接続に指定された値を上書きします。

--private-key-file, --private-key-path TEXT

Snowflake プライベートキーファイルへのパス。接続に指定された値を上書きします。

--token-file-path TEXT

Snowflake に接続する際に使用する OAuth トークンを含むファイルへのパス。

--database, --dbname TEXT

使用するデータベース。接続に指定された値を上書きします。

--schema, --schemaname TEXT

使用するデータベーススキーマ。接続に指定された値を上書きします。

--role, --rolename TEXT

使用するロール。接続に指定された値を上書きします。

--warehouse TEXT

使用するウェアハウス名。接続に指定された値を上書きします。

--temporary-connection, -x

構成で定義された接続ではなく、コマンドラインパラメーターで定義された接続を使用します。デフォルト: false。

--mfa-passcode TEXT

多要素認証（MFA）に使用するトークン。

--enable-diag

Pythonコネクター診断テストを実行します。デフォルト: false。

--diag-log-path TEXT

診断レポートパス。デフォルト: <temporary_directory>

--diag-allowlist-path TEXT

オプションの許可リストへの診断レポートパス。

--format [TABLE|JSON]

出力形式を指定します。デフォルト: TABLE

--verbose, -v

ログレベル info 以上のログエントリを表示します。デフォルト: false。

--debug

ログレベル debug 以上のログ エントリを表示します。デバッグログには追加情報が含まれます。デフォルト: false。

--silent

コンソールへの中間出力をオフにします。デフォルト: false。

--help

このコマンドのヘルプテキストを表示します。

使用上の注意

注釈

このコマンドを使用する前に、プロバイダーのSnowflakeアカウントのイベント処理を設定する必要があります。詳細については、 ロギング、トレース、メトリクス をご参照ください。

snow app events コマンドは、現在の接続アカウントにインストールされているネイティブ・アプリケーションによって生成されたイベントを取得します。

デフォルトでは、このコマンドは、現在の接続のアカウントにインストールされている Snowflake Native App によって生成されたイベントを取得します。コンシューマー・アカウントにインストールされた Snowflake Native App によって生成されたイベントを取得するには、 --consumer-org と --consumer-account オプションを使用します。これらのオプションは、イベントをプロバイダーアカウントにルーティングするために、 イベント共有がセットアップされている 必要があります。

例

  • プロバイダーアカウントにインストールされているアプリケーションのすべてのイベントを取得します。

    snow app events
    Copy

  • プロバイダー・アカウントにインストールされているアプリケーションのイベントのサブセットを取得します。

    # Limiting the number of events
snow app events --first 10
snow app events --last 10

# Narrowing the time range using interval syntax
snow app events --since '5 minutes'
snow app events --until '1 hour'

# Filtering events
snow app events --type log
snow app events --scope com.myapp.MyClass1 --scope com.myapp.MyClass2
    Copy

  • コンシューマー・インストールのイベントを取得します。

    snow app events --consumer-org <organization-name> --consumer-account <account-name>
    Copy

  • ハッシュ化されたアプリケーション名を使用して、コンシューマー・アプリケーションのイベントを取得します。

    snow app events --consumer-org <organization-name> --consumer-account <account-name> --consumer-app-hash cafc10bf6a5deb574ada0e3a009b63bbbe9bdb84
    Copy

  • JSON としてイベントを取得します。

    snow app events --format json
    Copy
言語: 日本語