Lightdashを使ってみた ～セットアップ編
OSS BIツールのLightdashをローカル環境で使ってみたので、セットアップ方法について紹介します。
Lightdashはdbtと接続して使用するBIツールで、dbtで定義したmodelやmetricsをそのまま可視化することができるという特徴があります。昨今、dbtが流行してきていることを踏まえると、このようなdbtとシームレスに繋がるBIツールがどんどん出てくるのではと思っており、その筆頭として非常に注目しています。
今回の記事では、Lightdashをセットアップして、GitHub上のdbtプロジェクトと連携するところまでを紹介し、実際にデータを可視化するところは別の記事に書こうと思っています。
Lightdashのセットアップ
前提
基本的にこちらの公式ドキュメントに沿って、セットアップを行いました。
また、Lightdashのセットアップには、dockerのインストールが必要になるので、あらかじめdockerのセットアップを済ましておきます。
また、後ほどdbtプロジェクトと連携をするので、GitHub上にdbtプロジェクトと紐づいたレポジトリを用意しておいてください。
Lightdashレポジトリのclone
作業ディレクトリを作成し、lightdashのレポジトリをgit cloneします。
git clone https://github.com/lightdash/lightdash
インストールスクリプトの実行
その後、cloneしたレポジトリのlightdashディレクトリに移動し、インストール用のスクリプトを実行します。
cd lightdash
scripts\install.sh
スクリプトを実行すると、以下のようなウィンドウが開きます。
どうやら、setup方法が2種類あるようなので、公式ドキュメントを参照してみると、
1. Fast install (recommended):
will automatically configure Lightdash with sensible defaults.
You must host your dbt project on github/gitlab to use this method.
2. Custom install:
gives more customisation including connecting Lightdash to a dbt project
on your local machine.
と記載されています。
Fast installを選ぶ場合、dbt projectがGitHub上に存在する必要があるらしいですが、今回は既にdbtプロジェクトをGitHub上で作成済みであったため、Fast installを選択しました。
この段階で、docker desktopを確認すると、lightdashのコンテナが作成されていました。停止や再実行はここから行うことが出来ます。
Lightdashへのログイン
http://localhost:8080/ にアクセスすると、Lightdashのログイン画面が表示されています。
必要な情報を入力すると、以下のような文章が表示され、lightdash CLIをインストールするよう促されます。
#1 install lightdash CLI
npm install -g @lightdash/cli@0.295.1
#2 login to lightdash
lightdash login http://localhost:8080 --token 64567e7f63417b2430d269d3597381d0
#3 create project
lightdash deploy --create
#1,2はそのまま実行できましたが、#3はdbt_project.ymlが置かれているディレクトリで実行する必要があったため、dbtプロジェクトをgit cloneでローカルレポジトリに持ってきてから実行しました。
すると、以下の画面が表示され、、
無事に、Lightdashを開くことが出来ました！
GitHubとの連携
この段階で、テーブル（dbt model）がいくつか表示されていますが、これらはローカルのdbtプロジェクトから引っ張ってきているものなので、同期先をGitHub上のdbtプロジェクトに変更したいと思います。
右上の設定ボタンをクリック
Project Managementをクリック
すると、以下のような画面が出てくるので、各項目を埋めていきます。
二項目目の入力で、GitHubのアクセストークンを作成する必要があったので、以下サイトを参考にして作成しました。
全て入力した後、画面下部にある、Test & compile projectをクリックし、Successfullyと表示されたら連携は完了です！
おわりに
以上で、Lightdashをローカル環境で起動し、GitHub上のdbtプロジェクト内のmodelやmetricsを可視化することができるようになりました。
少し記事が長くなってしまったので、実際にLightdashのGUIでデータを可視化するところは、第二弾の記事で紹介しようと思います。
最後まで読んで頂きありがとうございました。
Discussion