継続的インテグレーション Content Validator

継続的インテグレーション(CI)Content Validator は、エラーのあるダッシュボードと Look を特定します。多くの場合、これらのエラーは LookML フィールドへの参照が不足していることが原因です。

CI Content Validator は、標準の Looker Content Validator と同様の検証を行いますが、いくつかの違いがあります。

  • CI Content Validator は、以下をサポートしています。

    • Looker デベロッパーが LookML リポジトリに pull リクエストを送信したときに自動的に実行されるように、またはCI スイートを手動で実行したときに手動で実行されるように、CI コンテンツ バリデータを構成できます。
    • CI Content Validator の結果のスコープを、特定の Looker コンテンツ フォルダ、または LookML プロジェクト内の特定のモデルと Explore に設定できます。デフォルトでは、CI Content Validator の結果は LookML プロジェクトに自動的にスコープされます。CI コンテンツ バリデータのスコーピングはポスト処理です。バリデータは Looker インスタンス全体で実行され、CI スイートの作成時に指定したスコープに結果がフィルタされます。
  • 標準の Looker Content Validator は、以下をサポートしています。

    • Looker Content Validator は手動でのみ実行できます。
    • Looker Content Validator のスコープを、特定の Looker コンテンツ フォルダまたは特定の LookML プロジェクトに設定できます。Looker コンテンツ バリデータのスコーピングは検証の前に行われ、バリデータはコンテンツ検証を開始したときに指定したフォルダとプロジェクトでのみ実行されます。
    • Looker Content Validator を使用すると、フィールド、ビュー、Explore、モデルの名前を置換したり、フィールドを削除したり、Look を削除したりできます。

CI スイートの作成または編集時に構成できるオプションの詳細については、このページのコンテンツ検証ツールのオプションをご覧ください。Content Validator の実行については、継続的インテグレーション スイートの実行のドキュメント ページをご覧ください。

実行結果ページでは、エラーが発生した Look またはダッシュボードごとにエラー メッセージとコンテンツへのリンクが表示されます。

コンテンツ バリデータの検出結果を示す継続的インテグレーションの結果ページ

Content Validator のオプション

継続的インテグレーション スイートを作成するときに、Content Validator の実行方法を構成するオプションをいくつか指定できます。オプションについては、このページの次のセクションで説明します。

クエリするデータ探索

デフォルトでは、Content Validator は LookML プロジェクト内のすべてのモデルと Explore に対してコンテンツ検証を実行します。

[クエリ対象の Explore] フィールドを使用して、コンテンツ検証に含める Explore とモデルを指定できます。

Explore は次の形式で指定します。model_name/explore_name

たとえば、thelook.model.lkml ファイルで users という名前と orders という名前の Explore を指定するには、thelook/users, thelook/orders と入力します。

このフィールドで Explore とモデルを指定する方法の詳細と例については、SQL Validator のドキュメント ページをご覧ください。

除外する Explore

デフォルトでは、Content Validator は LookML プロジェクト内のすべてのモデルと Explore に対してコンテンツ検証を実行します。

[除外する Explore] フィールドを使用して、コンテンツ検証から除外する Explore とモデルを指定できます。

Explore は次の形式で指定します。model_name/explore_name

このフィールドで Explore とモデルを指定する方法の詳細と例については、SQL Validator のドキュメント ページをご覧ください。

検証するフォルダ

フォルダ ID またはフォルダ ID のカンマ区切りのリストを指定することで、コンテンツ検証のスコープを Looker インスタンスの特定のコンテンツ フォルダに限定できます。

フォルダの ID を取得するには、Looker のメイン ナビゲーション メニューを使用してフォルダを開き、ブラウザの URL からフォルダ ID を取得します。フォルダ ID は URL の最後の要素です。たとえば、次の URL では、フォルダ ID は 45 です。

https://myinstance.looker.com/folders/45

除外するフォルダ

特定のコンテンツ フォルダをコンテンツ検証から除外するには、[除外するフォルダ] フィールドにフォルダ ID またはフォルダ ID のカンマ区切りのリストを指定します。

個人用フォルダのコンテンツを除外する

Content Validator で共有フォルダ内のコンテンツのみを検証する場合は、[個人用フォルダのコンテンツを除外する] フィールドを有効にします。[個人用フォルダのコンテンツを除外する] フィールドが有効になっている場合、Content Validator は Looker インスタンスの個人用フォルダ内のコンテンツを無視します。

増分検証

増分検証は、特定の開発ブランチに固有のエラー(本番環境にまだ存在しないエラー)を見つける方法です。増分検証を使用すると、プロジェクト内の既存のエラーに煩わされることなく、担当するエラーを検出して修正できます。また、特に Explore が多数含まれる LookML プロジェクトでは、検証を高速化することもできます。

バリデータの結果で、検証対象のブランチまたは commit のコンパイル済み SQL に変更がないためスキップされた各 Explore が Content Validator によって示されます。増分検証結果の例については、増分検証の結果を表示するをご覧ください。

Content Validator の増分検証を有効にするには、継続的インテグレーション スイートを作成または編集するときに、[Content Validator] セクションで [増分エラーのみ] チェックボックスをオンにします。

増分検証について、次のことに注意してください。

  • (本番環境ブランチでの手動実行などで)Content Validator が本番環境ブランチ自体を検証する場合、増分検証の設定は適用されません。本番環境ブランチを検証すると、Content Validator に完全な検証結果が表示されます。

コンテンツの検証の制限事項

モデルを削除または名前変更すると、テスト対象のプロジェクトにモデルを関連付けることができなくなるため、Content Validator はこれらの「ダングリング」コンテンツ エラーを返しません。