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分より短いか長い間隔で収集することもあります。 これらのデータは収集された形のまま(raw data)、Cloud Insightに保存されます。
• Customデータもこれと同様に、ユーザーの必要に応じて適切な周期で収集されます。 このように収集されたデータは、一定周期ごとに様々な集計関数を利用して演算されます。
• 現在対応している関数は、AVG、MIN、MAX、COUNT、SUMなどで、今後COUNTERが追加される予定です。 COUNTERは、伝送した合計byte数のように累計値を収集する場合、前回収集した値より増加した値を演算する際に使用できます。

集計周期(Interval)

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

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

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

オペレーション

Schemaに関するAPI

• Product Schema登録：RegisterProductSchema
• Product Schema照会：GetProductSchema
• Product Schema修正：UpdateProductSchema
• Product削除：DeleteProductSchema
• インスタンスのExtended設定有無を照会 : GetExtendedStatus
• インスタンスにExtended設定 : UpdateExtendedEnable
• インスタンス·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