Skip to main content

BigQuery cost optimization and governance audit CLI tool

Project description

🚀 DWH-Auditor

PyPI version Python Versions License Documentation

📚 公式ドキュメント: https://shirokurolab.github.io/dwh-auditor/

DWH-Auditor は、BigQueryのメタデータを分析し、「クラウド破産」を防ぐためのコスト最適化とデータガバナンス監査を瞬時に行うオープンソースのCLIツールです。

「誰がどんな重いクエリを投げているのか」「どのテーブルが使われていないのか」を可視化し、具体的なアクション(インサイト)を提示します。

DWH-Auditor Console Report Sample

💡 なぜ DWH-Auditor なのか?

BigQueryは非常に強力ですが、従量課金の性質上、たった一つの非効率なクエリや、放置された不要なテーブルが毎月数万円〜数百万円の無駄なコストを生み出すことがあります。

DWH-Auditorは、複雑な設定なしに INFORMATION_SCHEMA を解析し、あなたのデータ基盤の「健康診断」を数秒で完了させます。実際のテーブルデータには一切アクセスしないため、セキュリティの厳しい環境でも安全に実行できます。

✨ 主な機能

  • 💸 高コストクエリの特定: 過去N日間の課金バイト数を集計し、コストの元凶となっているクエリTop10をリストアップします。
  • 🚨 フルスキャン(アンチパターン)検知: パーティション指定漏れなど、非効率なフルスキャンクエリを警告します。
  • 🧟 ゾンビテーブルの発見: 長期間誰からも参照されていないテーブルを特定し、ストレージコストの削減を促します。
  • 📊 Markdownレポート出力: CI/CD(GitHub Actions等)に組み込み、チーム全体に日次で監査レポートを共有できます。

🛠 クイックスタート

1. インストール

pip install dwh-auditor

2. 初期設定

dwh-auditor init

カレントディレクトリに config.yaml が生成されます。必要に応じてコスト単価やしきい値を調整してください。

3. 監査の実行

# 例: my-gcp-project の過去30日間を分析
dwh-auditor analyze --project my-gcp-project --days 30 --output console

4. 🔐 セキュリティについて (Zero Data Access)

DWH-Auditor は、BigQueryのメタデータ(INFORMATION_SCHEMA)のみを読み取ります。ユーザーの実際のテーブルデータ(レコードの中身)を読み取ることは一切ありません。 必要なIAM権限は最小限(roles/bigquery.metadataViewer, roles/bigquery.resourceViewer)で動作します。

5. 💼 エンタープライズサポート / データ基盤コンサルティング

DWH-Auditor は、データ基盤の「課題を発見する」ための強力な健康診断ツールです。しかし、発見された重症な課題(複雑なデータモデルの再設計や、大規模なクエリのリファクタリング)を自社リソースだけで解決するのが難しいケースも少なくありません。

もし以下のようなお悩みがございましたら、本ツールの開発者(データエンジニア)による直接の支援・コンサルティングをご提供可能です。

「DWH-Auditorで大量のフルスキャンが検知されたが、既存のBIやETLを壊さずにどうパーティション設計を直せばいいか分からない」

「レガシーなSQL群を、dbtを用いたモダンなデータモデリングに移行したい」

「本ツールを自社のCI/CDパイプラインに組み込み、継続的なデータガバナンス体制を構築したい」

6. 👉 ご相談・お問い合わせ:

shirokurolab.oss.tools@gmail.com までお気軽にご連絡ください。初回ヒアリング・コスト削減ポテンシャルの簡易アセスメントは無料で承ります。

7. 🤝 貢献について (Contributing)

バグ報告、機能追加のPull Requestは大歓迎です!開発環境のセットアップ方法については CONTRIBUTING.md をご覧ください。

8. 📜 ライセンス

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dwh_auditor-0.2.0.tar.gz (409.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dwh_auditor-0.2.0-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file dwh_auditor-0.2.0.tar.gz.

File metadata

  • Download URL: dwh_auditor-0.2.0.tar.gz
  • Upload date:
  • Size: 409.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dwh_auditor-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c8b822bc6b0df092dcda4559c3dc7881c8f8e3f9cabd65bbd19f0bb3c64e24fb
MD5 1c206d7dbf0f36a6a97eb77e9b199b6c
BLAKE2b-256 3db566a31ce4756952684ec70bd8cc3b4e3195b17530ab17ef3548460be41618

See more details on using hashes here.

Provenance

The following attestation bundles were made for dwh_auditor-0.2.0.tar.gz:

Publisher: cd.yml on shirokurolab/dwh-auditor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dwh_auditor-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: dwh_auditor-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 29.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dwh_auditor-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 07098e689a7efbd9fbe65b3e012ae48d8d817e618e64961e631b6876b8275446
MD5 1b7e0152c26f759b4c1a208901be0bf9
BLAKE2b-256 f88a5aa880982318bf61926468e13a3f23bd5ece59ff06ae2c6989b766b7a0ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for dwh_auditor-0.2.0-py3-none-any.whl:

Publisher: cd.yml on shirokurolab/dwh-auditor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page