Cloud Insightの概要

概要

Cloud Insight APIを使用すると、NAVERクラウドプラットフォームでサーバまたはアプリケーションの性能/運用メトリックを管理してモニタリングできます。
Cloud Insight APIは RESTfulの形式で提供されます。HTTP方式の GET/POST/PUT/DELETEメソッドの呼び出しを介して行われます。

共通設定

API URL

https://cw.apigw.ntruss.com

リクエストヘッダ

次は Javaで「x-ncp-apigw-signature-v2」を作成するサンプルコードです。詳細は、API Gatewayの文書をご参照ください。

public String makeSignature() {
    String space = " ";                    // one space
    String newLine = "\n";                    // new line
    String method = "GET";                    // method
    String url = "/photos/puppy.jpg?query1=&query2";    // url (include query string)
    String timestamp = "{timestamp}";            // current timestamp (epoch)
    String accessKey = "{accessKey}"            // access key id (from portal or sub account)
    String secretKey = "{secretKey}";

    String message = new StringBuilder()
        .append(method)
        .append(space)
        .append(url)
        .append(newLine)
        .append(timestamp)
        .append(newLine)
        .append(accessKey)
        .toString();

    SecretKeySpec signingKey = new SecretKeySpec(secretKey.getBytes("UTF-8"), "HmacSHA256");
    Mac mac = Mac.getInstance("HmacSHA256");
    mac.init(signingKey);

    byte[] rawHmac = mac.doFinal(message.getBytes("UTF-8"));
    String encodeBase64String = org.apache.commons.codec.binary.Base64.encodeBase64String(rawHmac);

  return encodeBase64String;
}

基本情報

Cloud Insightを使用する前に、知っておくべき基本的な情報をいくつかご紹介します。

商品

• Cloud Insightは商品ごとに異なる方法でデータを処理します。Cloud Insightに商品情報を登録した後、Cloud Insightにその商品のデータを保存できます。

商品キー(Key)

• 商品を登録すると、商品キーが発行されます。そのキーは、商品を区別する用途で使用されます。
• Cloud Insight APIを使用する際、商品ごとに発行された商品キーの認証を受けると呼び出しが承認されます。

商品名(Product Name)

• Cloud Insightは、NAVERクラウドプラットフォーム商品から収集されたデータのみを処理するのではなく、顧客のアプリケーションから発生するデータも収集できます。
• 画面でユーザーが NAVERクラウドプラットフォーム商品のデータかユーザーの Customデータかを簡単に区別できるようにするために、Namingを System/Load Balancer、System/CloudSearch、System/Serverのように System/商品名の形で表示します。ユーザーの Custom Productは Custom/MyProductのような形で表示されます。

Metricと Dimension

• Metricはユーザーが扱う数字の形の値を意味します。
• Dimensionは特定データの属性で、どんなサーバに属しているのか、どんなところに位置しているのか、何の値であるのかなどを意味します。
• 商品を登録する際は、商品が持つ項目別にそれが Metricなのか、Dimensionなのかを指定する必要があります。NAVERクラウドプラットフォーム商品の Metricと Dimensionの詳細は、商品リストページをご参照ください。

集計(Aggregation)

• ほとんどの商品は1分間隔でパフォーマンスデータを収集します。必要に応じて、1分より早く、または1分より長い間隔で収集することもあります。これらのデータは収集された形のまま(raw data)、Cloud Insightに保存されます。
• Customデータもこれと同様に、ユーザーの必要に応じて適切な周期で収集されます。収集されたデータは、一定周期ごとにさまざまな集計関数を利用して演算されます。
• 現在対応している関数は、AVG、MIN、MAX、COUNT、SUMなどで、追って COUNTERが追加される予定です。COUNTERは、転送した合計 byte数のように累計値を収集する場合、前回収集した値より増加した値を演算する際に使用できます。

集計周期(Interval)

• 集計は現在、1分、5分、30分、2時間、1日おきに実行されます。例えば、5分の集計は10時0分0秒~10時4分59秒、10時5分0秒~10時9分59秒、...に収集された値を利用して集計します。
• 集計された結果としては、1分、5分、30分、2時間、1日ごとにAVG、MIN、MAX、COUNT、SUM値が生成されます。

データ集計周期による推奨照会期間

• データの集計周期によって推奨する照会可能期間が異なります。詳細は、以下の表をご参照ください。

オペレーション

Schema関連の API

• Product Schemaの登録: RegisterProductSchema
• Product Schemaの照会: GetProductSchema
• Product Schemaの更新: UpdateProductSchema
• Productの削除: DeleteProductSchema
• Instanceの Extended設定有無の照会: GetExtendedStatus
• Instanceに Extendedを設定: UpdateExtendedEnable
• Instance Extended設定の解除: UpdateExtendedDisable
• System Schema cw_keyの照会: GetSystemSchemaKeyList

Plugin関連の API

• File Pluginの登録/照会: AddFilePlugin、RemoveFilePlugin、UpdateFilePlugin、GetFilePlugin、GetAllFilePlugin
• Port Pluginの登録/照会: AddPortPlugin、RemovePortPlugin、UpdatePortPlugin、GetPortPlugin、GetAllPortPlugin
• Process Pluginの登録/照会: AddProcessPlugin、RemoveProcessPlugin、UpdateProcessPlugin、GetProcessPlugin、GetAllProcessPlugin

データ収集関連の API

• Cloud Insightにデータをエクスポート: SendData

データ照会関連の API

• Cloud Insightに保存されているデータを照会: QueryData、QueryDataMultiple

Event関連の API

• Event数の確認: SearchEventCountConsole
• Eventの照会: SearchEvent、SearchEventById

Event Rule関連の API

• 監視対象グループ
  • 監視対象グループの作成: CreateMonitorGrp
  • 監視対象グループの照会: GetAllMonitorGrp、GetMonitorGrp
  • 監視対象グループの更新: UpdateMonitorGrp
  • 監視対象グループの削除: DeleteMonitorGrp、RemoveResourceFromRules
• 監視項目グループ
  • 監視項目グループの作成: CreateMetricsGrp
  • 監視項目グループの照会: GetMetricsGroupList、GetMetricsGroup、SearchMetricList
  • 監視項目グループの更新: UpdateMetricsGroup
  • 監視項目グループの削除: DeleteMetricsGrpByProdKeyAndId、DeleteMetricsGrp
• Event Rule
  • Event Ruleの作成: CreateRuleGroup、CreateRuleDirectly、CopyRuleGroup
  • Event Ruleの照会: GetRuleGroupList、GetRuleGroup、GetRuleGroupByMonitorGroupIds、GetRuleGroupByMetricGroupIds
  • Event Ruleの更新: UpdateRuleGroup
  • Event Ruleの削除: DeleteRuleGroupByProdKeyAndId、DeleteRuleGroup、DeleteMonitorGroupForce、DeleteMetricGroupForce

Chart関連の API

• Metricを指定して Widget Previewデータを照会: QueryWidgetDataPreview

Server関連の API

• CPU、Memory、File Systemの使用率が高い Top 5サーバを照会: GetServersTop

Custom Resource関連の API

• Custom Resourceの作成: CreateCustomResource
• Custom Resourceの照会: GetCustomResource、GetAllCustomResource
• Custom Resourceの更新: UpdateCustomResource
• Custom Resourceの削除: DeleteCustomResource

Planned Maintenance関連の API

• Planned Maintenanceの作成: CreatePlannedMaintenance
• Planned Maintenanceの削除: DeletePlannedMaintenance
• Planned Maintenanceリストの照会: GetPlannedMaintenanceList
• Planned Maintenanceの詳細照会: GetPlannedMaintenanceDetailById
• Planned Maintenanceの更新: UpdatePlannedMaintenance