Custom Schema

Prev Next

Available in Classic and VPC

This guide describes how to create and manage custom schemas using the Custom Schema service.

You can create custom schemas and send them to the Custom Schema service through the Cloud Insight API. The data collected can be utilized in Cloud Insight and can also be queried via API. For data transfer and retrieval APIs, see the Cloud Insight API guide.

To access the Custom Schema menu, access the NAVER Cloud Platform portal, then go to [Console] > i_menu > Services > Management & Governance > Cloud Insight > Configuration > Custom Schema.

Custom Schema interface

The basic layout of the Custom Scheme interface is as follows:

cloudinsight-use-customschema_screen_new_ko

Component Description
① Menu name Current menu name.
② Basic features What's available when you first enter the Custom Schema menu
  • [Create Custom Schema]: Click to create a custom schema (seeCreating Custom Schema ).
  • [Learn More About the Product]: Sends you to the About Cloud Insight page
  • [Refresh]: Click to refresh the Custom Schema list
③ Post-creation Features Features that are enabled after creating a Custom Schema
④ Search Bar You can search by Product Type or Metric name.
⑤ Custom Schema List Displays all Custom Schema you’ve created
  • CW_KEY: Used as a data transfer and lookup key to distinguish schemas
  • [Data Transfer Example]: Click to check your schema and the format of sample data transfers.

Create a Custom Schema

To create a custom scheme, follow the steps below.

  1. In the NAVER Cloud Platform console, click i_menu > Services > Management & Governance > Cloud Insight menu in order.
  2. Go to Configuration > Custom Schema.
  3. Click [Create Custom Schema].
  4. In Product Type, enter the name of the schema you want to create.
  5. In the [Collection Settings] tab, specify the data you want to collect.
    • Enter the ID Dimension for the data you want to collect.
      • Generates targets based on the data collected via the ID Dimension.
    • Select the Data Type of the ID Dimension.
      • You can choose from STRING, INTEGER, or LONG.
  6. Click the [Metric] tab and define the metric for your Schema.
    • Click [Add] and enter the metric information.
      • Metric: Metric Name
      • Description: Metric Description
      • Data Type: Types of data to aggregate
      • Aggregation Cycle: Aggregation cycle
      • Aggregation: Aggregate functions
      • Unit: Aggregate data units
    • Example: Metric: mem_used / Description: memory / Data Type: FLOAT / Aggregation Cycle: Min1, Min30, Day1 / Aggregation: AVG, COUNT / Unit: %
      The mem_used metric is collected as a FLOAT type. When you send data to this Schema, the data is stored in Cloud Insight with an AVG (average) and COUNT (number of collections) aggregated on a 1-minute/30-minute/1-day basis.
  7. Click the [Dimension] tab and set the Dimension for your schema.
    • Click the [Add] button and enter the Dimension information.
      • Dimension: Dimension Name
      • Description: Dimension Description
      • Data Type: Types of data to send
  8. Click the [Create] button.
    • Click the [Data Transfer Example] button to check your schema and the format of sample data transfers
    • Click the [JSON] button to read or write the schema you set in JSON format.

Edit a Custom Schema

To edit a custom schema, follow the steps below.

  1. In the NAVER Cloud Platform console, click i_menu > Services > Management & Governance > Cloud Insight menu in order.
  2. Go to Configuration > Custom Schema.
  3. Select the custom scheme you want to modify and click [Edit].
  4. On the Edit Custom Schema interface, make the changes you want to make and click [Save].
    • You cannot modify ID Dimension, Metric, Dimension, and or Data Type values.
    • For more information on each item, see Create a Custom Schema.

Delete a Custom Schema

To delete a custom schema, follow the steps below.

  1. In the NAVER Cloud Platform console, click i_menu > Services > Management & Governance > Cloud Insight menu in order.
  2. Go to Configuration > Custom Schema.
  3. Select the custom scheme you want to delete and click the [Delete] button.
  4. Check the details in the notification popup window, and click the [Delete] button.