snow app events

从 Snowflake 中配置的事件表中提取此应用程序的事件。 默认情况下,此命令将提取当前连接账户中安装的应用程序生成的事件。要提取使用者账户中安装的应用程序生成的事件,请使用 --consumer-org 和 --consumer-account 选项。此操作需要设置事件共享,才能将事件路由到提供商账户:https://docs.snowflake.cn/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

继续轮询事件。意味着 --last 20,除非被覆盖或使用 --since 标志。默认值: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 文件中所定义。默认值:default

--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
语言: 中文