カスタム・メトリックの公開

このトピックでは、独自のカスタム・メトリックモニタリング・サービスに公開する方法について説明します。

独自のメトリックをモニタリングに公開するには、APIを使用します。コンソールを使用して公開済メトリックのチャートを表示したり、APIを使用してメトリックを問い合せたり、コンソールまたはAPIを使用してアラームを設定したりできます。

警告

Oracle Cloud Infrastructureコンソール、APIまたはCLIを使用して、クラウド・リソースに説明、タグまたはわかりやすい名前を割り当てる場合、機密情報を入力することは避けてください。

前提条件

IAMポリシー: カスタム・メトリックを公開するには、管理者が作成したポリシーで必要なアクセス・タイプを付与される必要があります。この要件は、コンソールまたはREST APIを、SDK、CLIまたはその他のツールのどれと使用する場合でも適用されます。権限がない、または認可されていないというメッセージが表示された場合は、管理者に確認してください。現在のコンパートメント に必要なアクセス・タイプがない可能性があります。管理者: 関連する共通ポリシーについては、ユーザーによるカスタム・メトリックの公開を参照してください。

APIの使用

APIの使用およびリクエストの署名の詳細は、REST APIおよびセキュリティ資格証明を参照してください。SDKの詳細は、ソフトウェア開発キットとコマンドライン・インタフェースを参照してください。

ノート

カスタム・メトリックを定義する場合は、次の点に注意してください:

  • カスタム・メトリックが制限を超えないようにします。たとえば、有効なディメンション範囲とカスタム・メトリックの最大ストリーム数に気を付けてください。PostMetricDataを参照してください。
  • 集計を考慮してメトリックを定義します。カスタム・メトリックは1秒ごとに頻繁にポストできますが(最小頻度は1秒)、最小集約間隔は1分です。
  • 返される際の制限を考慮してメトリックを定義します。 返されるデータの制限情報には、100,000データ・ポイントの最大値と時間範囲の最大値(レゾリューションによって決定され、間隔に関連しています)が含まれます。MetricDataリファレンスを参照してください。

次のAPI操作を使用してカスタム・メトリックを公開します:

PostMetricData

ノート

推奨事項は次のとおりです:

  • バッチ処理されたリクエストを送信して、リクエストごとのメトリック・ストリームを最大化します。バッチ処理されたリクエストには、複数のメトリックまたはメトリック・ネームスペースが含まれます。制限に注意してください。PostMetricDataを参照してください。
  • メトリックの公開は、関連するコンテキストでモニタリングが必要な場合、つまりデータ・ポイントを収集する必要がある場合にのみ実行します。観測データが存在しないときに非アクティブな期間中にメトリックを公開する場合は、手動で"0"値を作成して公開できます。

発行されたカスタム・メトリックには、モニタリング・サービスによって格納されている他のメトリックと同じ方法でアクセスできます。コンソールを使用した問合せからのグラフの表示、CLIまたはAPIを使用したメトリックの問合せ、およびコンソール、CLIまたはAPIを使用したアラームの設定を行います。

バッチ処理されたリクエストの例

この例は、2つのメトリック・ネームスペース間のメトリックのデータ・ポイントを含む単一のリクエストを示しています。

[
   {
      "namespace":"myFirstNamespace",
      "compartmentId":"ocid1.compartment.oc1..exampleuniqueID",
      "resourceGroup":"myFirstResourceGroup",
      "name":"successRate",
      "dimensions":{
         "resourceId":"ocid1.exampleresource.region1.phx.exampleuniqueID",
         "appName":"myAppA"
      },
      "metadata":{
         "unit":"percent",
         "displayName":"MyAppA Success Rate"
      },
      "datapoints":[
         {
            "timestamp":"2019-03-10T22:19:20Z",
            "value":83.0
         },
         {
            "timestamp":"2019-03-10T22:19:40Z",
            "value":90.1
         }
      ]
   },
   {
      "namespace":"myFirstNamespace",
      "compartmentId":"ocid1.compartment.oc1..exampleuniqueID",
      "resourceGroup":"mySecondResourceGroup",
      "name":"successRate",
      "dimensions":{
         "resourceId":"ocid1.exampleresource.region1.phx.differentuniqId",
         "appName":"myAppA"
      },
      "metadata":{
         "unit":"percent",
         "displayName":"MyAppA Success Rate"
      },
      "datapoints":[
         {
            "timestamp":"2019-03-10T22:19:10Z",
            "value":100.0
         },
         {
            "timestamp":"2019-03-10T22:19:30Z",
            "value":100.0
         }
      ]
   },
   {
      "namespace":"mySecondNamespace",
      "compartmentId":"ocid1.compartment.oc1..exampleuniqueID",
      "name":"deliveryRate",
      "dimensions":{
         "resourceId":"ocid1.exampleresource.region1.phx.exampleuniqueID",
         "appName":"myAppB"
      },
      "metadata":{
         "unit":"bytes",
         "displayName":"MyAppB Delivery Rate"
      },
      "datapoints":[
         {
            "timestamp":"2019-03-10T22:19:00Z",
            "value":87.0,
            "count":60
         },
         {
            "timestamp":"2019-03-10T22:19:00Z",
            "value":96.0,
            "count":30
         }
      ]
   }
]