Monitoring > Cloud Monitoring > Console User Guide
This document explains the basics of using the Cloud Monitoring service.
Dashboard
In Monitoring > Cloud Monitoring > Dashboard, you can create chart widgets and configure dashboards to view various metrics collected from resources created by NHN Cloud services.
The metric data view period for user dashboards defaults to retrieving data up to five minutes prior to the current time. The default auto-refresh interval is 1 minute.
If you set a custom duration, auto-refresh is disabled.
View Mode/Edit Mode
The dashboard has two modes: view mode and edit mode.
Dashboard appears in the view mode by default, and to modify a dashboard or widget, you must click the Edit mode toggle to switch to the edit mode.
In the edit mode, you can edit the name or description of a dashboard, or clone or delete a dashboard. You can also edit each widget, or reposition and clone widgets.
Any changes you make to the widget, such as adding a widget or modifying its location and size, don't take effect until you click Save All. If you don't, you'll see a save notification modal, and any unsaved changes will disappear.
Create a Dashboard
In the view mode, click + to the right of the Dashboard tab to open the Add dashboard modal.
If no dashboards have been created, you'll see + Create Dashboard.
Enter a dashboard name and dashboard description. The dashboard name is a required value, and can be set to a duplicate name, but we recommend using a unique name whenever possible. Dashboard description is an optional value and you can enter something descriptive of the dashboard.
Set up a Dashboard
You can add widgets and groups of widgets to a dashboard. You can add up to 12 widgets per dashboard, and they are added to the bottom of the dashboard when you add them.
Widgets are the smallest unit of organization for a dashboard. They can be created by clicking + Add Widget or by selecting Add Widget, Add Widget Template from the drop-down list of the corresponding button. The size and position of widgets can be freely changed in dashboard edit mode.
Widget groups allow you to manage multiple widgets by grouping them together. Widget groups can be collapsed or expanded to hide and show multiple widgets, and the height and width of the widget group automatically adjusts to the size of the widgets within the group.
Add/Edit a Widget and Widget Group
Widgets and widget groups can be added in both view mode and edit modes. However, to modify widgets and widget groups, you must switch to the edit mode.
Add a Widget
Add widget gives you the freedom to create your own chart widget with the metrics and filters you want. The widget name, graph type, service, and Metrics settings > Metrics are required values and must be filled in. A single widget can only represent a single service. However, you can select multiple metric items.
Each time you select a metric item, elements are added at the bottom of the screen that allow you to set filters and a legend for the metric item.
You can only label one metric filter per type, and all filters are finally applied in the form of an & operation. Therefore, when applying multiple filters, the search results for a condition value will only show search results that meet all of the previously set filter criteria. Depending on the operator and condition values of the filters you added earlier, there may be no more condition values to choose from.
The legend is a name to distinguish the metric data viewed by each metric item. When you add a metric item, it automatically populates a suggested name by default.You can add any text before or after the placeholder wrapped in double curly braces syntax {{ }}. If you don't enter any text, it will concatenate and expose any label properties the indicator item has.
Select Units to specify the y-axis title and units to be exposed in the chart. The actual value of the metric item is exposed to 15 decimal places (rounded to the 16th place, except when Percent (0.0-1.0) is selected, in which case the value is converted to 0-100 and exposed), without support for separate formatting based on units. The Y-axis position setting allows you to choose between Auto, Left, and Right for the Y-axis position of the metric item. When adding a metric item, the Auto value is selected by default. If all metric items are selected Auto, they will be sequentially positioned on the Y-axis as either Left or Right. If a metric exists with a left or right y-axis position, it will be placed in the same y-axis direction. If any metric items have the same unit and y-axis position, they are represented on the same y-axis.
After you change the graph type or modify the metric item filters, you can preview how the chart widget will look with your changes. Click the Preview toggle in the top-right corner of the screen to open or close the preview layer, where you can see the chart widget in real time with your filters and legend values applied. The preview layer is adjustable for left and right width.
Add a Widget Template
Widget templates are a quick and easy way to create widgets using pre-configured widget metric items. After adding the widget, you can edit the widget to add filters to the metric items or change the metric items and names. Note that some widgets added through widget templates can only be deleted and not edited.
Add a Widget Group
You can add a group of widgets to your dashboard through Add widget group. To add a widget to a widget group, simply drag the title area at the top of the widget in edit mode and move it inside the widget group.
Widget groups can be edited just like widgets, and to edit a widget group, you need to enter edit mode.
- Click Edit to expand the Edit Widget Group modal.
- Click Delete Group to remove only the group, leaving the widget's location and size information intact.
- Click Delete Groups and Child Widgets to delete all widgets within the group.
Move/Clone/Delete a Widget
Once you're in edit mode, you can resize the widget by dragging the bottom right corner, or reposition it by dragging the top area of the widget.
- You can delete the widget by clicking Delete.
- You can duplicate a widget in a dashboard by clicking Clone Widget to Other Dashboard. The cloned widget is added at the bottom.
- You can clone a widget on another dashboard by clicking Clone Widget to Other Dashboard. This opens a modal where you can select the dashboard to which you want to add the widget.
Create a Notification
Clicking Create Notification takes you to the Manage Notifications > Create Notification. You can easily create an notification with the widget's information filled in, including the widget name, service, metric item, and metric item filter information. You can easily create a notification entering only the notification condition and the recipient of the notification.
Manage a Dashboard
Click Manage Dashboards to display the Manage dashboards modal. You can view or edit the dashboard's name, description, creation date, and whether the project dashboard is visible or not.
You can click the Edit or Delete icon in each dashboard's Edit column to edit the name and description of that dashboard or delete the dashboard. You can click theProject Dashboard Visibility Settings toggle to set the visibility of that dashboard on the Project custom dashboards screen. Even if you turn off the visibility setting, it is always visible in the Cloud Monitoring service.
Download Widget Data
You can download all the widget data for a dashboard as a .png, .csv, or .xlsx file. The files are saved with the dashboard name, and in the case of .csv files, they are downloaded as a .zip file compressed with the dashboard name. Inside it contains individual .csv files with the name of each widget. For .csv and .xlsx files, you can only download up to 3 months of data based on the start date. If the view period is less than one month, data is provided in 5-minute intervals, and if it is more than one month, data is provided in 1-day intervals. The longer the view period you specify or the more metric data the widget and the widget contains, the longer the download might take.
Manage Notifications
In Monitoring > Cloud Monitoring > Notification Settings, you can add notifications to your NHN Cloud resources and check the history of notification occurrences.
Notification Settings
The Notification settings screen exposes a table where you can view information about the notifications you've created, and you can sort the table by notification name, whether the notification is enabled, and when it was created. - You can enable or disable notifications by clicking the Enable Notifications toggle. - Click View in the View Notification Details column to display the Notification Details modal. - Click Edit in the Edit column to go to the Edit Notification screen. - Clicking on each row of notifications takes you to the Notification Occurred History tab, where the notifications are automatically looked up and exposed.
Create/Edit Notifications
The name of the notification's basic information, the service and metric items in the service and notification settings, the notification conditions, and the recipients of the notification are required values and must be entered. You can only select a single service for the notification, but you can select multiple metric items.
You don't need to enter a filter for the metric entry, but you must enter at least one condition. Set the conditions you want to be notified on with a combination of comparison method, threshold, and duration.
You must select at least one notification recipient. Only notification recipient types are supported for notification recipient groups, which can be managed on the Project Management > Notification Receiver Group Management screen. [Go to User Guide]
You can receive notifications as webhooks through custom webhooks in the Notification Receiver Group.
- List of parameters to provide as custom webhook request data
| Value | Description | Type | Remarks |
|---|---|---|---|
| orgName | Organization name | String | |
| projectName | Project name | String | |
| tenantType | Service type | String | organization(custom dashboard)project(Cloud Monitoring) |
| referenceKey | Organization or project ID | String | |
| serviceName | Service name | String | |
| alertName | Notification name | String | |
| alertId | Notification ID | String | |
| eventsCount | Number of events occurring | Integer | |
| events | Notification event | List<Object> | See the events parameter list |
- events parameter list
| Value | Description | Type | Remarks |
|---|---|---|---|
| events[].resourceTypeName | Resource type name (En) | String | |
| events[].enMetricName | Metric name (En) | String | |
| events[].threshold | Threshold | String | String as Double |
| events[].operator | Comparison Method | String | Enum(EQUAL, NOT_EQUAL, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL) |
| events[].duration | Duration | String | The value set in the condition |
| events[].result | Detected value | String | String as Double |
| events[].startAt | Event Occurred at | String | ex) 2024-10-29T08:44:22Z |
| events[].endAt | Event Ended at | String | ex) 2024-10-29T08:44:22Z |
| events[].contMinutes | Event duration (minutes) | Integer | The difference between the time the event occurred and the current time (minutes) |
| events[].labels | Where event occurred | Map<String, String> |
View Notification Details Modal
The notification details modal lets you view the details of the notifications you've set up. You can see the name of the notification, description, service, metric item filters and notification conditions, and who will receive the notification.
Notification History
You can use search filters and tables to view the history of notifications that have occurred, and tables to view the information of notifications that have occurred. You can check the notification name, occurrence date, end date, service, resource, metric item, result value, and duration. You can change the table sort by occurrence date and end date.
Notes: Duration refers to the time from when the notification occurs to when the notification ends. If you disable a notification before it ends while it is still occurring, the duration can continue to increase because the notification was not explicitly ended.
View the history of notification occurrences
You can use the notification name, notification status, Metric item, and Occurrence time filters to view the history of notification occurrences. Click Initialize to initialize the search filters.
View Notification Send History Modal
For each notification, click View in the View Notification Send History column to open the View Notification Send History modal.
In the history modal, you can view detailed information on notification settings such as Occurred Date, Duration, Metric Item, Result, Notification Conditions and Occurred Location.
The actual history of sending notifications is also provided in a table. You can see the notification sending date, notification method, recipient, and notification result for each notification sending history. You can change the table sorting by notification date, notification method, and notification time.
Manage Metrics
In Monitoring > Cloud Monitoring > Manage Metrics, you can set whether to collect service-specific metrics for NHN Cloud resources.
Set up Metric Collection
A table exposes where you can set up metric collection by service. For each service, you can see the category, service, whether the service is enabled, and metric collection settings, and you can click the Metric Collection Settings toggle to set whether metrics are collected.
When you start/stop collecting metrics, a confirmation modal opens.
If you stop collecting metrics, the metrics are no longer exposed in widgets that you've created using metrics from that service, and the metrics' legends are disabled.
Example Screen
