Cloud Insight Overview

Article Summary

Share feedback

Thanks for sharing your feedback!

Summary

Through Cloud Insight API, you can manage and monitor the performance/operation metric of servers or applications in NAVER Cloud Platform.
The Cloud Insight API is provided in the RESTful format. It is done through the HTTP GET/POST/PUT/DELETE method call.

Common Setting

API URL

https://cw.apigw.ntruss.com

Request header

Header	Description
x-ncp-apigw-timestamp	This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference compared to the APIGW server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	API Key issued by NAVER Cloud Platform or AccessKey issued by Sub Account.
x-ncp-apigw-signature-v2	This is the signature used to encrypt the body of the example above with SecretKey that maps with AccessKey. The HMAC encryption algorithm HmacSHA256 is used.
x-ncp-dmn_cd	PUB is used for NAVER Cloud Platform (default: PUB)

The following code example creates "x-ncp-apigw-signature-v2" in Java. Please refer to API Gateway for details.

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;
}

Basic information

This section explains the basic information for using Cloud Insight.

Product

Since Cloud Insight processes data differently according to the product, register the product information to Cloud Insight, and then save the product data in Cloud Insight.

Product Key

A product key is issued when you register your product. It is used to identify the product.
You can only call an API from Cloud Insight by authenticating each product with the product key issued.

Product Name

Cloud Insight not only processes the data collected by NAVER Cloud Platform product, but also collects the data generated by a customer's application.
NAVER Cloud Platform product data is displayed in "System/product name" form, such as System/Load Balancer, System/CloudSearch, and System/Server, to help users identify whether the screen is showing NAVER Cloud Platform product data or the user's custom data. The users' custom product is displayed in "Custom/MyProduct" form.

Metric and Dimension

Metric refers to the user's numeric data.
Dimension is the data attributes that indicate which server it belongs to and where it is located, as well as what the value represents.
You need to designate whether it is a metric or a dimension by item when registering each product. Please refer to Product List Page for more details on the metric and dimension of NAVER Cloud Platform products.

Aggregation

Cloud Insight generally collects performance data every minute, but the interval can be changed as needed. The collected data are saved in Cloud Insight in raw data form.
Similarly, custom data are collected in intervals as needed by the user. The collected data are used for calculation by various aggregation functions at specific intervals.
The currently supported functions include AVG, MIN, MAX, COUNT, and SUM. COUNTER will be added in the future. COUNTER can be used to calculate the increased value, compared with the last collected value, when collecting the accumulated value, such as the total number of bytes transmitted.

Aggregation interval

Currently, the aggregation interval can be 1 minute, 5 minutes, 30 minutes, 2 hours, or 1 day. For example, a 5-minute aggregation uses the values collected from 10:00:00 through 10:04:59, 10:05:00 through 10:09:59, and so forth.
The aggregation result generates the AVG, MIN, MAX, COUNT, and SUM values every 1 minute, 5 minutes, 30 minutes, 2 hours, or 1 day.