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

全文検索サービスElasticsearch のETL モジュール「Logstash」とCData JDBC ドライバを使って、Jira Assets のデータを簡単にロードする方法をご紹介。

加藤龍彦
デジタルマーケティング

最終更新日:2022-07-22

この記事で実現できるJira Assets 連携のシナリオ

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

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

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

Elasticsearch Logstash でCData JDBC Driver for JiraAssets を使用

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

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

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

    API トークンを生成するには:

    1. Atlassian アカウントにログインします。
    2. セキュリティ設定 > API トークン > API トークンを作成するをクリックします。

    Atlassian がAPI トークンを生成して表示します。

    API トークンを生成したら、以下のパラメータをセットします。

    • AuthScheme:APIToken。
    • User:認証するユーザーのログイン名。
    • APIToken:生成したAPI トークン。

    これでJira Assets に接続して認証する準備が整いました。

                input {
                    jdbc {
                        jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.jiraassets.jar"
                        jdbc_driver_class => "Java::cdata.jdbc.jiraassets.JiraAssetsDriver"
                        jdbc_connection_string => "jdbc:jiraassets:User=MyUser;APIToken=myApiToken;Url=https://yoursitename.atlassian.net"
                        jdbc_user => ""
                        jdbc_password => ""
                        schedule => "*/30 * * * * *"
                        statement => "SELECT ID, Name FROM Objects WHERE Label = 'SYD-1'"
                    }
                }
    
    
                output {
                    Elasticsearch {
                        index => "jiraassets_Objects"
                        document_id => "xxxx"
                    }
                }
            

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

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

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

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

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

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

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

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

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。