Elasticsearch へLogstash 経由でBambooHR のデータをロードする方法

加藤龍彦
加藤龍彦
デジタルマーケティング
全文検索サービスElasticsearch のETL モジュール「Logstash」とCData JDBC ドライバを使って、BambooHR のデータを簡単にロードする方法をご紹介。

Elasticsearch は、人気の分散型全文検索エンジンです。データを一元的に格納することで、超高速検索や、関連性の細かな調整、パワフルな分析が大規模に、手軽に実行可能になります。Elasticsearch にはデータのローディングを行うパイプラインツール「Logstash」があります。CData Drivers を利用することができるので、30日の無償評価版をダウンロードしてあらゆるデータソースを簡単にElasticsearch に取り込んで検索・分析を行うことができます。

この記事では、CData Driver for API を使って、BambooHR のデータをLogstash 経由でElasticsearch にロードする手順を説明します。

Elasticsearch Logstash でCData JDBC Driver for API を使用

  • CData JDBC Driver for API をLogstash が稼働するマシンにインストールします。
  • 以下のパスにJDBC Driver がインストールされます（2022J の部分はご利用される製品バージョンによって異なります）。後ほどこのパスを使います。この.jar ファイル（製品版の場合は.lic ファイルも）をLogstash に配置します。
    C:\Program Files\CData\CData JDBC Driver for API 2022J\lib\cdata.jdbc.api.jar
  • 次に、Logstash とCData JDBC ドライバをつなぐ、JDBC Input Plugin をインストールします。JDBC Plugin は最新のLogstash だとデフォルトでついてきますが、バージョンによっては追加する必要があります。
    https://www.elastic.co/guide/en/logstash/5.4/plugins-inputs-jdbc.html
  • CData JDBC ドライバの.jar ファイルと.lic ファイルを、Logstashの「/logstash-core/lib/jars/」に移動します。

Logstash でElasticsearch にBambooHR のデータを送る

それでは、Logstash でElasticsearch にBambooHR のデータの転送を行うための設定ファイルを作成していきます。

  • Logstash のデータ処理定義であるlogstash.conf ファイルにBambooHR のデータを取得する処理を書きます。Input はJDBC、Output はElasticsearch にします。データローディングジョブの起動間隔は30秒に設定しています。
  • CData JDBC ドライバの.jar をjdbc driver ライブラリにして、クラス名を設定、BambooHR への接続プロパティをJDBC URL の形でせっていします。JDBC URL ではほかにも詳細な設定を行うことができるので、細かくは製品ドキュメントをご覧ください。

    • まず、Profile 接続プロパティをディスク上のBambooHR プロファイルの場所に設定します（例：C:\profiles\bamboohr.apip）。次に、ProfileSettings 接続プロパティをBambooHR の接続文字列に設定します（以下を参照）。

    BambooHR API プロファイル設定

    BambooHR に認証するには、API キーを提供する必要があります。API キーを生成するには、ログインして任意のページの右上隅にある自分の名前をクリックし、ユーザーコンテキストメニューにアクセスします。十分な権限がある場合、そのメニューに「API Keys」オプションが表示され、新しいAPI キーを作成できるページに移動できます。また、BambooHR アカウントのドメイン名にあるDomain を設定します。例えば、BambooHR アカウントがacmeinc.bamboohr.com の場合、Domain は「acmeinc」となります。ProfileSettings プロパティにAPI Key とDomain の両方を設定して接続します。

                input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.api.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.api.APIDriver"
                    jdbc_connection_string => "jdbc:api:Profile=C:\profiles\BambooHR.apip;ProfileSettings='Domain=acmeinc;APIKey=your_api_key';"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Id, DisplayName FROM Employees WHERE Department = 'Sales'"
                }
            }


            output {
                Elasticsearch {
                    index => "api_Employees"
                    document_id => "xxxx"
                }
            }

Logstash でBambooHR のローディングを実行

それでは作成した「logstash.conf」ファイルを元にLogstash を実行してみます。 

        > logstash-7.8.0\bin\logstash -f logstash.conf

成功した旨のログが出ます。これでBambooHR のデータがElasticsearch にロードされました。

例えばKibana で実際にElasticsearch に転送されたデータを見てみます。

        GET api_Employees/_search
        {
            "query": {
                "match_all": {}
            }
        }
Elasticsearch にロードされたBambooHR のデータをクエリ

データがElasticsearch に格納されていることが確認できました。

Elasticsearch にロードされたBambooHR のデータを確認

CData JDBC Driver for API をLogstash で使うことで、BambooHR コネクタとして機能し、簡単にデータをElasticsearch にロードすることができました。ぜひ、30日の無償評価版をお試しください。

はじめる準備はできましたか？

API Driver で BambooHR のライブデータに接続

BambooHR に接続 お問い合わせ

この記事の内容

関連記事