Cloud Insight overview

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

The Cloud Insight API allows you to manage and monitor performance and operational metrics of your server or application on NAVER Cloud Platform.
The Cloud Insight API is provided in the RESTful format. This is done by calling the GET/POST/PUT/DELETE methods over HTTP.

Common settings

API URL

https://cw.apigw.ntruss.com

Request headers

Header name	Description
x-ncp-apigw-timestamp	- This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC - Request is considered invalid if the timestamp differs from the current time by more than 5 minutes
x-ncp-iam-access-key	API key issued by NAVER Cloud Platform or access key issued by Sub Account
x-ncp-apigw-signature-v2	- Signature signed by the secret key that matches the access key in the sample body above - Use the HMAC-SHA256 encryption algorithm
x-ncp-dmn_cd	PUB is used for NAVER Cloud Platform (default: PUB)

The following is an example of creating "x-ncp-apigw-signature-v2" in Java. Please see the API Gateway documentation 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 walks you through some basic information you should know before using Cloud Insight.

Product

Cloud Insight processes data differently for each product. After you register your product information in Cloud Insight, you can store data for that product in Cloud Insight.

Product Key

A product key is issued when you register your product. It is used to identify the product.
When using the Cloud Insight API, you must be authenticated with a product key issued by each product before calls are authorized.

Product name

Cloud Insight not only processes the data collected by NAVER Cloud Platform products, but also collects the data generated by customer applications.
To make it easier for users to distinguish whether it is NAVER Cloud Platform product data or user's custom data on the page, the naming is displayed in the form of System/product name, such as System/Load Balancer, System/CloudSearch, and System/Server. User's custom products are displayed in the form of Custom/MyProduct.

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. See the Product list page for details on metrics on dimensions of NAVER Cloud Platform products.

Aggregation

Most products collect performance data at one-minute intervals, but they can be shorter or longer as needed. This data is stored in Cloud Insight as it is collected (raw data).
Custom data is similarly collected at appropriate intervals based on your needs. The collected data is computed using a number of aggregation functions at regular intervals.
Currently supported functions include AVG, MIN, MAX, COUNT, and SUM, with COUNTER being added in the future. COUNTER can be used when collecting cumulative values, such as the total number of bytes sent, to calculate the increase from the last time the value was collected.

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 aggregated results produce AVG, MIN, MAX, COUNT, and SUM values every 1 minute, 5 minutes, 30 minutes, 2 hours, and 1 day.