Monitoring ターゲットの管理
アカウント内のMonitoring ターゲットは、IBM Cloud Metrics Routing UI、IBM Cloud Metrics Routing CLI、IBM Cloud Metrics Routing REST API、IBM Cloud Metrics Routing Terraform プロバイダがあります。 ターゲットは、メトリクスを収集できるリソースです。
IBM Cloud Metrics Routing ターゲットについて詳しくは、 ターゲット を参照してください。
Monitoring ターゲットについて
IBM Cloud Metrics Routing は、サービスがサポートされているさまざまな地域で生成されたメトリックを Monitoring ターゲットにルーティングするように構成できます。
-
ルーティング・メトリックは、 IBM Cloud Metrics Routing が使用可能な地域でのみ生成されます。 詳細については、リージョンを参照してください。
-
規制およびコンプライアンスの要件がある場合は、 Monitoring ターゲットが有効な場所にあることを確認してください。
-
メトリックを Monitoring インスタンスにルーティングするように IBM Cloud Metrics Routing を構成するには、サービス間許可を構成する必要があります。 IBM Cloud Metrics Routingに資格情報を指定する必要はありません。 IBM Cloud Metrics Routing サービスと、同じアカウント内の Monitoring サービスのインスタンスとの間、または IBM Cloud Metrics Routing サービスと、別のアカウント内の Monitoring サービスのインスタンスとの間で、サービス間許可を定義できます。
サービス間認証の構成については、 サービス間のアクセス権限を付与するための許可の管理 を参照してください。
IAM アクセス権限
ターゲットを管理するには、正しい IAM 権限が必要です。 詳しくは、 IAM アクセス権限の管理 を参照してください。
UIを使用したターゲットの作成
UIを使用してターゲットを作成するには、以下を実行する。
あなたのアカウントにあるリソースのみがリストアップされ、選択可能です。 別のアカウントでリソースを指定するには、保存先の選択の下にある CRNの指定を選択します。
-
「メニュー」 アイコン
> **「可観測性」**をクリックします。
-
**「モニタリング」**をクリックします。
-
ルーティングをクリックします。
-
**「ターゲット」**タブをクリックします。
-
作成をクリックして、作成パネルを開きます。
-
Service authorization required: IBM Cloud Metrics RoutingがIBM Cloud Monitoringと通信するためには、サービスの認証が必要です。 ポリシーを自動的に作成するには Authorize now をクリックするか、Grant access in IAM をクリックします。
-
保存先を選択します:インスタンスで検索または CRNを指定を選んでください
- インスタンスで検索: IBM Cloud Monitoringインスタンスをテーブルから選択するか、作成をクリックして新しいIBM Cloud Monitoringインスタンスを作成します。
- Specify CRN: IBM Cloud Monitoringインスタンスのクラウドリソース名(CRN)を入力します。 これにより、別のアカウントからCRNを入力することができます。
-
ターゲットの詳細を指定する。
-
ターゲット名:ターゲットに意味のある名前を入力します。
-
対象地域:対象地域を選択する。
-
デフォルト・ターゲットとして設定を切り替えると、IBM Cloud Metrics Routing設定のデフォルト・ターゲットとして新しいターゲットが自動的に設定されます。 詳しくは デフォルトターゲットのドキュメント を参照してください。
- ターゲットを作成をクリックします。
UIを使用したターゲットの更新
UIを使用してターゲットを更新するには、以下を実行する。
あなたのアカウントにあるリソースのみがリストアップされ、選択可能です。 別のアカウントでリソースを指定するには、保存先の選択の下にある CRNの指定を選択します。
-
「メニュー」 アイコン
> **「可観測性」**をクリックします。
-
**「モニタリング」**をクリックします。
-
ルーティングをクリックします。
-
**「ターゲット」**タブをクリックします。
-
更新するターゲットを決定し、
をクリックします。
-
Unset as default をクリックして、IBM Cloud Metrics Routing 設定のデフォルト・ターゲットとしてターゲットを削除します。 詳しくは デフォルトターゲットのドキュメント を参照してください。
-
編集をクリックして更新パネルを開く。
-
詳細をクリックします:編集をクリックし、ターゲット名を更新します。 また、IBM Cloud Metrics Routing設定で、デフォルト・ターゲットを切り替えて、デフォルト・ターゲットとしてターゲットを追加または削除することもできます。
また、ターゲットに関連するルートを表示することもできます。
-
保存をクリックしてターゲットを更新します。
-
目的地をクリックします:Edit をクリックして、ターゲットに関連付けられているIBM Cloud Monitoringインスタンスを変更します。
-
保存をクリックしてターゲットを更新します。
UIを使用したターゲットの削除
UIを使用してターゲットを削除するには、以下の手順を実行する。
IBM Cloud Metrics Routingターゲットがルート内またはデフォルト・ターゲット設定として使用されている場合は、削除できません。
-
「メニュー」 アイコン
> **「可観測性」**をクリックします。
-
**「モニタリング」**をクリックします。
-
ルーティングをクリックします。
-
**「ターゲット」**タブをクリックします。
-
更新するターゲットを決定し、
をクリックします。
-
削除をクリックし、確認パネルで削除をクリックします。
UIを使った全ターゲットのリストアップ
UIを使用してすべてのターゲットをリストアップするには、以下の手順を実行する。
-
「メニュー」 アイコン
> **「可観測性」**をクリックします。
-
**「モニタリング」**をクリックします。
-
ルーティングをクリックします。
-
**「ターゲット」**タブをクリックします。
表はそれを示している:
-
ターゲット・タイプ
-
宛先名
-
宛先リージョン
-
ルート: ターゲットが定義されたルートで使われる場合のルートの数。
CLI の前提条件
CLI を使用してターゲットを管理する前に、以下の手順を実行します。
-
IBM Cloud にログインします。 次のコマンドを実行します。 ibmcloud login
-
IBM Cloud Metrics Routing の経路またはターゲットを構成する前に、1 次メタデータ領域を構成する必要があります。 1 次メタデータ領域は、
ibmcloud metrics-router setting update
コマンドの--primary-metadata-region
オプションを使用して構成されます。
CLIを使用したMonitoringターゲットの作成
このコマンドを使用してMonitoringターゲットを作成し、プラットフォーム・メトリクスのデスティ ネーションを構成します。
ターゲット名はアカウント内で固有です。
ibmcloud metrics-router target create --name TARGET_NAME --destination-crn CRN_VALUE [--region REGION] [--output FORMAT]
コマンド・オプション
--region REGION
|-r REGION
-
リージョンの名前 (
us-south
やeu-gb
など)。 指定しないと、ログインしたリージョン、またはターゲットのリージョンが使用されます。 --name TARGET_NAME
-
ターゲットに付ける名前。
リソース名に個人識別情報 (PII) を含めないでください。
--destination-crn CRN_VALUE
-
Monitoring インスタンスの CRN。
--output FORMAT
-
現在サポートされている形式は JSON です。 指定すると、出力が JSON 形式で返されます。
JSON
を指定しない場合は、出力が表形式で返されます。 help
|--help
|-h
-
コマンドで使用できるオプションがリストされます。
例
**ibmcloud metrics-router target create --name my-target --destination-crn crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
**コマンドの使用例を以下に示します。
ターゲットの作成が成功した例を以下に示します。
Target
Name: my-target
ID: 000000000-00000000-0000-0000-00000000
REGION: us-east
Type: sysdig_monitor
Destination CRN: crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
CreatedAt: 2021-07-21T16:04:15.174Z
UpdatedAt: 2021-07-21T16:04:15.174Z
CLIを使用したMonitoringターゲットの更新
このコマンドを使用して、Monitoringターゲットを更新する。 ターゲットおよび宛先 CRN の名前を変更することができます。 ターゲットが最初に作成された時の値とは異なる値をコマンドで指定すると、その値がコマンドの指定値に更新されます。
ターゲット名はアカウント内で固有です。
ibmcloud metrics-router target update --target TARGET [--name TARGET_NAME] [--destination-crn DESTINATION_TARGET_CRN] [--output FORMAT]
コマンド・オプション
--target TARGET
-
ID または現在のターゲット名。
--name TARGET_NAME
-
ターゲットに付ける名前。
リソース名に個人識別情報 (PII) を含めないでください。
--destination-crn DESTINATION_TARGET_CRN
-
Monitoring インスタンスの CRN。
--output FORMAT
-
現在サポートされている形式は JSON です。 指定すると、出力が JSON 形式で返されます。
JSON
を指定しない場合は、出力が表形式で返されます。 help
|--help
|-h
-
コマンドで使用できるオプションがリストされます。
例
**ibmcloud metrics-router target update --target my-target --name my-new-target-name
**コマンドの使用例を以下に示します。
Target
Name: my-new-target-name
ID: 000000000-00000000-0000-0000-00000000
REGION: us-east
CRN: crn:v1:bluemix:public:metrics-router:us-south:a/xxxxxxxxxx:000000000-00000000-0000-0000-00000000
Type: sysdig_monitor
Destination CRN: crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
CreatedAt: 2021-07-21T16:04:15.174Z
UpdatedAt: 2021-07-21T16:04:15.174Z
CLI を使用したターゲットの削除
このコマンドは、ターゲットを削除するために使用します。
ibmcloud metrics-router target rm --target TARGET [--force]
コマンド・オプション
--target TARGET
- ターゲットの ID または名前。
--force
|-f
- ユーザーに追加のプロンプトを出さずにターゲットを削除します。
help
|--help
|-h
- コマンドで使用できるオプションがリストされます。
例
**ibmcloud metrics-router target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
**コマンドの使用例を以下に示します。
Are you sure you want to remove the target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx? [y/N]>y
OK
Target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was successfully removed.
CLI を使用したターゲットに関する情報の取得
このコマンドを使用して、IBM Cloud Metrics Routing リージョンのターゲットに関する情報を取得します。
ibmcloud metrics-router target get --target TARGET [--output FORMAT]
コマンド・オプション
--target TARGET
- ターゲットの ID または名前。
--output FORMAT
- 現在サポートされている形式は JSON です。 指定すると、出力が JSON 形式で返されます。
JSON
を指定しない場合は、出力が表形式で返されます。 help
|--help
|-h
- コマンドで使用できるオプションがリストされます。
例
Monitoring ターゲットを表示する ibmcloud metrics-router target get --target new-target-name
コマンドの使用例を以下に示します。
Name: my-target
ID: 000000000-00000000-0000-0000-00000000
REGION: us-east
CRN: crn:v1:bluemix:public:metrics-router:us-south:a/xxxxxxxxxx:000000000-00000000-0000-0000-00000000
Type: sysdig_monitor
Destination CRN: crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
CreatedAt: 2021-07-21T16:04:15.174Z
UpdatedAt: 2021-07-21T16:04:15.174Z
リージョン内のすべてのターゲットのリスト
このコマンドを使用して、IBM Cloud Metrics Routing リージョンの構成済みターゲットを表示します。
ibmcloud metrics-router target ls [--output FORMAT]
コマンド・オプション
--output FORMAT
- 現在サポートされている形式は JSON です。 指定すると、出力が JSON 形式で返されます。
JSON
を指定しない場合は、出力が表形式で返されます。 help
|--help
|-h
- コマンドで使用できるオプションがリストされます。
例
**ibmcloud metrics-router target ls
**コマンドの使用例を以下に示します。
Name ID Region Type CreatedAt UpdatedAt
target-01 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx us-south sysdig_monitor 2020-11-18T03:52:08.603Z 2020-11-19T03:52:08.603Z
target-02 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy us-south sysdig_monitor 2020-11-18T03:52:01.592Z 2020-11-19T03:52:08.603Z
target-02-backup zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz us-east sysdig_monitor 2021-02-26T06:53:13.466Z 2020-11-19T03:52:08.603Z
API のターゲットとアクション
次の表は、ターゲットを管理するために実行できるアクションのリストです。
アクション | REST API メソッド | API_URL |
---|---|---|
ターゲットの作成 | POST |
<ENDPOINT>/api/v3/targets |
ターゲットの更新 | PATCH |
<ENDPOINT>/api/v3/targets/<TARGET_ID> |
ターゲットの削除 | DELETE |
<ENDPOINT>/api/v3/targets/<TARGET_ID> |
ターゲットの読み取り | GET |
<ENDPOINT>/api/v3/targets/<TARGET_ID> |
すべてのターゲットのリスト | GET |
<ENDPOINT>/api/v3/targets |
プライベート・エンドポイントとパブリック・エンドポイントを使用してターゲットを管理することができます。 使用可能な ENDPOINTS
のリストについて詳しくは、エンドポイントを参照してください。
-
https://private.REGION.metrics-router.cloud.ibm.com
という形式の API エンドポイントを使用して、プライベート・ネットワークからターゲットを管理できます。 -
https://REGION.metrics-router.cloud.ibm.com
という形式の API エンドポイントを使用して、パブリック・ネットワークからターゲットを管理できます。 -
アカウント設定を更新することで、パブリック・エンドポイントを無効にすることができます。 詳しくは、ターゲットとリージョンの設定の構成を参照してください。
REST API について詳しくは、 ターゲットを参照してください。
API の前提条件
ターゲットを管理するための API 呼び出しを行うには、以下のステップを実行します。
- IAM アクセス・トークンを取得します。 詳しくは、IAM アクセス・トークンの取得を参照してください。
- ターゲットを構成または管理する予定のリージョン内の API エンドポイントを特定します。 詳しくは、エンドポイントを参照してください。
- IBM Cloud Metrics Routing の経路またはターゲットを構成する前に、1 次メタデータ領域を構成する必要があります。 1 次メタデータ領域は、 設定の変更 API メソッド を使用して構成されます。
APIを使用したMonitoringターゲットの作成
以下のcURLコマンドを使用して、Monitoringターゲットを作成することができます:
ターゲット名はアカウント内で固有です。
curl -X POST <ENDPOINT>/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "TARGET_NAME",
"destination_crn": "CRN"
}'
説明
-
<ENDPOINT>
は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。 -
TARGET_NAME
は、ターゲットの名前です。 この名前の最大長は 256 文字です。リソース名に個人識別情報 (PII) を含めないでください。
-
CRN
は、 Monitoring インスタンスの CRN を示します。
例えば、次の cURL 要求を使用して、ダラスにターゲットを作成できます。
curl -X POST https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "My-target",
"target_type": "crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::"
}'
応答では、ターゲットの GUID を示す id
やターゲットの CRN を示す crn
など、ターゲットに関する情報が得られます。
APIを使用したMonitoringターゲットの更新
ターゲットおよび宛先 CRN の名前を変更することができます。 ターゲットが最初に作成されたときと異なる指定された値は、リクエストで指定された値に更新される。
Monitoringターゲットを更新する場合、リクエストのデータセクションにターゲット情報を含める必要があります。
- すべてのフィールドを渡す必要があります。
- 変更する必要があるフィールドを更新します。
ターゲット名はアカウント内で固有です。
以下の cURL コマンドを使用して、ターゲットを更新できます。
curl -X PATCH <ENDPOINT>/api/v3/targets/TARGET_ID -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "TARGET_NAME",
"destination_crn": "CRN"
}'
説明
-
<ENDPOINT>
は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。 -
TARGET_ID
はターゲットの ID です。 -
TARGET_NAME
は、ターゲットの名前です。 この名前の最大長は 256 文字です。リソース名に個人識別情報 (PII) を含めないでください。
-
CRN
は、 Monitoring インスタンスの CRN を示します。
例えば、次の cURL 要求を使用して、ダラスにターゲットを作成できます。
curl -X PATCH https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "My target",
"destination_crn": "crn:v1:bluemix:public:sysdig-monitor:au-syd:a/<account-id>:<instance-id>::"
}
}'
API を使用したターゲットの削除
以下の cURL コマンドを使用して、ターゲットを削除できます。
curl -X DELETE <ENDPOINT>/api/v3/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
説明
<ENDPOINT>
は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。<TARGET_ID>
はターゲットの ID です。
例えば、ID '00000000-0000-0000-0000-000000000000
を持つターゲットを削除するには、次のようなcURLリクエストを使用します:
curl -X DELETE https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
API を使用したターゲットの表示
次の cURL コマンドを使用して、1 つのターゲットの構成の詳細を表示することができます。
curl -X GET <ENDPOINT>/api/v3/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
説明
<ENDPOINT>
は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。<TARGET_ID>
はターゲットの ID です。
例えば、以下の cURL 要求を実行して、ID 00000000-0000-0000-0000-000000000000
のターゲットに関する情報を取得できます。
curl -X GET https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
API を使用したすべてのターゲットのリスト表示
次の cURL コマンドを使用して、すべてのターゲットを表示できます。
curl -X GET <ENDPOINT>/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
説明
<ENDPOINT>
は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。
例えば、以下の cURL 要求を実行して、ダラスで定義されているターゲットに関する情報を取得できます。
curl -X GET https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
HTTP 応答コード
IBM Cloud Metrics Routing REST API を使用すると、メソッドが正常に完了したかどうかを示す標準 HTTP 応答コードを取得できます。
- 200 応答は、どのような場合でも成功を示しています。
- 4xx 応答は、失敗を示しています。
- 5xx応答は内部システムエラーを示す。
いくつかの HTTP 応答コードについては、以下の表を参照してください。
状況コード | ステータス | 説明 |
---|---|---|
200 |
OK | 要求は正常に終了しました。 |
201 |
OK | 要求は正常に終了しました。 リソースが作成されます。 |
400 |
誤った要求 | 要求は失敗しました。 必要なパラメーターが欠落している可能性があります。 |
401 |
無許可 | API 要求で使用されている IAM トークンは無効であるか、有効期限が切れています。 |
403 |
禁止 | 権限が不十分なため、操作は禁止されました。 |
404 |
見つかりません | 要求されたリソースは存在しないか、既に削除されています。 |
429 |
要求が多すぎる | API に到達する要求の数が多すぎるうえに各要求の間隔が短すぎます。 |
500 |
内部サーバー・エラー | IBM Cloud Metrics Routing の処理で何らかの問題が発生しました。 |