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

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



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

この記事では、CData Driver for API を使って、Sentry のデータを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 にSentry のデータを送る

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

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

    Sentry はトークンベースの認証を使用します。Auth Token を取得するには、以下のステップで進めます:

    1. https://sentry.io で Sentry アカウントにログインします
    2. Settings > Auth Tokens に移動します
    3. 「Create New Token」をクリックします
    4. 必要なスコープを選択して「Create Token」をクリックします
    5. 生成されたトークンをコピーします(一度しか表示されません)

    Auth Token を取得したら、以下の接続プロパティを設定します:

    • AuthScheme:APIKey に設定します。
    ProfileSettings 接続プロパティには以下を設定します:
    • APIKey:Sentry の Auth Token に設定します。
    • OrganizationId:Sentry の組織スラッグまたは ID に設定します。

    接続文字列の例

    Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";
    

    Sentry への接続

    認証を設定すると、Sentry に接続して、Organizations、Projects、Issues、Events などの利用可能なテーブルからデータをクエリできます。

                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\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";"
                        jdbc_user => ""
                        jdbc_password => ""
                        schedule => "*/30 * * * * *"
                        statement => "SELECT ,  FROM UserOrganizations WHERE  = ''"
                    }
                }
    
    
                output {
                    Elasticsearch {
                        index => "api_UserOrganizations"
                        document_id => "xxxx"
                    }
                }
            

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

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

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

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

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

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

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

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

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

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

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

Sentry に接続