Snow Spcs サービスメトリクス

注釈

Snowpark Container Servicesを使用するために必要な権限を持っている場合にのみ、Snowflake CLI からSnowpark Container Servicesを使用できます。

サービス・コンテナーのプラットフォーム・メトリクスを取得します。

構文

snow spcs service metrics
  <name>
  --container-name <container_name>
  --instance-id <instance_id>
  --since <since>
  --until <until>
  --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>
  --oauth-client-id <oauth_client_id>
  --oauth-client-secret <oauth_client_secret>
  --oauth-authorization-url <oauth_authorization_url>
  --oauth-token-request-url <oauth_token_request_url>
  --oauth-redirect-uri <oauth_redirect_uri>
  --oauth-scope <oauth_scope>
  --oauth-disable-pkce
  --oauth-enable-refresh-tokens
  --oauth-enable-single-use-refresh-tokens
  --client-store-temporary-credential
  --format <format>
  --verbose
  --debug
  --silent
  --enhanced-exit-codes
Copy

引数

name

サービスの識別子。例：my_service

オプション

--container-name TEXT

コンテナの名前。

--instance-id TEXT

0から始まるサービスインスタンスの ID。

--since TEXT

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

--until TEXT

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

--all

すべての列を取得します。デフォルト: false。

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

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

--mfa-passcode TEXT

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

--enable-diag

接続診断レポートを作成するかどうか。デフォルト: false。

--diag-log-path TEXT

生成されたレポートのパス。デフォルトはシステム仮ディレクトリです。デフォルト: <system_temporary_directory>.

--diag-allowlist-path TEXT

allowlist パラメーターを含む JSON ファイルへのパス。

--oauth-client-id TEXT

Snowflake統合のためにIDプロバイダーが提供するクライアントIDの値。

--oauth-client-secret TEXT

Snowflake 統合用に ID プロバイダーが提供するクライアントシークレットの値。

--oauth-authorization-url TEXT

認証コードをドライバーに提供する ID プロバイダーエンドポイント。

--oauth-token-request-url TEXT

ドライバーにアクセストークンを供給する ID プロバイダーのエンドポイント。

--oauth-redirect-uri TEXT

URI 認証コードのリダイレクトに使用します。

--oauth-scope TEXT

ID プロバイダー承認リクエストで要求された範囲。

--oauth-disable-pkce

コード交換の証明キー (PKCE) を無効にします。デフォルト: False。

--oauth-enable-refresh-tokens

実際のアクセストークンが古くなった場合に、サイレント再認証コードを有効にします。デフォルト: False。

--oauth-enable-single-use-refresh-tokens

シングルユース・更新・トークンのセマンティクスにオプトインするかどうか。デフォルト: False。

--client-store-temporary-credential

仮認証情報を保存します。

--format [TABLE|JSON]

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

--verbose, -v

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

--debug

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

--silent

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

--enhanced-exit-codes

終了エラーコードをエラーのタイプによって区別します。デフォルト: false。

--help

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

使用上の注意

  • 以下のパラメーターが必要です。

    • name

    • --container-name <name>

    • --instance-id <ID>

  • --since and --until 時間ベースのフィルターを使用して、指定した期間のメトリクスを返すことができます。1h (時間) や 2d (日) のように、相対時間として時間を指定することができます。

例

  • 特定のサービスのメトリクスを取得します。

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

  • 特定のサービスのメトリクスのサブセットを取得します。

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

  • 過去 2 時間より古いメトリクスを取得します。

    snow spcs service metrics LOG_EVENT --container-name log-printer --instance-id 0 --until '2 hours'
    Copy

  • 1時間より新しいメトリクスを取得します。

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

  • すべての列を含むメトリクスを取得します。

    snow spcs service metrics LOG_EVENT --container-name log-printer --instance-id 0 --all
    Copy
    | TIMESTAMP                  | DATABASE NAME | SCHEMA NAME | SERVICE NAME | INSTANCE NAME | CONTAINER NAME | METRIC NAME                | METRIC VALUE          |
|----------------------------|---------------|-------------|--------------|---------------|----------------|----------------------------|-----------------------|
| 2024-12-18 18:10:25.202000 | TESTDB        | PUBLIC      | LOG_EVENT    | 0             | log-printer    | container.cpu.limit        | 1                     |
| 2024-12-18 18:10:25.202000 | TESTDB        | PUBLIC      | LOG_EVENT    | 0             | log-printer    | container.memory.requested | 536870912             |
| 2024-12-18 18:10:25.202000 | TESTDB        | PUBLIC      | LOG_EVENT    | 0             | log-printer    | container.memory.limit     | 6442450944            |
| 2024-12-18 18:10:25.202000 | TESTDB        | PUBLIC      | LOG_EVENT    | 0             | log-printer    | container.cpu.requested    | 0.5                   |
| 2024-12-18 18:10:08.957000 | TESTDB        | PUBLIC      | LOG_EVENT    | 0             | log-printer    | container.cpu.usage        | 0.0004400012665396536 |
| 2024-12-18 18:10:08.957000 | TESTDB        | PUBLIC      | LOG_EVENT    | 0             | log-printer    | container.memory.usage     | 1323008               |
    Copy

  • JSON 出力用にフォーマットされたメトリクスを取得します。

    snow spcs service metrics LOG_EVENT --container-name log-printer --instance-id 0 --format json
    Copy
    [
    {
        "TIMESTAMP": "2024-12-14T22:27:25.420489",
        "SERVICE NAME": "LOG_EVENT",
        "INSTANCE NAME": "0",
        "CONTAINER NAME": "log-printer",
        "METRIC TYPE": "CPU_UTILIZATION",
        "VALUE": "75.4"
    }
]
言語: 日本語