ETL ツールのEmbulk を使ってZendesk データをDB にロードする方法

こんにちは！リードエンジニアの杉本です。

Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for Zendesk を使って、Zendesk のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。

Embulk でZendesk のデータをロード

• CData JDBC Driver for Zendesk をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
• 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
  C:\Program Files\CData\CData JDBC Driver for Zendesk 2019J\lib\cdata.jdbc.zendesk.jar

• 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。以下のリンクからダウンロードできます。

  https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

  インストール用のコマンドはこちら：

  embulk gem install embulk-input-jdbc

• 今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。ロードに必要な以下のプラグインをインストールしましょう。

  https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

  コマンドはこちら。

  embulk gem install embulk-output-mysql
• config ファイルを作成し、Zendesk -> MySQL のジョブを作成します。zendesk-mysql.yml というファイル名で、以下の内容で作成しました。
in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Zendesk 2024J\lib\cdata.jdbc.zendesk.jar driver_class: cdata.jdbc.zendesk.ZendeskDriver url: jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;InitiateOAuth=REFRESH table: "Tickets" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Tickets" mode: insert
• JDBC URL の内容は、ご利用の環境や資格情報を入力してください。

  Connecting to Zendesk

  接続するには、URL を設定して認証を提供します。URL は、Zendesk Support のURL：https://{subdomain}.zendesk.com です。

  Zendesk への接続

  Zendesk は、Basic 認証またはOAuth 2 認証標準を利用しています。

  ベーシック認証

  ベーシック認証では、E メールアドレスとパスワード、もしくは、E メールアドレスとAPI token で接続します。User をE メールアドレスに設定し、次の方法でPassword とAPI Token を提供します。

  • Admin、Channels、API でZendesk Support Admin からパスワードを有効化します。
  • Zendesk Support Admin からAdmin->Channels->API と操作し、API token を管理します。同時に複数のトークンを有効化させることが可能です。

  OAuth 認証

  詳細はヘルプドキュメントを参照してください。

• テーブル名は取得したいテーブル名を入れます。
• これで準備完了です。あとは「embulk run」で実行するだけです。
embulk run zendesk-mysql.yml
• 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

クエリ条件でフィルタリングしたデータのロード

ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。

おわりに

CData JDBC Driver for Zendesk をEmbulk で使うことで、Zendesk と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。