設定ファイル (config.yaml) — コスト単価・しきい値の DWH 監査設定

dwh-auditor の各診断ルールは、プロジェクト固有の基準に合わせて config.yaml でカスタマイズできます。 「何を異常とみなすか」はビジネス要件によって異なるため、 すべての値をユーザーが上書きできる設計になっています。

設定ファイルの生成

dwh-auditor init

カレントディレクトリに config.yaml が生成されます。 既にファイルが存在する場合は上書きされません。

注釈

config.yaml は Git リポジトリに含めても問題ありません。 ただし、機密情報（サービスアカウントキーなど）は 絶対に含めないでください。

設定ファイルの全スキーマ

# dwh-auditor config.yaml

pricing:
  # On-demand price per 1TB scanned (USD)
  # BigQuery on-demand default price: $6.25/TB
  tb_scan_usd: 6.25

thresholds:
  # Exclusion line for full scan detection (GB)
  # Scans below this value are excluded from warnings
  # Setting to prevent alert fatigue from small master table scans
  ignore_full_scan_under_gb: 1.0

  # Maximum number of high-cost queries to report
  top_expensive_queries_limit: 10

  # Number of unreferenced days before considering it a zombie table
  zombie_table_days: 90

# (For future extension) dbt integration settings
dbt:
  enabled: false
  job_label_key: "dbt_model"

各設定値の詳細

pricing セクション

pricing.tb_scan_usd

1TB スキャンあたりのオンデマンド料金（USD）です。 コスト推定の計算式は以下の通りです。

Estimated Cost (USD) = TB Scanned × tb_scan_usd

キー

デフォルト値

説明

tb_scan_usd

6.25

BigQuery オンデマンドの標準料金に対応

Tip

Editions（Flex Slots / Standard / Enterprise）を利用している場合、 スロット時間課金モデルになります。 この場合は tb_scan_usd: 0.0 に設定し、コスト分析を参考値として使用してください。

thresholds セクション

thresholds.ignore_full_scan_under_gb

この GB 数以下のスキャンは フルスキャン警告から除外 されます。

キー

デフォルト値

推奨用途

ignore_full_scan_under_gb

1.0

小規模マスターテーブル（都道府県テーブルなど）のスキャンを無視する

thresholds.top_expensive_queries_limit

高コストクエリの報告件数の上限です。

キー

デフォルト値

説明

top_expensive_queries_limit

10

コンソール・レポートに表示するクエリの最大件数

thresholds.zombie_table_days

この日数以上、一度も SELECT で参照されていないテーブルを ゾンビテーブル として报告します。

キー

デフォルト値

説明

zombie_table_days

90

過去 90 日間の JOBS ビューにテーブルが現れなければゾンビ判定

dbt セクション（将来の拡張用）

dbt が発行するクエリを BigQuery のジョブラベルで識別し、 dbt モデルごとのコスト集計を行う設定です。 現バージョンでは enabled: false のままにしてください。

キー

デフォルト値

説明

dbt.enabled

false

dbt 連携を有効にするか

dbt.job_label_key

"dbt_model"

dbt モデルを識別するラベルキー名

Pydantic スキーマ

設定ファイルは Python 側で Pydantic モデル dwh_auditor.config.AppConfig に パースされるため、不正な値（負の料金、0 件のしきい値など）は 起動時にバリデーションエラーとして検出されます。

from dwh_auditor.config import load_config

config = load_config("config.yaml")
print(config.pricing.tb_scan_usd)   # 6.25
print(config.thresholds.zombie_table_days)  # 90

詳細は dwh_auditor.config — 設定ファイルの読み込みと DWH 設定管理 を参照してください。