メトリックの管理
Hyper Protect Crypto Services インスタンスをセットアップしたら、サービス API を使用してモニタリング・メトリックを管理できます。
メトリック設定の管理
Hyper Protect Crypto Services インスタンスのメトリックは追加のポリシーであり、これを使用して Hyper Protect Crypto Services インスタンスの運用メトリックを受け取ることができます。 このポリシーを有効にしたら、Monitoring を使用して、Hyper Protect Crypto Services インスタンスでリソースに対して実行されたすべての操作をモニターできます。
Hyper Protect Crypto Services インスタンスの運用メトリックを有効にする前に、以下の考慮事項に注意してください。
-
Hyper Protect Crypto Services インスタンスのメトリックを有効にすると、ポリシーを有効にした後のメトリックだけが報告されます。
メトリック・ポリシーを有効にすると、ポリシーがアクティブになった後にインスタンスで実行されるすべての API 要求の運用メトリックが表示されるようになります。 ポリシーを有効にする前のメトリックは表示できません。
-
メトリックを表示するには、まず Monitoring インスタンスをプロビジョンする必要があります。
運用メトリックを受け取る対象の Hyper Protect Crypto Services インスタンスと同じ地域にある Monitoring インスタンスをプロビジョン する必要があります。 Monitoring インスタンスをプロビジョンしたら、プラットフォーム・メトリックを有効にする必要があります。
UI を使用した Hyper Protect Crypto Services インスタンスのメトリックの有効化
Hyper Protect Crypto Services インスタンスを作成し、Monitoring インスタンスをプロビジョンし、プラットフォーム・メトリックを有効にしたら、以下の手順を実行してメトリック・ポリシーを有効にします。
- UI にログインします。
- 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
- IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。
- 選択したサービス・インスタンスの UI で、サイド・メニューの**「インスタンス・ポリシー (Instance policies)」**タブを選択します。
- **「メトリック」セクションで、「メトリックを IBM Cloud Monitoring に送信 (Send metrics to IBM Cloud Monitoring)」にチェック・マークを付け、「ポリシーの保存」**をクリックします。
API を使用した Hyper Protect Crypto Services インスタンスのメトリックの有効化
インスタンス管理者が、以下のエンドポイントに PUT
呼び出しを実行して、Hyper Protect Crypto Services インスタンスのメトリック・ポリシーを有効にします。
https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics
-
メトリクス・ポリシーを有効にするには、Hyper Protect Crypto Services インスタンスに_「マネージャー」_ IAM ロールが割り当てられている必要があります。 IAM 役割と Hyper Protect Crypto Services サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。
-
次の
curl
コマンドを実行して、Hyper Protect Crypto Services インスタンスのメトリック・ポリシーを有効にします。curl -X PUT \ "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "content-type: application/vnd.ibm.kms.policy+json" \ -d '{ "metadata": { "collectionType": "application/vnd.ibm.kms.policy+json", "collectionTotal": 1 }, "resources": [ { "policy_type": "metrics", "policy_data": { "enabled": false } } ] }'
次の表に従って、例の要求内の変数を置き換えてください。
表 1. メトリック・ポリシーを有効にするために必要な変数について説明します。 変数 説明 region
必須。 Hyper Protect Crypto Services インスタンスが存在する地理的領域を表す地域の省略形 ( us-south
など)。 詳細については、リージョナル・サービス・エンドポイントを参照してください。port
必須。 API エンドポイントのポート番号。 IAM_token
必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、 IAM
トークンのすべてのコンテンツをcurl
要求に組み込みます。 詳しくは、アクセス・トークンの取得を参照してください。instance_ID
必須。 Hyper Protect Crypto Services インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。 要求が成功すると、
204 No Content
の HTTP 応答が返されます。これは、Hyper Protect Crypto Services で運用メトリックの報告が有効になったことを示しています。この新規ポリシーは、ポリシーが有効になった後に実行された操作についてのみ報告します。
-
オプション: Hyper Protect Crypto Services インスタンスに存在するポリシーを参照して、メトリック・ポリシーが作成されていることを確認します。
$ curl -X GET \ "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>"
API を使用した Hyper Protect Crypto Services インスタンスのメトリックの無効化
インスタンス管理者が、以下のエンドポイントに PUT
呼び出しを実行して、Hyper Protect Crypto Services インスタンスの既存のメトリック・ポリシーを無効にします。
https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics
-
メトリクス・ポリシーを有効にするには、Hyper Protect Crypto Services インスタンスに_「マネージャー」_ IAM ロールが割り当てられている必要があります。 IAM 役割と Hyper Protect Crypto Services サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。
-
次の
curl
コマンドを実行して、Hyper Protect Crypto Services インスタンスの既存のメトリック・ポリシーを無効にします。$ curl -X PUT \ "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "content-type: application/vnd.ibm.kms.policy+json" \ -d '{ "metadata": { "collectionType": "application/vnd.ibm.kms.policy+json", "collectionTotal": 1 }, "resources": [ { "policy_type": "metrics", "policy_data": { "enabled": false } } ] }'
次の表に従って、例の要求内の変数を置き換えてください。
表 2. メトリック・ポリシーを無効にするために必要な変数について説明します。 変数 説明 region
必須。 Hyper Protect Crypto Services インスタンスが存在する地理的領域を表す地域の省略形 ( us-south
など)。 詳細については、リージョナル・サービス・エンドポイントを参照してください。port
必須。 API エンドポイントのポート番号。 IAM_token
必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、 IAM
トークンのすべてのコンテンツをcurl
要求に組み込みます。 詳しくは、アクセス・トークンの取得を参照してください。instance_ID
必須。 Hyper Protect Crypto Services インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。 要求が成功すると、
204 No Content
の HTTP 応答が返されます。これは、サービス・インスタンスのメトリック・ポリシーが無効になったことを示しています。 -
オプション: Hyper Protect Crypto Services インスタンスに存在するポリシーを参照して、メトリック・ポリシーが無効になったことを確認します。
$ curl -X GET \ "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>"
次の作業
Hyper Protect Crypto Services で Monitoring インスタンスを構成する方法について詳しくは、運用メトリックのモニターを確認してください。