Jira Service Management のデータをApache Kafka トピックにストリーミング

Apache Kafka は、主にリアルタイムデータパイプラインやイベント駆動型アプリケーションの構築に使用されるオープンソースのストリーム処理プラットフォームです。CData JDBC Driver for Jira Service Managementと組み合わせることで、Kafka はライブのJira Service Management のデータを扱うことができます。この記事では、Jira Service Management データをApache Kafka トピックに接続、アクセス、ストリーミングする方法と、Confluent Control Center を起動してConfluent プラットフォームのKafka インフラストラクチャを使用して受信したJira Service Management のデータをユーザーが安全に管理および監視できるようにする方法について説明します。

CData JDBC Driver は最適化されたデータ処理機能を内蔵しており、ライブのJira Service Management のデータとのやり取りにおいて比類のないパフォーマンスを提供します。Jira Service Management に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Jira Service Management にプッシュし、サポートされていない操作（多くの場合SQL 関数やJOIN 操作）については組み込みのSQL エンジンを使用してクライアント側で処理します。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してJira Service Management のデータを操作および分析できます。

前提条件

Apache Kafka トピックでJira Service Management のデータをストリーミングするためにCData JDBC Driver を接続する前に、クライアントのLinux ベースのシステムに以下をインストールおよび設定してください。

1. Confluent Platform for Apache Kafka
2. Confluent Hub CLI のインストール
3. Confluent Platform 用のSelf-Managed Kafka JDBC Source Connector

Jira Service Management のデータへの新しいJDBC 接続を定義

1. Linux ベースのシステムにCData JDBC Driver for Jira Service Managementをダウンロードします。
2. 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
   1. Jira Service Management という名前の新しいディレクトリを作成します。

      		mkdir JiraServiceDesk
      		

   2. ダウンロードしたドライバーファイル（.zip）をこの新しいディレクトリに移動します。

      		mv JiraServiceDeskJDBCDriver.zip JiraServiceDesk/
      		

   3. CData JiraServiceDeskJDBCDriver の内容をこの新しいディレクトリに解凍します。

      		unzip JiraServiceDeskJDBCDriver.zip
      		

3. Jira Service Management ディレクトリを開き、lib フォルダに移動します。

   ls
   cd lib/
   

4. CData JDBC Driver for Jira Service Management のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.jiraservicedesk.jar ファイルがlib フォルダに正常にコピーされたことを確認します。

   cp -r /path/to/CData JDBC Driver for Jira Service Management/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
   cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
   

5. 以下のコマンドを使用して、CData Jira Service Management JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。

   	java -jar cdata.jdbc.jiraservicedesk.jar -l
   	

6. プロダクトキーまたは"TRIAL" を入力します（ライセンスの有効期限が切れた場合は、CData サポートチームまでお問い合わせください）。
7. 以下のコマンドを使用してConfluent ローカルサービスを起動します:

   	confluent local services start
   	

   これにより、Zookeeper、Kafka、Schema Registry、Kafka REST、Kafka CONNECT、ksqlDB、Control Center などのすべてのConfluent サービスが起動します。これで、CData JDBC Driver for Jira Service Management を使用してKafka Connect Driver 経由でksqlDB のKafka トピックにメッセージをストリーミングする準備が整いました。

   
8. POST HTTP API リクエストを使用してKafka トピックを手動で作成します:

    curl --location 'server_address:8083/connectors'
   	--header 'Content-Type: application/json'
   	--data '{
   		"name": "jdbc_source_cdata_jiraservicedesk_01",
   		"config": {
   			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector",
   			"connection.url": "jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;",
   		"topic.prefix": "jiraservicedesk-01-",
   		"mode": "bulk"
   		}
   	}'
   

   HTTP POST 本文（上記）で使用されるフィールドについて説明します:

   • connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
   • connection.url: Jira Service Management データに接続するためのJDBC 接続URL です。

     組み込みの接続文字列デザイナー

     JDBC URL の作成については、CData JDBC Driver for Jira Service Managementに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     		java -jar cdata.jdbc.jiraservicedesk.jar
     		

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     Jira Service Management 接続プロパティの取得・設定方法

     任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

     • URL（例：https://yoursitename.atlassian.net）

     カスタムフィールドへのアクセス

     デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

     Jira Service Management への認証

     ベーシック認証

     ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

     • AuthScheme：Basic に設定。
     • User：認証ユーザーのユーザー名に設定。
     • Password：認証ユーザーのパスワードに設定。

     API トークン

     Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

     データに接続するには以下を設定します。

     • AuthScheme：APIToken に設定。
     • User：認証ユーザーのユーザー名に設定。
     • APIToken：作成したAPI トークンに設定。

     ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

     OAuth 2.0

     Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。

     この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

     

   • topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「jiraservicedesk-01-」に設定されています。
   • mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。

   このリクエストにより、Jira Service Management のすべてのテーブル/コンテンツがKafka トピックとして追加されます。

   注意: リクエストをPOST するIP アドレス（サーバー）は、Linux ネットワークのIP アドレスです。

9. ksqlDB を実行し、トピックを一覧表示します。以下のコマンドを使用します:

   ksql
   list topics;
   

   
10. トピック内のデータを表示するには、以下のSQL ステートメントを入力します:

    PRINT topic FROM BEGINNING;
    

Confluent Control Center への接続

Confluent Control Center のユーザーインターフェースにアクセスするには、上記のセクションで説明した"confluent local services" を実行し、ローカルブラウザでhttp://<server address>:9021/clusters/ と入力してください。

おわりに

CData JDBC Driver for Jira Service Managementの30日間無償トライアルをダウンロードして、Jira Service Management データをApache Kafka にストリーミングしましょう。ご不明な点があれば、サポートチームまでお問い合わせください。