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

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

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

Elasticsearch Logstash でCData JDBC Driver for Linear を使用

• CData JDBC Driver for Linear をLogstash が稼働するマシンにインストールします。
• 以下のパスにJDBC Driver がインストールされます（2022J の部分はご利用される製品バージョンによって異なります）。後ほどこのパスを使います。この.jar ファイル（製品版の場合は.lic ファイルも）をLogstash に配置します。
  C:\Program Files\CData\CData JDBC Driver for Linear 2022J\lib\cdata.jdbc.linear.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 にLinear のデータを送る

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

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

Linear への認証には、個人用 API キーまたは OAuth 2.0 を使用できます。ご自身の Linear アカウントで接続する場合は、API キーを使うのが最も手軽です。

API キーによる認証

以下の接続プロパティを設定します。

• AuthScheme：APIKey に設定します。
• APIKey：Linear の個人用 API キー。

個人用 API キーを作成するには、Linear にログインして Settings > Security & access > Personal API keys を開き、New API key を選択して作成します。キーは一度しか表示されないため、すぐにコピーしておきましょう。

OAuth による認証

OAuth を使用するには、Linear にカスタム OAuth アプリケーションを登録する必要があります（Settings > API > OAuth applications）。登録すると OAuthClientId と OAuthClientSecret が発行されます。対応しているフローは以下の 2 つです。

• Authorization code：AuthScheme を OAuth、InitiateOAuth を GETANDREFRESH に設定し、OAuthClientId、OAuthClientSecret、およびアプリケーションで定義した CallbackURL（例：http://localhost:33333）を指定します。ドライバーがブラウザで Linear を開くので、アクセスを許可してください。
• Client credentials：AuthScheme を OAuthClient に設定し、OAuthClientId と OAuthClientSecret を指定します。アプリケーション自体を認証するためブラウザ操作は不要で、マシン間（M2M）連携に適しています。

デフォルトでは、ドライバーは read,write スコープをリクエストします。アクセストークンは有効期限が切れると自動で更新されます。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.linear.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.linear.LinearDriver"
                    jdbc_connection_string => "jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT id, name FROM Team WHERE key = 'ENG'"
                }
            }


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

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

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

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

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

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

        GET linear_Team/_search
        {
            "query": {
                "match_all": {}
            }
        }
    

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

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