ステップ 2: コンソールを使用して Event Streams インスタンスをプロビジョンする

1. IBM Cloud コンソールにログインします。

2. 「カタログ」 で Event Streams サービス をクリックします。

3. 「料金プランの選択」 セクションから、 「ライト・プラン」、 「標準プラン」、または 「エンタープライズ・プラン」 を選択します。

4. サービスの名前を入力します。 デフォルト値を使用することができます。

5. 「作成」 をクリックします。 Event Streams 「リソース・リスト」 ページが開きます。

6. インスタンスが作成されたら、インスタンス名をクリックして詳細情報を表示します。

7. オプション。 入門チュートリアル のステップを実行して、サンプル・スターター・アプリを実行できます。

ステップ 2: CLI を使用して Event Streams インスタンスをプロビジョンする

CLI を初めて使用する場合は、「 CLI の概要」を参照してください。

Event Streams スタンダードプランのインスタンスを IBM Cloud CLIでプロビジョニングするには、以下の手順に従います

1. IBM Cloud CLI の概要のステップを実行して、 IBM Cloud CLI をインストールします。

2. 次のコマンドを実行して、IBM Cloud にログインします。

   ibmcloud login -a cloud.ibm.com
   

3. ライト・プラン、標準プラン、またはエンタープライズ・プランを使用して、Event Streams に IBM Cloud インスタンスを作成します。

   以下のいずれかの方法を選択します。

   • エンタープライズ・プランで CLI からインスタンスを作成するには、以下のコマンドを実行します。

     ibmcloud resource service-instance-create <INSTANCE_NAME> messagehub enterprise-3nodes-2tb <REGION>
     

     エンタープライズプランでは、各クラスタに専用のリソースが割り当てられているため、プロビジョニングに時間がかかります。そのため、新しいエンタープライズインスタンスのプロビジョニングには最大3時間かかる場合があります。

   • 標準プランで CLI からインスタンスを作成するには、以下のコマンドを実行します。

     ibmcloud resource service-instance-create <INSTANCE_NAME> messagehub standard <REGION>
     

     新しいスタンダードプランのインスタンスのプロビジョニングは、基盤となるリソースがすでにセットアップされているため、瞬時に行われます。

ステップ 2: リソース・コントローラー API を使用して Event Streams インスタンスをプロビジョンする

インスタンスをプロビジョンするための推奨される方法は、 CLI を使用することです。

あるいは、 リソース・コントローラー APIを使用することもできます。 最初に、 アクセス・トークンを取得 してから、アクセス・トークンを指定してリソース・コントローラー API コマンドを実行し、 インスタンスを作成 します。

curl -X POST https://resource-controller.cloud.ibm.com/v2/resource_instances -H "Authorization: ${token}" -H "Content-Type: application/json" \
-d '{ "name": "JG-test-curl", "target": "us-south", "resource_group":"9eba3cff1b0540b9ab7fb93829911da0", "resource_plan_id": "ibm.message.hub.enterprise.3nodes.2tb", "parameters":{"service-endpoints":"public","throughput":"150"}}'

ステップ 3: コンソールを使用してトピックを作成し、パーティションの数を選択する

トピックの作成時に変更できる設定については、 トピック構成 を参照してください。

1. 新しくプロビジョンしたインスタンスから、左側のメニューを使用して 「トピック」 にナビゲートします。

2. 「トピックの作成」 ボタンをクリックし、トピック名を入力します。 **「次へ」**をクリックします。 トピック名は最大 200 文字に制限されています。

3. パーティションの数を選択します。

   トピックは 1 つ以上のパーティションで構成されます。 パーティションは、メッセージの番号付きリストです。 開始するには 1 つの区画で十分ですが、多くの場合、実動システムにはそれ以上の区画があります。

   パーティションはブローカーに分散され、トピックのスケーラビリティが向上します。 また、コンシューマー・グループのメンバー間でメッセージを分散させるためにパーティションを使用することもできます。

   次へ をクリックします。

4. メッセージの保存期間を設定します。 これは、メッセージが削除されるまでの保存期間を示します。 この期間内にメッセージがコンシューマーによって読み取られない場合、それらは失われます。 メッセージのデフォルトの保存期間は24時間です。 最小は 1 時間、最大は 30 日間です。 時間の倍数でこの値を指定してください。

   トピックの作成をクリックします。

ステップ 3: CLI を使用してトピックを作成し、パーティションの数を選択する

トピックの作成時に変更できる設定については、 トピック構成 を参照してください。

以下の ibmcloud es topic-create コマンドを使用して、選択したパーティション数で新規トピックを作成します。

ibmcloud es topic-create [--name] TOPIC_NAME [--partitions PARTITIONS] [--config KEY=VALUE[;KEY=VALUE]* ]*

前提条件: なし

コマンド・オプション：

--name 値、-n 値

トピック名。 トピック名は最大 200 文字に制限されています。

--partitions 値、-p 値

トピックのパーティションの数を設定します。

トピックは 1 つ以上のパーティションで構成されます。 パーティションは、メッセージの番号付きリストです。 開始するには 1 つの区画で十分ですが、多くの場合、実動システムにはそれ以上の区画があります。

パーティションはブローカーに分散され、トピックのスケーラビリティが向上します。 また、コンシューマー・グループのメンバー間でメッセージを分散させるためにパーティションを使用することもできます。

--config KEY=VALUE、-c KEY=VALUE (オプション)

KEY=VALUE のペアとしてトピックの構成オプションを設定します。

複数の -config オプションを指定することができます。 各「-config」オプションで、セミコロンで区切った代入のリストを指定できます。 以下のリストは、有効な構成キーを示しています

• cleanup.policy
• retention.ms
• retention.bytes
• segment.bytes
• segment.ms
• segment.index.bytes

retention.ms キーで指定されたメッセージのデフォルトの保存期間は 24 時間です。 最小は 1 時間、最大は 30 日間です。 時間の倍数でこの値を指定してください。

ibmcloud es topics [--filter FILTER] [--json]

ibmcloud es cluster [--json]

ステップ 3: トピックを作成し、管理 REST API を使用してパーティションの数を選択する

Event Streams には、トピックの作成とリストに使用できる管理用の REST API が用意されています。

/admin/topics パスに POST 要求を発行することにより、 Kafka トピックを作成できます。 要求の本体には JSON 文書が含まれている必要があります。 以下に例を示します。

{
    "name": "topicname",
    "partitions": 1,
    "configs": {
        "retentionMs": 86400000,
        "cleanupPolicy": "delete"
    }
}

JSON 文書には、作成する Kafka トピックの名前を指定する name 属性が含まれている必要があります。 トピック名は、最大 200 characters.The JSON では、( partitions プロパティーを使用して) トピックに割り当てるパーティションの数を指定することもできます。 パーティションの数が指定されていない場合、トピックは単一パーティションで作成されます。

トピックは 1 つ以上のパーティションで構成されます。 パーティションは、メッセージの番号付きリストです。 開始するには 1 つの区画で十分ですが、多くの場合、実動システムにはそれ以上の区画があります。

パーティションはブローカーに分散され、トピックのスケーラビリティが向上します。 また、コンシューマー・グループのメンバー間でメッセージを分散させるためにパーティションを使用することもできます。

要求内にオプションの configs オブジェクトを指定することもできます。 これにより、 Kafka がトピックにパブリッシュされたメッセージを保持する期間 (ミリ秒) を制御する retentionMs プロパティーを指定できます。 この時間が経過すると、メッセージは自動的に削除され、スペースが解放されます。 retentionMs プロパティーの値は、整数の時間数 (例えば、3600000 の倍数) で指定する必要があります。 メッセージのデフォルトの保存期間は24時間です。 最小は 1 時間、最大は 30 日間です。

トピックの作成時に変更できる設定については、 トピック構成 を参照してください。

HTTP のステータスコードは以下の通りです

• 202: トピック作成要求が受け入れられました。
• 400: 要求 JSON が無効です。
• 403: トピックを作成する権限がありません。
• 422: 意味的に無効な要求です。

Kafka トピックの作成リクエストが成功した場合、 HTTP ステータスコード202（受理）が返されます。 操作に失敗した場合は、 HTTP ステータスコード422（Unprocessable Entity）が返され、失敗に関する追加情報を含むJSONオブジェクトがレスポンスのボディとして返されます。

curl -i -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: Bearer ${TOKEN}' --data '{ "name": "newtopic", "partitions": 1}' ${ADMIN_URL}/admin/topics

[
  {
    "name": "topic1",
    "partitions": 1,
    "retentionMs": 86400000,
    "cleanupPolicy": "delete"
  },
  { "name": "topic2",
    "partitions": 2,
    "retentionMs": 86400000,
    "cleanupPolicy": "delete"
  }
]

curl -i -X GET -H 'Accept: application/json' -H 'Authorization: Bearer ${TOKEN}' ${ADMIN_URL}/admin/topics

ステップ 4: コンソールを使用したサービス資格情報の作成

Event Streams インスタンスに接続できるようにするには、 IBM Cloud コンソールを使用してサービス・キーを作成します。

1. リソース・リストで Event Streams サービスを見つけます。
2. サービス・タイルをクリックします。
3. **「サービス資格情報」**をクリックします。
4. **「新規資格情報」**をクリックします。
5. 名前や役割など、新規資格情報の詳細を入力し、**「追加」**をクリックします。 新規資格情報が資格情報リストに表示されます。
6. 新しい資格情報のセクションを展開して、JSON 形式で詳細を表示します。

ステップ 4: CLI を使用したサービス資格情報の作成

IBM Cloud CLI を使用してサービス・キーを作成し、 Event Streams インスタンスに接続できるようにします。

1. サービスを見つけます。

   ibmcloud resource service-instances
   

2. サービス・キーを作成します。

   ibmcloud resource service-key-create <key_name> <key_role> --instance-name <your_service_name>
   

3. サービス・キーを印刷します。

   ibmcloud resource service-key <key_name>
   

   各サービス・キーには、エンドポイント詳細の単一セットが含まれています。 単一のネットワーク・タイプに接続するように構成されたサービス・インスタンスの場合、 IBM Cloud パブリック・ネットワーク (デフォルト) または IBM Cloud プライベート・ネットワークに関連する詳細がサービス・キーに含まれます。 プライベート・ネットワークとパブリック・ネットワークの両方をサポートするように構成されたインスタンスの場合、パブリック・ネットワークの詳細が返されます。 プライベート・ネットワークの詳細が必要な場合は、前の service-key-create CLI コマンドに --service-endpoint private パラメーターを追加する必要があります。 以下に例を示します。

   ibmcloud resource service-key-create <private-key-name> <role> --instance-name <instance-name> --service-endpoint private
   

ステップ 4: CLI および REST プロデューサー API を使用したサービス資格情報の作成

Event Streams インスタンスに接続するために、サポートされている認証メカニズムはベアラー・トークンを使用しています。 IBM Cloud CLI を使用してトークンを取得するには、まず IBM Cloud にログインし、次に以下のコマンドを実行します

ibmcloud iam oauth-tokens

このトークンを、Bearer<token>の形式で HTTP 要求の許可ヘッダーに入れます。 API キーと JWT トークンの両方がサポートされています。

ステップ 5: コンソールを使用してデータを生成する

コンソールを使用してデータを作成することはできません。 コマンド・ライン、 REST プロデューサー API、または Kafka API を使用してデータを生成できます。

ただし、 入門チュートリアル のコンソールの手順を実行して、サンプル・スターター・アプリを実行し、トピック内を流れるメッセージを確認することができます。

ステップ 5: コマンド行を使用してデータを生成する

Event Streams Kafka コンソール・プロデューサー・ツールを使用して、データを生成できます。 コンソール・ツールは、 Kafka クライアント・ダウンロードの bin ディレクトリーにあります。このディレクトリーは、 Apache Kafka ダウンロードからダウンロードできます。 使用可能な最新の安定したバイナリー・バージョンをダウンロードすることをお勧めします。 Kafka クライアントのバージョンは、サーバー上の Kafka のバージョンと後方互換性があります。

ブローカーのリスト (BOOTSTRAP_ENDPOINTS プロパティーを使用) と SASL 資格情報を指定する必要があります。

このツールにSASL認証情報を提供するには、以下の例を参考にプロパティファイルを作成します

    sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username="<user>" password="<api_key>";
    security.protocol=SASL_SSL
    sasl.mechanism=PLAIN
    ssl.protocol=TLSv1.2
    ssl.enabled.protocols=TLSv1.2
    ssl.endpoint.identification.algorithm=HTTPS

サービス・キーの <user> フィールドをユーザー名として使用し、サービス・キーの <api_key> フィールドをパスワードとして使用します。 これらの値は、 IBM Cloud コンソールの Event Streams 「サービス資格情報」 タブにあります。

Event Streams には、 Java クライアント 用の producer.properties ファイルと consumer.properties ファイルの例が用意されています。

プロパティファイルを作成した後、ターミナルでコンソールプロデューサーを次のように実行できます

   kafka-console-producer.sh --broker-list BOOTSTRAP_ENDPOINTS --producer.config CONFIG_FILE --topic TOPIC_NAME

例にある以下の変数を独自の値に置き換えます。

• IBM Cloud コンソールの「 Event Streams サービス資格情報 」タブの値を使用した BOOTSTRAP_ENDPOINTS
• CONFIG_FILE を構成ファイルのパスに置き換えます。

• サービス・キーの <bootstrap_endpoints> フィールドを Kafka アプリケーションの bootstrap.servers プロパティーとして使用します。
• サービス・キーの <user> フィールドをユーザー名として使用し、サービス・キーの <api_key> フィールドをパスワードとして使用します。 アプリケーションが詳細を構文解析することを確認してください。

このツールの他の多くのオプションは、 ZooKeeper へのアクセスを必要とするものを除いて、ご利用いただけます。 詳しくは、 Event Streamsでの Kafka コンソール・ツールの使用 を参照してください。

ステップ 5: REST プロデューサー API を使用してデータを生成する

v2 というREST Producer APIのエンドポイントを使用して、 text、 binary、 JSON、または avro というタイプのメッセージをトピックに送信します。 v2 エンドポイントを使用すると、avro データタイプのスキーマを指定することで、 Event Streams スキーマレジストリを使用することができます。

• ヘッダーとは何ですか? これらはオプションですか? メッセージ本文にヘッダーが表示されます。 これは、要求または応答内のすべてを含むデータのチャンクです。 ヘッダーは通常、要求行または応答行の後にあります。 色の値は base64 です。どのようにしますか?

次のコードは、curl を使用して text タイプのメッセージを送信する例を示しています

curl -v -X POST \
-H "Authorization: Bearer $token" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{
  "headers": [
    {
      "name": "colour",
      "value": "YmxhY2s="
    }
  ],
  "key": {
    "type": "text",
    "data": "Test Key"
  },
  "value": {
    "type": "text",
    "data": "Test Value"
  }
}' \
"$kafka_http_url/v2/topics/$topic_name/records"

詳しくは、 Event Streams REST Producer v2 エンドポイント API リファレンスを参照してください。

ステップ 6: コンソールを使用してデータを取り込む

コンソールを使用してデータをコンシュームすることはできません。 コマンド・ライン または Kafka API を使用してデータを取り込むことができます。

ただし、 入門チュートリアル のステップを実行して、サンプル・スターター・アプリを実行し、トピックを流れるメッセージを確認することができます。

ステップ 6: コマンド行を使用したデータの取り込み

Event Streams Kafka コンソール・コンシューマー・ツールを使用して、データを取り込むことができます。

コンソール・ツールは、 Kafka クライアント・ダウンロードの bin ディレクトリーにあります。

ブローカーのリストと SASL 資格情報を指定する必要があります。 コマンド行を使用したデータの生成 の説明に従ってプロパティー・ファイルを作成した後、以下のように端末でコンソール・コンシューマーを実行します。

   kafka-console-consumer.sh --bootstrap-server BOOTSTRAP_ENDPOINTS --consumer.config CONFIG_FILE --topic TOPIC_NAME

例にある以下の変数を独自の値に置き換えます。

• IBM Cloud コンソールの「 Event Streams サービス資格情報 」タブの値を使用した BOOTSTRAP_ENDPOINTS
• CONFIG_FILE を構成ファイルのパスに置き換えます。

このツールの他の多くのオプションは、 ZooKeeper へのアクセスを必要とするものを除いて、ご利用いただけます。 詳しくは、 Event Streamsでの Kafka コンソール・ツールの使用 を参照してください。

ステップ 6: API を使用してデータをコンシュームする

Event Streams API を使用してデータを取り込むことはできませんが、ネイティブ Kafka ライブラリーを使用して Kafka からデータを取り込むことは可能です。 詳しくは、 Kafka コンシューマー API を参照してください。

代わりに、 コマンド行 を使用してください。

ステップ 7: コンソールを使用して IBM Cloud Monitoring を接続し、操作の可視性を確保する

IBM Cloud Monitoring を使用して、アプリケーション、サービス、およびプラットフォームのパフォーマンスと正常性に対する運用上の可視性を得ることができます。 IBM Cloud Monitoring は、モニター、トラブルシューティング、アラートの定義、およびカスタム・ダッシュボードの設計を行うための拡張機能を備えた、管理者、 DevOps チーム、および開発者向けフルスタック・テレメトリーを提供します。

Monitoring を Event Streams と併用する方法の詳細については、こちらをご覧ください

• メトリックへのオプトイン
• デフォルト・メトリックの有効化
• 拡張メトリックの有効化
• 使用可能なメトリックの詳細の表示
• メトリック・コスト情報について

ステップ 7: CLI またはコマンド・ラインを使用して、操作の可視性のために IBM Cloud Monitoring を接続する

CLI またはコマンド・ラインを使用して IBM Cloud Monitoring に接続することはできません。 このタスクを実行するには、 コンソール を使用します。

ステップ 7: API を使用した操作の可視性のための IBM Cloud Monitoring の接続

API を使用して IBM Cloud Monitoring に接続することはできません。 このタスクを実行するには、 コンソール を使用します。

ステップ 8: IBM Cloud® Activity Tracker を接続してサービス・アクティビティーを監査する

IBM Cloud Activity Tracker を使用すると、企業のポリシーおよび業界の規制に準拠するために、サービス・アクティビティーを表示、管理、および監査できます。 Activity Tracker は、 IBM Cloud内のサービスの状態を変更するユーザー開始アクティビティーを記録します。 Activity Tracker を使用して、スタンダードプランおよびエンタープライズプランの Event Streams サービスとユーザーおよびアプリケーションの相互関係を追跡します。

Activity Trackerを稼働させるには、 Activity Trackerを参照してください。

Activity Tracker では、場所ごとに存在できるインスタンスは 1 つだけです。 イベントを表示するには、サービス・インスタンスが使用可能になっている場所と同じ場所で、Activity Tracker サービスの Web UI にアクセスする必要があります。 詳しくは、 Web UI の起動を参照してください。

Event Streamsに固有のイベントについて詳しくは、以下を参照してください。

• イベントを確認できる場所
• トピックのイベント
• メッセージ監査イベント
• その他のイベント

イベントは、クラウド監査データ連合（CADF）標準に従ってフォーマットされます。 それらに含まれる情報の詳細については、 CADF 標準 を参照してください。

ステップ 8: CLI またはコマンド・ラインを使用して IBM Cloud® Activity Tracker を接続し、サービス・アクティビティーを監査する

CLI またはコマンド・ラインを使用して Activity Tracker に接続することはできません。 このタスクを実行するには、 コンソール を使用します。

ステップ 8: API を使用して IBM Cloud® Activity Tracker を接続し、サービス・アクティビティーを監査する

API を使用して Activity Tracker に接続することはできません。 このタスクを実行するには、 コンソール を使用します。