概要

Snowflake のインフラストラクチャーやデータ取得を効果的に監視・最適化することは難しい場合があります。問題が発生すると、リソースの非効率的な利用、コストの増加、カスタマーエクスペリエンスの低下につながる可能性があります。

Datadog の Snowflake インテグレーションを使用すると、パフォーマンス向上とコスト削減のために長時間実行されているクエリを発見し、リアルタイムでセキュリティ脅威を特定し、Snowpark ワークロードを監視することができます。

Snowflake データをパースした後、Datadog はすぐに使える概要ダッシュボードに収集された全リソースに関する洞察を入力します。また、Snowpark の実行失敗や異常な量のログイン試行に対するアラートを設定するための推奨モニターも提供します。

セットアップ

インストール

インストール手順は不要です。

構成

Snowflake アカウントに接続

1. Snowflake アカウントの URL を見つけます。

2. Snowflake インテグレーションタイルで、Snowflake アカウント URL を Account URL フィールドに入力します。

3. Resource Collection タブで、収集に興味のあるリソースを有効にします。

アカウントと組織の使用量メトリクス

以下の表では、収集されるメトリクスの種類と関連するメトリクスのプレフィックスについて説明します。

Logs

以下の表は、収集されるログの種類と含まれる Snowflake テーブルを示しています。

Cloud Cost Management

SNOWFLAKE.ORGANIZATION_USAGE.USAGE_IN_CURRENCY_DAILY テーブルから集計された Snowflake コストメトリクスを受信するために Cloud Cost Management を有効にします。これらのメトリクスを Cloud Cost Management と組み合わせて使用することで、コストと使用状況についてのさらなる洞察を得ることができます。

4. Snowflake を監視するために、Datadog 固有のロールとユーザーを作成します。Snowflake 環境で以下の一連のコマンドを実行し、Datadog にアクセス可能なユーザーを作成します。

 -- Snowflake の使用状況を監視するための新しいロールを作成します。ロールの名前はカスタマイズ可能です。
create role DATADOG;

-- 新しいロールに SNOWFLAKE データベースの特権を付与します。
grant imported privileges on database SNOWFLAKE to role DATADOG;

-- DATADOG ロールにデフォルトのウェアハウスの使用権限を付与します。
grant usage on warehouse <WAREHOUSE> to role DATADOG;

-- 以下の ACCOUNT_USAGE ビューを新しいロールに付与します。Snowflake アカウント使用状況のログやメトリクスを収集したい場合に行います。
grant database role SNOWFLAKE.OBJECT_VIEWER to role DATADOG;
grant database role SNOWFLAKE.USAGE_VIEWER to role DATADOG;
grant database role SNOWFLAKE.GOVERNANCE_VIEWER to role DATADOG;
grant database role SNOWFLAKE.SECURITY_VIEWER to role DATADOG;

-- 新しいロールに ORGANIZATION_USAGE_VIEWER を付与します。Snowflake の組織使用量メトリクスを収集したい場合に行います。
grant database role SNOWFLAKE.ORGANIZATION_USAGE_VIEWER to role DATADOG;

-- 新しいロールに ORGANIZATION_BILLING_VIEWER を付与します。Snowflake のコストデータを収集したい場合に実行します。
grant database role SNOWFLAKE.ORGANIZATION_BILLING_VIEWER to role DATADOG;

-- イベントテーブルのデータベース、スキーマ、およびテーブルへの使用権限を付与します。
grant usage on database <EVENT_TABLE_DATABASE> to role DATADOG;
grant usage on schema <EVENT_TABLE_DATABASE>.<EVENT_TABLE_SCHEMA> to role DATADOG;
grant select on table <EVENT_TABLE_DATABASE>.<EVENT_TABLE_SCHEMA>.<EVENT_TABLE_NAME> to role DATADOG;
grant application role SNOWFLAKE.EVENTS_VIEWER to role DATADOG;
grant application role SNOWFLAKE.EVENTS_ADMIN to role DATADOG;

-- ユーザーを作成します。
create user <USERNAME>
LOGIN_NAME = <USERNAME>
password = '<PASSWORD>'
default_warehouse =<WAREHOUSE>
default_role = DATADOG;

-- ユーザーにモニターロールを付与します。
grant role DATADOG to user <USERNAME>

5. キーペア認証を構成します。公開キーは先ほど作成したユーザーに割り当て、秘密キーは Datadog にアップロードし、Datadog が Snowflake アカウントに接続できるようにします。 a. Snowflake の指示に従って秘密キーを作成しアップロードします。Datadog は現在、暗号化されていない秘密キーのみをサポートしています。 b. Snowflake の指示に従って公開キーを作成します。 c. Snowflake の指示に従って先ほど作成したユーザーに公開キーを割り当てます。

カスタムメトリクス

Snowflake インテグレーションは、カスタムメトリクスを収集するためのカスタムクエリをサポートしています。ユーザーは、カスタム SQL クエリを記述して特定のデータを抽出し、Datadog でメトリクスやメトリクスタグとして表示することができます。

デフォルトでは、インテグレーションは共有の SNOWFLAKE データベースと ACCOUNT_USAGE スキーマに接続します。ACCOUNT_USAGE スキーマ以外のテーブルをクエリする場合は、構成したロールがテーブルにアクセスする適切な権限を持っていることを確認してください。

以下の表では、カスタムメトリクスを定義するために使用するフィールドについて説明します。

• Custom Column Name: これは metric_prefix に追加して完全なメトリクス名を形成するサフィックスです。例えば、my_custom_metric.count は完全なメトリクス名 snowflake.my_custom_metric.count になります。タイプが Tag Key と指定されている場合、この列は代わりにこのクエリで収集されたすべてのメトリクスにタグとして適用されます。
• Metadata Type: これは送信方法です (例: gauge、count、rate)。これも、この列の項目の名前と値 (<NAME>:<ROW_VALUE>) で行内の各メトリクスにタグを付けるように設定できます。 | はい |

注:

• 定義された列の少なくとも 1 つの項目は、メトリクスタイプ (gauge、count、rate、distribution) でなければなりません。
• 列内のアイテム数は、クエリで返された列数と同じである必要があります。
• 列の項目を定義する順番は、クエリで返される順番と同じでなければなりません。

例:

検証

結果を確認するには、Metric Summary を使用してメトリクスを検索します。

収集データ

メトリクス

イベント

Snowflake Web インテグレーションにはイベントは含まれていません。

サービスチェック

Snowflake Web インテグレーションには、サービスのチェック機能は含まれていません。

トラブルシューティング

ご不明な点は、Datadog のサポートチームまでお問合せください。

Agent チェック: Snowflake

Agent: 概要

このチェックは Datadog Agent を通じて Snowflake を監視します。Snowflake は SaaS の分析データウェアハウスで、完全にクラウドインフラストラクチャー上で動作します。 このインテグレーションはクレジット使用量、請求、ストレージ、クエリメトリクスなどを監視します。

Agent: セットアップ

以下の手順に従って、このチェックをインストールし、ホストで実行中の Agent に対して構成します。

Agent: インストール

Snowflake チェックは Datadog Agent パッケージに含まれています。

注: Snowflake チェックは Python 2 を使用する Datadog Agent v6 では利用できません。Agent v6 で Snowflake を使用するには、Datadog Agent v6 で Python 3 を使用するを参照するか、Agent v7 にアップグレードしてください。

Agent: 構成

1. Snowflake を監視するための Datadog 固有のロールとユーザーを作成します。Snowflake で、以下を実行して、ACCOUNT_USAGE スキーマにアクセスできるカスタムロールを作成します。

   注: デフォルトでは、このインテグレーションは SNOWFLAKE データベースと ACCOUNT_USAGE スキーマを監視します。ORGANIZATION_USAGE スキーマを監視する方法については、“組織データの収集” を参照してください。 このデータベースはデフォルトで利用可能であり、ACCOUNTADMIN ロールまたは ACCOUNTADMIN によって付与された任意のロールのユーザーのみが閲覧できます。

use role ACCOUNTADMIN;
grant imported privileges on database snowflake to role SYSADMIN;

use role SYSADMIN;

別の方法として、ACCOUNT_USAGE にアクセスできる DATADOG カスタムロールを作成することができます。

-- Snowflake の使用量を監視するための新しいロールを作成します。
create role DATADOG;

-- 新しいロールに SNOWFLAKE データベースの特権を付与します。
grant imported privileges on database SNOWFLAKE to role DATADOG;

-- DATADOG ロールにデフォルトのウェアハウスの使用権限を付与します。
grant usage on warehouse <WAREHOUSE> to role DATADOG;

-- ユーザーを作成します (既存のユーザーを使用する場合はこのステップをスキップします)。
create user DATADOG_USER
LOGIN_NAME = DATADOG_USER
password = '<PASSWORD>'
default_warehouse = <WAREHOUSE>
default_role = DATADOG
default_namespace = SNOWFLAKE.ACCOUNT_USAGE;

-- ユーザーにモニターロールを付与します。
grant role DATADOG to user <USER>;

2. snowflake.d/conf.yaml ファイルを Agent の構成ディレクトリのルートにある conf.d/ フォルダ内で編集し、Snowflake のパフォーマンスデータの収集を開始します。すべての利用可能な構成オプションについては、サンプルの snowflake.d/conf.yaml を参照してください。

       ## @param account - string - required
       ## Name of your account (provided by Snowflake), including the platform and region if applicable.
       ## For more information on Snowflake account names,
       ## see https://docs.snowflake.com/en/user-guide/connecting.html#your-snowflake-account-name
       #
     - account: <ORG_NAME>-<ACCOUNT_NAME>
   
       ## @param username - string - required
       ## Login name for the user.
       #
       username: <USER>
   
       ## @param password - string - required
       ## Password for the user
       #
       password: <PASSWORD>
   
       ## @param role - string - required
       ## Name of the role to use.
       ##
       ## By default, the SNOWFLAKE database is only accessible by the ACCOUNTADMIN role. Snowflake recommends
       ## configuring a role specific for monitoring:
       ## https://docs.snowflake.com/en/sql-reference/account-usage.html#enabling-account-usage-for-other-roles
       #
       role: <ROLE>
   
       ## @param min_collection_interval - number - optional - default: 15
       ## This changes the collection interval of the check. For more information, see:
       ## https://docs.datadoghq.com/developers/write_agent_check/#collection-interval
       ##
       ## NOTE: Most Snowflake ACCOUNT_USAGE views are populated on an hourly basis,
       ## so to minimize unnecessary queries, set the `min_collection_interval` to 1 hour.
       #
       min_collection_interval: 3600
   
       # @param disable_generic_tags - boolean - optional - default: false
       # Generic tags such as `cluster` will be replaced by <INTEGRATION_NAME>_cluster to avoid
       # getting mixed with other integration tags.
       # disable_generic_tags: true
   

   In the default `conf.yaml`, the min_collection_interval is 1 hour. Snowflake metrics are aggregated by day, you can increase the interval to reduce the number of queries.
   Note: Snowflake ACCOUNT_USAGE views have a known latency of 45 minutes to 3 hours.

3. Agent を再起動します。

組織データの収集

デフォルトでは、このインテグレーションは ACCOUNT_USAGE スキーマを監視しますが、代わりに組織レベルのメトリクスを監視するように設定することができます。

組織メトリクスを収集するには、インテグレーションの構成でスキーマフィールドを ORGANIZATION_USAGE に変更し、min_collection_interval を 43200 に増やします。ほとんどの組織クエリのレイテンシーが最大 24 時間であるため、これにより Snowflake へのクエリ数を減らすことができます。

注: 組織のメトリクスを監視するには、user が ORGADMIN ロールを持っている必要があります。

    - schema: ORGANIZATION_USAGE
      min_collection_interval: 43200

デフォルトでは、一部の組織メトリクスのみが有効になっています。利用可能なすべての組織メトリクスを収集するには、metric_groups 構成オプションを使用します。

    metric_groups:
      - snowflake.organization.warehouse
      - snowflake.organization.currency
      - snowflake.organization.credit
      - snowflake.organization.storage
      - snowflake.organization.contracts
      - snowflake.organization.balance
      - snowflake.organization.rate
      - snowflake.organization.data_transfer

さらに、アカウントと組織の両方のメトリクスを同時に監視することができます。

    instances:
    - account: example-inc
      username: DATADOG_ORG_ADMIN
      password: '<PASSWORD>'
      role: SYSADMIN
      schema: ORGANIZATION_USAGE
      database: SNOWFLAKE
      min_collection_interval: 43200

    - account: example-inc
      username: DATADOG_ACCOUNT_ADMIN
      password: '<PASSWORD>'
      role: DATADOG_ADMIN
      schema: ACCOUNT_USAGE
      database: SNOWFLAKE
      min_collection_interval: 3600

複数環境のデータ収集

複数の Snowflake 環境のデータを収集したい場合は、snowflake.d/conf.yaml ファイルに各環境をインスタンスとして追加します。例えば、DATADOG_SYSADMIN と DATADOG_USER という 2 つのユーザーのデータを収集する必要がある場合:

instances:
  - account: example-inc
    username: DATADOG_SYSADMIN
    password: '<PASSWORD>'
    role: SYSADMIN
    database: EXAMPLE-INC

  - account: example-inc
    username: DATADOG_USER
    password: '<PASSWORD>'
    role: DATADOG_USER
    database: EXAMPLE-INC

プロキシ構成

Snowflake はプロキシ構成のための環境変数を設定することを推奨しています。

また、snowflake.d/conf.yaml の init_config 内で proxy_host、proxy_port、proxy_user、proxy_password を設定することもできます。

注: Snowflake はプロキシ構成を自動的にフォーマットし、標準プロキシ環境変数を設定します。 これらの変数は、Docker、ECS、Kubernetes のようなオーケストレーターを含む、インテグレーションからのすべてのリクエストに影響します。

Snowflake 構成へのプライベート接続

Snowflake でプライベート接続 (例えば AWS PrivateLink) が有効になっている場合、account 構成オプションを以下の形式に更新することで Snowflake インテグレーションを構成できます。

      - account: <ACCOUNT>.<REGION_ID>.privatelink

Snowflake カスタムクエリ

Snowflake インテグレーションは、カスタムクエリに対応しています。デフォルトで、インテグレーションは共有 SNOWFLAKE データベースと ACCOUNT_USAGE スキーマに接続します。

別のスキーマやデータベースでカスタムクエリを実行するには、サンプルの snowflake.d/conf.yaml に別のインスタンスを追加し、database と schema オプションを指定します。 ユーザーとロールが指定されたデータベースまたはスキーマにアクセスできることを確認してください。

コンフィギュレーションオプション

custom_queries には以下のオプションがあります。

• name: これは metric_prefix に追加して完全なメトリクス名を形成するサフィックスです。type が tag と指定されている場合、この列はこのクエリで収集されたすべてのメトリクスにタグとして適用されます。
• type: これは送信方法です (gauge、count、rate など)。これを tag に設定して、この列の項目の名前と値 (<NAME>:<ROW_VALUE>) で行内の各メトリクスにタグを付けることもできます。 | | tags | いいえ | 各メトリクスに適用する静的タグのリスト。 |

注:

• 定義された columns の少なくとも 1 つの項目は、メトリクスタイプである必要があります (例えば、gauge、count、rate)。

• 列の項目の数は、クエリで返される列の数と同じでなければなりません。

• columns の項目を定義する順番は、クエリで返される順番と同じでなければなりません。

custom_queries:
  - query: select F3, F2, F1 from Table;
    columns:
      - name: f3_metric_alias
        type: gauge
      - name: f2_tagkey
        type: tag
      - name: f1_metric_alias
        type: count
    tags:
      - test:snowflake

例

次の例は、データベース名、スキーマ名、ウェアハウス名でタグ付けされた QUERY_HISTORY ビュー内のすべてのクエリをカウントするクエリです。

select count(*), DATABASE_NAME, SCHEMA_NAME, WAREHOUSE_NAME from QUERY_HISTORY group by 2, 3, 4;

カスタムクエリの構成

instances のカスタムクエリのコンフィギュレーションは、以下のようになります。

custom_queries:
  - query: select count(*), DATABASE_NAME, SCHEMA_NAME, WAREHOUSE_NAME from QUERY_HISTORY group by 2, 3, 4;
    columns:
      - name: query.total
        type: gauge
      - name: database_name
        type: tag
      - name: schema_name
        type: tag
      - name: warehouse_name
        type: tag
    tags:
      - test:snowflake

Agent: 検証

Agent の status サブコマンドを実行し、Checks セクションの下に snowflake があるか確認します。

Agent: データ収集

Agent: メトリクス

このチェックで提供されるメトリクスのリストについては、メトリクスを参照してください。

Agent: イベント

Snowflake には、イベントは含まれません。

Agent: サービスチェック

snowflake.can_connect チェックが Snowflake 認証情報を認証できない場合、CRITICAL を返します。それ以外の場合は OK を返します。 ステータス: ok, critical

Agent: トラブルシューティング

ご不明な点は、Datadog のサポートチームまでお問合せください。

その他の参考資料

お役に立つドキュメント、リンクや記事:

• Datadog で Snowflake を監視する
• Datadog で Snowflake Snowpark を監視する