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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Elasticsearch Logstash でCData JDBC Driver for AzureDevOps を使用

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

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

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

AzureDevOps 接続プロパティの取得・設定方法

Azure DevOps アカウントに接続するには、Profile -> Organizations に移動して、アカウント内の組織名であるOrganization を指定します。

例： Organization=MyAzureDevOpsOrganization

NOTE ：Analytics スキーマに接続する場合は、Organization と一緒にProjectId を指定する必要があります。

Azure DevOps への認証

Basic

Organization とPersonalAccessToken を指定することで、Azure DevOps アカウントに接続できます。 パーソナルアクセストークンを生成するには、Azure DevOps Organization アカウントにログインし、Profile -> Personal Access Tokens -> New Token に移動します。生成されたトークンが表示されます。

Azure AD

Azure ADは、OAuth を利用して認証する接続形式です。OAuth は、認証ユーザーがインターネットブラウザを使用してAzure DevOps と通信することを要求します。 CData 製品は、いくつかの方法でこれをサポートします。AuthScheme をAzureAD に設定し、Organization をAzure DevOps の組織名に設定します。 詳しくは、ヘルプドキュメント の「Azure DevOps への認証」セクションを参照してください。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.azuredevops.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.azuredevops.AzureDevOpsDriver"
                    jdbc_connection_string => "jdbc:azuredevops:AuthScheme=Basic;Organization=MyAzureDevOpsOrganization;ProjectId=MyProjectId;PersonalAccessToken=MyPAT;InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Id, BuildNumber FROM Builds WHERE Reason = 'Manual'"
                }
            }
                
                
            output {
                Elasticsearch {
                    index => "azuredevops_Builds"
                    document_id => "xxxx"
                }
            }
        

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

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

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

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

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

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

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