ストリーミングの構成

UI を使用してストリーミングを構成するには、以下のステップを実行します。

UI を使用したストリーミングの有効化または停止

メトリック・データ・ストリーミングページからメトリックのストリーミングを開始および停止できます。

1. 管理者権限を持つユーザーとして Web UI を起動します。 Web UI の起動方法について詳しくは、Web UI へのナビゲートを参照してください。

2. ユーザー・アイコンをクリックします。 これは、ログオンしたユーザーのイニシャルがあるアイコンです。 次に、**「設定」**をクリックします。

3. メトリック・データ・ストリーミングを選択します。 ストリーミング構成のリストが表示されます。

   

4. トグルを使用してストリーミング構成を有効または無効にします。

ストリーミング構成をリストします

このメソッドを使用して、既存のすべてのストリーミング構成の詳細を取得します。

curl --request GET https://<ENDPOINT>/api/v1/dataStream/configs
 -H "content-type: application/json"
 -H "Authorization: <TOKEN>"

説明

• <ENDPOINT>は、REST API 呼び出しによってターゲットとされるエンドポイントを示します。 詳しくは、モニタリング REST API エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは https://us-south.monitoring.cloud.ibm.com/api です。
• Monitoring サービスでの認証に使用する <TOKEN> API トークン。 トークンにBearerを含める必要があります。 詳しくは、Monitoring API トークンの操作を参照してください。

応答は、以下のようになります。

{"dataStreamConfigs":[{"uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","enabled":true,"name":"Streaming metrics - demo","type":"kafka"}]}

ストリーミング構成の詳細の取得

このメソッドを使用して、1 つのストリーミング構成の詳細を取得します。

curl --request GET https://<ENDPOINT>/api/v1/dataStream/configs/<STREAMING_CONFIG_ID>
 -H "content-type: application/json"
 -H "Authorization: <TOKEN>"

説明

• <ENDPOINT>は、REST API 呼び出しによってターゲットにされるエンドポイントを表します。 詳しくは、モニタリング REST API エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは https://us-south.monitoring.cloud.ibm.com/api です。
• Monitoring サービスでの認証に使用する <TOKEN> API トークン。 トークンにBearerを含める必要があります。 詳しくは、Monitoring API トークンの操作を参照してください。
• <STREAMING_CONFIG_ID>は、詳細を取得するストリーミング構成の UUID を表します。

応答は、以下のようになります。

{
    "dataStreamConfig": {
        "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "enabled": true,
        "name": "Streaming metrics - demo",
        "emitterType": "kafka",
        "emitterProperties": {
            "bootstrap.servers": "kafka-0.mh-svc1.eu-de.containers.appdomain.cloud:9093, kafka-2.mh-svc2-0000.eu-de.containers.appdomain.cloud:9093,kafka-1.mh-svc3.eu-de.containers.appdomain.cloud:9093",
            "topic.name": "my-monitoring-topic",
            "compression.type": "lz4",
            "security.protocol": "SASL_SSL",
            "sasl.mechanism": "PLAIN",
            "sasl.jaas.config": "org.apache.kafka.common.security.plain.PlainLoginModule required username=\"token\" password=\"xxxxxxxxxxxxx\";","ssl.truststore.base64.content":""}},"dataStreamRules":[{"uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","enabled":true,"metrics":["kube_daemonset_labels","kube_node_status_condition"],"aggregation":"avg","aggregationSec":10,"scope":"kubernetes.cluster.name = \"mycluster\"",
            "dataStreamConfigUuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
    ]
}

ストリーミング構成の作成

このメソッドを使用して、一連のメトリックを Event Streams に転送する 1 つのストリーミング構成を構成します。

curl --request POST https://<ENDPOINT>/api/v1/dataStream/configs
 -H "content-type: application/json"
 -H "Authorization: <TOKEN>"
 -d @streaming-config.json

説明

• <ENDPOINT>は、REST API 呼び出しによってターゲットにされるエンドポイントを表します。 詳しくは、モニタリング REST API エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは https://us-south.monitoring.cloud.ibm.com/api です。
• Monitoring サービスでの認証に使用する <TOKEN> API トークン。 トークンにBearerを含める必要があります。 詳しくは、Monitoring API トークンの操作を参照してください。

streaming-config.jsonファイルの例を以下に示します。

{
    "dataStreamConfig": {
        "enabled": true,
        "name": "Streaming metrics config",
        "emitterType": "kafka",
        "emitterProperties": {
            "bootstrap.servers": "kafka-0.mh-svc1.eu-de.containers.appdomain.cloud:9093,kafka-2.mh-svc2.eu-de.containers.appdomain.cloud:9093,kafka-1.mh-svc3.eu-de.containers.appdomain.cloud:9093",
            "topic.name": "my-monitoring-topic",
            "compression.type": "lz4",
            "security.protocol": "SASL_SSL",
            "sasl.mechanism": "PLAIN",
            "sasl.jaas.config": "org.apache.kafka.common.security.plain.PlainLoginModule required username=\"token\" password=\"xxxxxxxxxx\";",
            "ssl.truststore.base64.content": ""
        }
    },
    "dataStreamRules": [
        {
            "enabled": true,
            "metrics": [
                "kube_daemonset_labels",
                "kube_node_status_condition"
            ],
            "aggregation": "avg",
            "aggregationSec": 10,
            "scope": "kubernetes.cluster.name = \"mycluster\""
        }
    ]
}

ストリーミング構成の更新

以下のいずれかのサイズでストリーミング構成を更新します。

• Event Streams で認証するための API キーは、ローテーションされているか、プロミスキャスされているか、または変更する必要があります。
• ストリーミングするメトリックを変更する場合は、新しいメトリックを追加するか、メトリックを削除します。
• 有効範囲を変更する必要がある場合。
• 構成のデータ・ストリームを有効または無効にします。

このメソッドを使用して、一連のメトリックを Event Streams に転送する 1 つのストリーミング構成を更新します。

curl --request PUT https://<ENDPOINT>/api/v1/dataStream/configs/<STREAMING_CONFIG_ID>
 -H "content-type: application/json"
 -H "Authorization: <TOKEN>"
 -d @streaming-config.json

説明

• <ENDPOINT>は、REST API 呼び出しによってターゲットにされるエンドポイントを表します。 詳しくは、モニタリング REST API エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは https://us-south.monitoring.cloud.ibm.com/api です。
• Monitoring サービスでの認証に使用する <TOKEN> API トークン。 トークンにBearerを含める必要があります。 詳しくは、Monitoring API トークンの操作を参照してください。
• <STREAMING_CONFIG_ID>は、ストリーミング構成の UUID を表します。

streaming-config.jsonファイルの例を以下に示します。

{
    "dataStreamConfig": {
        "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "enabled": true,
        "name": "Streaming metrics - demo",
        "emitterType": "kafka",
        "emitterProperties": {
            "bootstrap.servers": "kafka-0.mh-svc1.eu-de.containers.appdomain.cloud:9093, kafka-2.mh-svc2-0000.eu-de.containers.appdomain.cloud:9093,kafka-1.mh-svc3.eu-de.containers.appdomain.cloud:9093",
            "topic.name": "my-monitoring-topic",
            "compression.type": "lz4",
            "security.protocol": "SASL_SSL",
            "sasl.mechanism": "PLAIN",
            "sasl.jaas.config": "org.apache.kafka.common.security.plain.PlainLoginModule required username=\"token\" password=\"xxxxxxxxxxxxx\";","ssl.truststore.base64.content":""}},"dataStreamRules":[{"uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","enabled":true,"metrics":["kube_daemonset_labels","kube_node_status_condition"],"aggregation":"avg","aggregationSec":10,"scope":"kubernetes.cluster.name = \"mycluster\"",
            "dataStreamConfigUuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
    ]
}

ストリーミング構成の削除

このメソッドを使用して、一連のメトリックを Event Streams に転送する 1 つのストリーミング構成を削除します。

curl --request DELETE https://<ENDPOINT>/api/v1/dataStream/configs/<STREAMING_CONFIG_ID>
 -H "content-type: application/json"
 -H "Authorization: <TOKEN>"

説明

• <ENDPOINT>は、REST API 呼び出しによってターゲットにされるエンドポイントを表します。 詳しくは、モニタリング REST API エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは https://us-south.monitoring.cloud.ibm.com/api です。
• Monitoring サービスでの認証に使用する <TOKEN> API トークン。 トークンにBearerを含める必要があります。 詳しくは、Monitoring API トークンの操作を参照してください。
• <STREAMING_CONFIG_ID>は、ストリーミング構成の UUID を表します。