snow spcs service events

备注

只有当您拥有使用 Snowpark Container Services 的必要权限时，才能通过 Snowflake CLI 使用 Snowpark Container Services。

检索服务容器的平台事件。

语法

snow spcs service events
  <name>
  --container-name <container_name>
  --instance-id <instance_id>
  --since <since>
  --until <until>
  --first <first>
  --last <last>
  --all
  --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

实参

name

服务的标识符；例如：my_service。

选项

--container-name TEXT

容器的名称。

--instance-id TEXT

服务实例的 ID，从 0 开始。

--since TEXT

使用 Snowflake 间隔语法，提取在此时间之后发生的事件。

--until TEXT

使用 Snowflake 间隔语法，提取在此时间之前发生的事件。

--first INTEGER

只提取前 N 个事件。不能与 -- last 一起使用。

--last INTEGER

只提取后 N 个事件。不能与 --first 一起使用。

--all

提取所有列。默认值：False。

--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

显示此命令的帮助文本。

使用说明

备注

要使用此命令，您必须在 config.toml 文件中启用 enable_spcs_service_events 功能，如下所示：

[cli.features]
enable_spcs_service_events = true
Copy

  • 需要以下参数：

    • name

    • --container-name <name>

    • --instance-id <ID>

  • 您可以使用 --since 和 --until 基于时间的筛选器，返回指定时间段的事件。您可以将时间指定为相对时间，例如 :codenowrap:`1h`（小时）或 :codenowrap:`2d`（天）。

  • 您可以使用 --first 和 --last 选项，仅返回指定数目的事件。请注意，这些选项互斥。

示例

  • 检索特定服务的所有事件：

    snow spcs service events LOG_EVENT --container-name log-printer --instance-id 0
    Copy

  • 检索特定服务的事件子集：

    snow spcs service events LOG_EVENT --container-name log-printer --instance-id 0 --first 5
snow spcs service events LOG_EVENT --container-name log-printer --instance-id 0 --last 5
    Copy

  • 提取五分钟内的事件：

    snow spcs service events LOG_EVENT --container-name log-printer --instance-id 0 --since '5 minutes'
    Copy

  • 提取超过一小时的事件：

    snow spcs service events LOG_EVENT --container-name log-printer --instance-id 0 --until '1 hour'
    Copy

  • 检索显示所有列的所有事件：

    snow spcs service events LOG_EVENT --container-name log-printer --instance-id 0 --all --last 1
    Copy
    TIMESTAMP | DATABASE NAME | SCHEMA NAME | SERVICE NAME | INSTANCE NAME | CONTAINER NAME | SEVERITY | EVENT NAME | EVENT VALUE
-- | -- | -- | -- | -- | -- | -- | -- | --
2024-12-13 10:01:52.808692 | TESTDB | PUBLIC | LOG_EVENT | 0 | log-printer | INFO | CONTAINER.STATUS_CHANGE | { "message": "Running", "status": "READY" }
2024-12-14 22:27:25.420489 | TESTDB | PUBLIC | LOG_EVENT | 0 | log-printer | INFO | CONTAINER.STATUS_CHANGE | { "message": "Running", "status": "READY" }

  • 检索针对 JSON 输出格式化的事件：

    snow spcs service events LOG_EVENT --container-name log-printer --instance-id 0 --last 1 --format json
    Copy
    [
     {
         "TIMESTAMP": "2024-12-14T22:27:25.420489",
         "DATABASE NAME": "TESTDB",
         "SCHEMA NAME": "PUBLIC",
         "SERVICE NAME": "LOG_EVENT",
         "INSTANCE NAME": "0",
         "CONTAINER NAME": "log-printer",
         "SEVERITY": "INFO",
         "EVENT NAME": "CONTAINER.STATUS_CHANGE",
         "EVENT VALUE": "{\n  \"message\": \"Running\",\n  \"status\": \"READY\"\n}"
     }
 ]
语言: 中文