重要
このページの日本語コンテンツは古くなっている可能性があります。最新の英語版コンテンツをご覧になるには、こちらをクリックしてください。
Jira Source Connector for Confluent Cloud¶
注釈
Confluent Platform 用にコネクターをローカルにインストールする場合は、「Jira Source Connector for Confluent Platform」を参照してください。
Kafka Connect のフルマネージド型 Jira Source Connector は、データを Jira から Apache Kafka® のトピックに移動するために使用されます。このコネクターにより、Jira v2 API を通じて Jira からデータがポーリングされ、Kafka レコードに変換されてから、そのレコードが Kafka のトピックに移動されます。Jira テーブルから得られた各行は、厳密に 1 つの Kafka レコードに変換されます。
機能¶
Jira Source Connector は、次の機能をサポートしています。
- 少なくとも 1 回のデリバリー: コネクターによって、レコードが Kafka のトピックに少なくとも 1 回は配信されることが保証されます(解析されたファイル行が有効な場合)。
- 複数のタスクのサポート: 1 つまたは複数のタスクの実行をサポートしています。タスクが多いほどパフォーマンスが向上する可能性があります。1 つの Jira リソース(テーブル)は 1 つのタスクのみで処理されます。
Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。
制限¶
以下の情報を確認してください。
- コネクターの制限事項については、Jira Source Connector の制限事項を参照してください。
- 1 つ以上の Single Message Transforms(SMT)を使用する場合は、「SMT の制限」を参照してください。
- Confluent Cloud Schema Registry を使用する場合は、「スキーマレジストリ Enabled Environments」を参照してください。
Jira リソース¶
コネクターは、次のリソースからフェッチできます。
- changelogs : 「Get changelogs」を参照してください。
- issue_comments : 「Get comments」を参照してください。
- issue_transitions : 「Get transitions」を参照してください。
- issues : 「Get issue」を参照してください。
- project_categories : 「Project categories」を参照してください。
- project_types : 「Project types」を参照してください。
- projects : 「Get projects paginated」を参照してください。
- resolutions : 「Get resolutions」を参照してください。
- roles : 「Get project roles for project」を参照してください。
- users : 「Get user」を参照してください。
- versions : 「Get project versions」を参照してください。
- worklogs : 「Get issue worklogs」を参照してください。
クイックスタート¶
このクイックスタートを使用して、Confluent Cloud Jira Source Connector の利用を開始することができます。このクイックスタートでは、コネクターを選択し、1 つ以上の Jira リソースからデータを取得するようにコネクターを構成するための基本的な方法について説明します。
- 前提条件
- アマゾンウェブサービス (AWS)、Microsoft Azure (Azure)、または Google Cloud Platform (GCP)上の Confluent Cloud クラスターへのアクセスを許可されていること。
- Confluent CLI がインストールされ、クラスター用に構成されていること。「Confluent CLI のインストール」を参照してください。
- スキーマレジストリ ベースのフォーマット(Avro、JSON_SR(JSON スキーマ)、Protobuf など)を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」および Cloud コネクターの制限事項 を参照してください。
- Jira サーバーにアクセスするための認可と認証情報。
Confluent Cloud Console を使用する場合¶
ステップ 1: Confluent Cloud クラスターを起動します。¶
インストール手順については、「Quick Start for Confluent Cloud」を参照してください。
ステップ 2: コネクターを追加します。¶
左のナビゲーションメニューの Data integration をクリックし、Connectors をクリックします。クラスター内に既にコネクターがある場合は、+ Add connector をクリックします。
Step 4: Enter the connector details.¶
注釈
- すべての 前提条件 を満たしていることを確認してください。
- アスタリスク ( * ) は必須項目であることを示しています。
At the Add Jira Source Connector screen, complete the following:
- Select the way you want to provide Kafka Cluster credentials. You can
choose one of the following options:
- Global Access: Allows your connector to access everything you have access to. With global access, connector access will be linked to your account. This option is not recommended for production.
- Granular access: Limits the access for your connector. You will be able to manage connector access through a service account. This option is recommended for production.
- Use an existing API key: Allows you to enter an API key and secret part you have stored. You can enter an API key and secret (or generate these in the Cloud Console).
- Click Continue.
- Enter the following Jira server connection details:
- Jira URL: Jira サーバーの URL。たとえば、
https://<server-name>.atlassian.net
のようになります。 - Jira Username: Jira アカウントと関連付けられたユーザー名またはメール。
- Jira API key: Jira アカウントの API キー。
- Jira URL: Jira サーバーの URL。たとえば、
- Click Continue.
Enter the following configuration details:
- Topic Name Pattern: The pattern to use for the topic name where
the
${resourceName}
literal will be replaced with each resource name. - Since: Records created or updated after this time will be
processed by the connector. The expected format for
jira.since
isyyyy-MM-dd HH:mm
. - Jira resources: The resources that are to be extracted and written to Kafka.
- Topic Name Pattern: The pattern to use for the topic name where
the
Select the output record value format (data going to the Kafka topic): AVRO, JSON, JSON_SR (JSON Schema), or PROTOBUF. Schema Registry must be enabled to use a スキーマレジストリ-based format (for example, Avro, JSON Schema, or Protobuf). For additional information, see スキーマレジストリ Enabled Environments .
Show advanced configurations
Maximum Batch Size: デフォルトのレコード件数は
100
件です。Maximum In Flight requests: 一度に送信可能な最大リクエスト数。デフォルトは
10
リクエストです。Maximum Poll interval (ms): 変更または更新されたリソースをフェッチするリクエストの間隔(ミリ秒)。デフォルトは
3000
ミリ秒(3 秒)です。Request Interval (ms): 更新されたレコードをチェックするまでの待ち時間(ミリ秒)。デフォルトは
15000
ミリ秒(15 秒)です。Maximum Retries: コネクターがタスクを再試行する最大回数。これを超えるとタスクは失敗します。デフォルトの再試行回数は
10
回です。Retry Backoff (ms): エラーの後、再試行するまでの時間(ミリ秒)。デフォルトは
3000
ミリ秒(3 秒)です。Transforms and Predicates: For more information, see the Single Message Transforms (SMT).
For all property values and definitions, see 構成プロパティ.
Click Continue.
Based on the number of topic partitions you select, you will be provided with a recommended number of tasks.
- To change the number of tasks, use the range slider to select the desired number of tasks.
- Click Continue.
Verify the connection details by previewing the running configuration.
After you've validated that the properties are configured to your satisfaction, click Launch.
コネクターのステータスが Provisioning から Running に変わります。
Step 5: Check for records.¶
レコードが Kafka のトピックに生成されていることを確認します。
Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。
ちなみに
コネクターを起動すると、デッドレターキューのトピックが自動的に作成されます。詳細については、「Confluent Cloud デッドレターキュー」を参照してください。
Confluent CLI の使用¶
Confluent CLI でコネクターをセットアップして実行するには、次の手順を実行します。
注釈
すべての 前提条件 を満たしていることを確認してください。
ステップ 2: コネクターの必須の構成プロパティを表示します。¶
以下のコマンドを実行して、コネクターの必須プロパティを表示します。
confluent connect plugin describe <connector-catalog-name>
例:
confluent connect plugin describe JiraSource
出力例:
The following are required configs:
connector.class : JiraSource
name
kafka.api.key : ["kafka.api.key" is required when "kafka.auth.mode==KAFKA_API_KEY"]
kafka.api.secret : ["kafka.api.secret" is required when "kafka.auth.mode==KAFKA_API_KEY"]
jira.url
jira.username
jira.api.token
jira.since
jira.resources
output.data.format
tasks.max
ステップ 3: コネクターの構成ファイルを作成します。¶
コネクター構成プロパティを含む JSON ファイルを作成します。以下の例は、コネクターの必須プロパティを示しています。
{
"connector.class": "JiraSource",
"name": "JiraSourceConnector_0",
"kafka.auth.mode": "SERVICE_ACCOUNT",
"kafka.service.account.id": "<service-account-resource-ID>",
"jira.url": "https://<server-name>.atlassian.net",
"jira.username": "<authorized-user>",
"jira.api.token": "*********************************",
"jira.since": "2020-06-14 09:30",
"jira.resources": "issues, users, worklogs",
"output.data.format": "JSON",
"tasks.max": "1",
}
以下のプロパティ定義に注意してください。
"connector.class"
: コネクターのプラグイン名を指定します。"name"
: 新しいコネクターの名前を設定します。
"kafka.auth.mode"
: 使用するコネクターの認証モードを指定します。オプションはSERVICE_ACCOUNT
またはKAFKA_API_KEY
(デフォルト)です。API キーとシークレットを使用するには、構成プロパティkafka.api.key
とkafka.api.secret
を構成例(前述)のように指定します。サービスアカウント を使用するには、プロパティkafka.service.account.id=<service-account-resource-ID>
に リソース ID を指定します。使用できるサービスアカウントのリソース ID のリストを表示するには、次のコマンドを使用します。confluent iam service-account list
例:
confluent iam service-account list Id | Resource ID | Name | Description +---------+-------------+-------------------+------------------- 123456 | sa-l1r23m | sa-1 | Service account 1 789101 | sa-l4d56p | sa-2 | Service account 2
GitHub 接続の詳細情報を入力します。
"jira.url"
: Jira サーバーの URL。たとえば、https://<server-name>.atlassian.net
のようになります。"jira.api.token"
: Jira アカウントの API キー。"jira.since"
: この時刻以降に作成または更新されたレコードがコネクターによる処理の対象となります。このプロパティで想定されているフォーマットはyyyy-MM-dd HH:mm
です。この値は、構成したjira.username
の Jira 環境で設定されているタイムゾーンに従って構成する必要があることに注意してください。"jira.resources"
: コネクターで抽出され、Kafka に書き込まれる 1 つまたは複数のリソース。詳細については、「Jira リソース」を参照してください。"output.data.format"
: 出力データフォーマット(Kafka トピックに送られるデータ)として AVRO、JSON_SR(JSON スキーマ)、PROTOBUF、または JSON(スキーマレス)を入力します。スキーマレジストリ ベースのフォーマット(Avro、JSON_SR(JSON スキーマ)、Protobuf など)を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」および Cloud コネクターの制限事項 を参照してください。"tasks.max"
: コネクターは 1 つまたは複数のタスクの実行をサポートしています。タスクが多いほどパフォーマンスが向上する可能性があります。
すべてのプロパティの値と説明については、「構成プロパティ」を参照してください。
ステップ 4: プロパティファイルを読み込み、コネクターを作成します。¶
以下のコマンドを入力して、構成を読み込み、コネクターを起動します。
confluent connect create --config <file-name>.json
例:
confluent connect create --config jira-source-config.json
出力例:
Created connector JiraSourceConnector_0 lcc-do6vzd
ステップ 5: コネクターのステータスを確認します。¶
以下のコマンドを入力して、コネクターのステータスを確認します。
confluent connect list
出力例:
ID | Name | Status | Type | Trace
+------------+-----------------------------+---------+--------+-------+
lcc-do6vzd | JiraSourceConnector_0 | RUNNING | source | |
ステップ 6: Kafka トピックを確認します。¶
レコードが Kafka のトピックに生成されていることを確認します。
Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。
ちなみに
コネクターを起動すると、デッドレターキューのトピックが自動的に作成されます。詳細については、「Confluent Cloud デッドレターキュー」を参照してください。
構成プロパティ¶
このコネクターでは、以下のコネクター構成プロパティを使用します。
データへの接続方法(How should we connect to your data?)¶
name
コネクターの名前を設定します。
- 型: string
- 指定可能な値: 最大 64 文字の文字列
- 重要度: 高
Kafka クラスターの認証情報(Kafka Cluster credentials)¶
kafka.auth.mode
Kafka の認証モード。KAFKA_API_KEY または SERVICE_ACCOUNT を指定できます。デフォルトは KAFKA_API_KEY モードです。
- 型: string
- デフォルト: KAFKA_API_KEY
- 指定可能な値: KAFKA_API_KEY、SERVICE_ACCOUNT
- 重要度: 高
kafka.api.key
- 型: password
- 重要度: 高
kafka.service.account.id
Kafka クラスターとの通信用の API キーを生成するために使用されるサービスアカウント。
- 型: string
- 重要度: 高
kafka.api.secret
- 型: password
- 重要度: 高
データ送信先のトピック名のパターン(Which topic name pattern do you want to send data to?)¶
topic.name.pattern
トピック名に使用するパターン。
${resourceName}
リテラルは各リソース名に置き換えられます。- 型: string
- デフォルト: ${resourceName}
- 重要度: 高
Jira サーバーへの接続方法(How should we connect to your Jira server?)¶
jira.url
Jira サーバーの URL。たとえば、"https://server-name.atlassian.net" のようになります。
- 型: string
- 重要度: 高
jira.username
Jira アカウントと関連付けられたユーザー名またはメール。
- 型: string
- 重要度: 高
jira.api.token
この Jira アカウントの API キー。
- 型: password
- 重要度: 高
Jira の詳細情報(Jira details)¶
jira.since
この時刻以降に作成または更新されたレコードがコネクターによる処理の対象となります。jira.since で想定されている形式は yyyy-MM-dd HH:mm です。この値は、Jira 環境でユーザー(Jira Username 構成で指定されているユーザー)が設定したタイムゾーンに従って構成する必要があることに注意してください。
- 型: string
- 重要度: 中
jira.resources
抽出されて Kafka に書き込まれるリソース。
- 型: list
- 重要度: 高
接続の詳細(Connection details)¶
max.batch.size
一度に返され、Kafka に書き込まれる最大レコード数。
- 型: int
- デフォルト: 100
- 重要度: 低
max.in.flight.requests
一度に送信可能な最大リクエスト数。
- 型: int
- デフォルト: 10
- 重要度: 低
max.poll.interval.ms
変更または更新されたエンティティをフェッチするリクエストの間隔(ミリ秒)。
- 型: long
- デフォルト: 3000(3 秒)
- 重要度: 低
request.interval.ms
更新されたレコードをチェックするまでの待ち時間(ミリ秒)。
- 型: long
- デフォルト: 15000(15 秒)
- 重要度: 低
max.retries
エラー時に再試行する最大回数。これを超えるとタスクは失敗します。
- 型: int
- デフォルト: 10
- 重要度: 低
retry.backoff.ms
エラーの後、再試行するまでの時間(ミリ秒)。
- 型: long
- デフォルト: 3000(3 秒)
- 重要度: 低
出力メッセージ(Output messages)¶
output.data.format
Kafka 出力レコード値のフォーマットを設定します。指定可能なエントリは、AVRO、JSON_SR、PROTOBUF、または JSON です。スキーマベースのメッセージフォーマット(AVRO、JSON_SR、PROTOBUF など)を使用する場合は、Confluent Cloud Schema Registry を構成しておく必要がある点に注意してください
- 型: string
- 重要度: 高
このコネクターのタスク数(Number of tasks for this connector)¶
tasks.max
- 型: int
- 指定可能な値: [1,...]
- 重要度: 高
次のステップ¶
参考
フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。