Managing Dashboards and Widgets
In the Samsung Cloud Platform Console, you can create and manage dashboards to monitor the resources of the services you are using.
Create Dashboard
You can create a ServiceWatch dashboard.
Creating a dashboard by adding individual widgets
To create a dashboard, follow these steps.
All Services > Management > ServiceWatch menu, click it. You will be taken to the Service Home page.
Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
On the Dashboard List page, click the Create Dashboard button.
Please enter the dashboard name.
- Enter the dashboard name using English letters, numbers, and special characters (
-_) within 3 ~ 40 characters. - You cannot enter a name that is already in use on the service dashboard.
- Enter the dashboard name using English letters, numbers, and special characters (
Add a widget to configure the dashboard. A popup window appropriate to the widget addition method will open.
- Add Individual Widget: You can add a single widget that combines metrics and resources. Clicking the button opens the Add Individual Widget popup.
Category Required statusDetailed description Indicator classification Selection In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list Indicator List Area Required List of metrics that can be monitored in ServiceWatch - Click the + button in front of the namespace and dimension to view the sub-level list
- When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
Search filter area - After setting the search items to filter, click the Apply Filter button to filter the metric list - Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace
- Metric Name: Enter the exact metric name to search
- Resource Name: Enter the exact resource name to search
- Resource ID: Enter the exact resource ID to search
- Keyword: Search based on the selected top-level category and the entered keyword
- Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key
- Tag Key: Search using the selected tag key
Selected metric area - Monitoring chart for the selected metric in the metric list area - Data graph collected during the period applied to the chart
- When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point
- You can drag the mouse to zoom in on a specific area of the graph
- Clicking the resource name shown in the legend displays detailed information about that resource in a popup
- Item values in the table area within the chart can be edited
- Label: Enter the legend name using English letters, numbers, or special characters, between 3 ~ 255 characters
- Statistics: Choose the method for aggregating metric data
- Options: average (default), minimum, maximum, sum
- Aggregation period: Select the aggregation period unit for metric values
- Options: 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours
- Delete: Remove the legend
Table. Individual widget additional items
- Add Individual Widget: You can add a single widget that combines metrics and resources. Clicking the button opens the Add Individual Widget popup.
Click the Complete button in the widget addition popup. The widget will be added to the dashboard on the dashboard creation page.
After confirming the added widget, click the Create button. A popup indicating dashboard creation will appear.
Click the Confirm button. Dashboard creation is complete.
Creating a dashboard by adding multiple widgets
To create a dashboard, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
On the Dashboard List page, click the Create Dashboard button.
Enter the name of the dashboard.
- Enter the dashboard name using English letters, numbers, and special characters (
-_) within 3 ~ 40 characters. - You cannot enter a name that is already in use on the service dashboard.
- Enter the dashboard name using English letters, numbers, and special characters (
Add a widget to configure the dashboard. A corresponding popup window will open according to the widget addition method.
- Add Multiple Widgets: Select the desired resources by metric unit and add multiple widgets at once. Clicking the button opens the Add Multiple Widgets popup window.
Category Required or notDetailed description Indicator classification Select In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list Indicator selection area Required Select the namespace and resources to add - Click the + button in front of the namespace and resources to view the list of sub-resources and metrics
- When you check the metrics to add to the widget from the metric list, the Selected Metrics and Selected Resources sections are displayed
- Multiple metrics can be selected
Selection indicator Required Display the list of selected metrics from the namespace and resource list - When a metric is clicked, the Selected Resources area shows the list of resources included in that metric
Selected resource Required Selected Indicator list, add resources to the selected indicator - After clicking the Select button, choose resources that can be added to the indicator, allowing up to five additions
- Resources must be added for all indicators in the Selected Indicator list
Statistics Required Select the statistical basis for the indicator value - You can choose from average (default), minimum, maximum, or sum
Aggregation period Required Select the aggregation period unit for metric values - Choose from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, or 12 hours
Table: Additional items for multiple widgets
- Add Multiple Widgets: Select the desired resources by metric unit and add multiple widgets at once. Clicking the button opens the Add Multiple Widgets popup window.
Click the Complete button on the widget addition popup. The widget will be added to the dashboard on the dashboard creation page.
After confirming the added widget, click the Create button. A popup indicating dashboard creation will appear.
Click the Confirm button. The dashboard has been created.
Create a dashboard by loading a dashboard
To create a dashboard, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
On the Dashboard List page, click the Create Dashboard button.
Enter the name of the dashboard.
- Enter the dashboard name using English letters, numbers, and special characters (
-_) within 3 ~ 40 characters. - You cannot enter a name that is already in use on the service dashboard.
- Enter the dashboard name using English letters, numbers, and special characters (
Add a widget to configure the dashboard. A corresponding popup window will open according to the widget addition method.
- Dashboard Load: You can load widgets from dashboards registered in ServiceWatch. When you click the button, the Dashboard Load popup opens.
Category RequiredDetailed description Dashboard Required Display the list of dashboards registered in ServiceWatch - When a dashboard is selected, the widgets applied to the dashboard are displayed in the preview area
Preview Required Display widgets applied to the selected dashboard from the dashboard list - Check the widget name to select widgets to add to the dashboard to be created
- If you check the Select All item, all metrics of that dashboard are selected
Table. Load Dashboard Items
- Dashboard Load: You can load widgets from dashboards registered in ServiceWatch. When you click the button, the Dashboard Load popup opens.
Click the Complete button in the widget addition popup. The widget will be added to the dashboard on the dashboard creation page.
After confirming the added widget, click the Create button. A popup indicating dashboard creation will open.
Click the Confirm button. Dashboard creation is complete.
Check the dashboard
You can view the information of the selected dashboard on the Dashboard List page. To view the dashboard, follow the steps below.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
Category Detailed description Dashboard name Dashboard name - User dashboards are the dashboard names set by the user. Service dashboards are the Samsung Cloud Platform service name that matches the service namespace
Dashboard Category Dashboard classification - User: Dashboard created directly by the user
- Service: Dashboard automatically composed of pre-built key metrics for each service
Modification date and time Dashboard modification timestamp Creation date and time Dashboard creation date and time Favorites If bookmarked, it is displayed in yellow - Click the star icon to set or remove a bookmark
Table. Dashboard list items - On the Dashboard List page, click the dashboard whose details you want to view. You will be taken to the Dashboard Detail page.
Category Detailed description Dashboard name Display the dashboard name - Click the name to select another dashboard
Period setting area Period selection applied to widgets in the dashboard - Metric queries can be set from now up to a maximum of 455 days
Time zone setting area Select the time zone applied to the period setting Reset button Reset all actions and settings made on the dashboard detail screen Refresh Settings Area Select refresh interval for widget information - Refresh button updates the information based on the current time
- Click the refresh interval to choose the desired period: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
Edit You can edit the dashboard name or manage widgets - When you click the Edit button, you are taken to the Dashboard Edit page
- For more details on editing the dashboard, see 대시보드 수정하기
More Display additional tasks for managing the dashboard - Dashboard duplication and deletion, view details, view source are possible
- For details on dashboard management items, refer to Dashboard Management
- For details on widget management items, refer to Widget Management
Widget area Display widgets for monitoring each resource - You can manage the widget by clicking the More button at the top right of the widget
- You can edit, duplicate, download files, view metrics, and view source of the widget
- For detailed information on widget management items, see Widget Management
Table. Dashboard detailed items
Dashboard Management
Dashboard Details page allows you to edit or manage dashboard information and widgets.
Edit Dashboard
You can modify the dashboard name and change the widget configuration.
To modify the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
- Click the Edit button at the top right of the Dashboard Details page. You will be taken to the Dashboard Edit page.
- After modifying the dashboard’s information or widgets, click the Save button.
Category Detailed description Dashboard name Dashboard name cannot be edited - Enter within 34 characters using English letters, numbers, and special characters (
-_)
- Dashboard names that are currently in use cannot be used
Widget Name Widget name can be edited - English letters, numbers, spaces, special characters(
-_.\
Widget Management When you hover the mouse over a widget, a management button appears on the right side of the widget border - Edit: Widget Edit popup allows you to modify the widget’s metrics and resources
- For details on widget editing, see the Individual Widget Edit in 위젯 관리하기
- Duplicate: Duplicate the current widget and add it to the dashboard
- Delete: Remove the current widget from the dashboard
- Expand: Display the current widget with an expanded size
- Collapse: If the widget is expanded, clicking again reduces its size
Add widget Add a new widget to the dashboard - Add individual widget: Add a single widget that combines metrics and resources
- Add multiple widgets: Select desired resources per metric to add multiple widgets at once
- Load dashboard: Load and add widgets from another dashboard
- For detailed instructions on adding widgets, see Creating Widgets
Table. Dashboard edit items - Enter within 34 characters using English letters, numbers, and special characters (
View detailed dashboard information
You can view detailed information about the dashboard. To view detailed information of the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
- Dashboard Details page’s top right corner has a More > Details button. Click the button. The Dashboard Details popup opens.
Category Detailed description Dashboard name Dashboard name Dashboard Category Dashboard usage classification - User: dashboard created directly by the user
- Service: dashboard composed of automatically pre-built key metrics for each service
Service service name Resource Type dashboard SRN Unique resource ID in Samsung Cloud Platform - In ServiceWatch, it refers to the dashboard’s SRN
Resource name Resource Name - In ServiceWatch, the meaning of the dashboard name
Resource ID Unique resource ID in the service Constructor User who created the dashboard Creation date and time Dashboard creation date and time Editor User who edited the dashboard information Modification date and time Dashboard information modification timestamp Table. Dashboard Details - Detail Information Popup Items
When sorting dashboard names in the dashboard list, follow the sorting rules below.
- Whitespace and control characters
- Some special characters (
!"#$%&’()*+,-./) - Numbers (
0–9) - Some special characters (
;<=>?@) - English (
A–Z,a–z, case-insensitive) - Remaining special characters (
[\]^_`) - Other characters
Check the dashboard source code
You can view the dashboard’s source code. To view the source code of the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
- Dashboard Details on the top right of the page, click the More > View Source button. The Dashboard View Source popup opens.
Category Detailed description Source information Display the dashboard source code in JSON format Copy code Copy the source code to the clipboard Table. Dashboard Details - Dashboard Source View Popup Items
Duplicate Dashboard
You can duplicate a widget from the current dashboard and add it to another dashboard.
User permission is required to duplicate the dashboard.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
To duplicate the dashboard, follow these steps.
All Services > Management > ServiceWatch menu, click it. You will be taken to the Service Home page.
On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
Click the More > Duplicate button at the top right of the Dashboard Details page. The Dashboard Duplicate popup opens.
After selecting the dashboard duplication method, enter the required information. The required information varies depending on the duplication method.
Category RequiredDetailed description Replication target - Name of the dashboard to duplicate Cloning method Required After duplicating the dashboard widget, select the dashboard to add it to - New Dashboard: Create a new dashboard and generate it by duplicating the current dashboard’s widget
- Existing Dashboard: Duplicate the current dashboard’s widget and add it to an existing dashboard
Dashboard name Required Enter the name of the new dashboard - Displayed when the duplication method is set to New Dashboard
- Enter using English letters, numbers, and special characters (
-_) within 3 to 40 characters
Select Dashboard Required Select the dashboard to which the duplicated widget will be added from the existing dashboards - Displayed when the duplication method is selected as Existing dashboard
Table. Dashboard clone itemsAfter entering the required information, click the Complete button. A popup notifying that the dashboard is being duplicated will appear.
Click the Confirm button on the popup window. The dashboard duplication task is complete.
Delete dashboard
You can delete unused dashboards.
To delete the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, select the checkbox of the dashboard you want to delete, then click the Delete button. A popup confirming the dashboard deletion will appear.
- You can delete multiple dashboards simultaneously.
- You can also delete individually by clicking the More > Delete button located at the top right of the Dashboard Details page.
- In the delete confirmation input field, type Delete and then click the Confirm button. The dashboard will be deleted.
Manage Widgets
Dashboard Details page lets you edit or manage widgets.
Edit Widget
You can modify the widget’s metrics and resources.
To modify the widget, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard whose widget you want to edit. You will be taken to the Dashboard Details page.
- On the Dashboard Details page, click the More > Edit Widget button at the top right of the widget you want to edit. The Edit Widget popup will open.
- After modifying the widget’s metrics and resources, click the Confirm button. The widget modification is complete.
Category Required statusDetailed description Indicator classification Select In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list Indicator List Area Required List of metrics that can be monitored in ServiceWatch - Click the + button in front of the namespace and dimension to view the sub-level list
- When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
Search filter area - After setting the search items to filter, click the Apply Filter button to filter the metric list - Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace
- Metric Name: Enter the exact metric name to search
- Resource Name: Enter the exact resource name to search
- Resource ID: Enter the exact resource ID to search
- Keyword: Search based on the selected top-level category and the entered keyword
- Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key
- Tag Key: Search using the selected tag key
Selected metric area - Monitoring chart for the selected metric in the metric list area - Data graph collected during the period applied to the chart
- When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point
- You can drag the mouse to zoom in on a specific area of the graph
- Clicking the label name displayed in the legend shows detailed information for that legend in a popup
- In the table area within the chart, you can view and edit legend labels, statistics, and aggregation periods
- Legend: color per legend
- Click a legend color to change it to another color
- Period: period applied to the chart
- Metric: displays the selected metric’s namespace, resource name, and metric name
- Statistics: select the method for aggregating metric data
- Choose among Average (default), Minimum, Maximum, Sum
- Aggregation period: select the aggregation period unit for metric values
- Choose among 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
- Delete: remove the legend
- Legend: color per legend
Table. Individual widget additional items
Widget Replication
You can copy the widget and add it to another dashboard.
User permission is required to duplicate the dashboard.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
To duplicate a widget, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
On the Dashboard List page, click the dashboard you want to duplicate. You will be taken to the Dashboard Details page.
On the Dashboard Detail page, click the More > Widget Clone button located at the upper right of the widget to be duplicated. The Widget Clone popup window opens.
After selecting the widget duplication method, enter the required information. The required information varies depending on the duplication method.
Category Whether requiredDetailed description Replication target - Name of the dashboard to duplicate Cloning method Required After duplicating the widget, select the dashboard to add it to - Existing Dashboard: Add the widget to an existing dashboard
- New Dashboard: Create a new dashboard and add the widget
Select Dashboard Required Select the dashboard to which the duplicated widget will be added from the existing dashboards - When the duplication method is selected as Existing Dashboard, it is displayed
Dashboard name Required Enter the name of the new dashboard - Displayed when the duplication method is set to New Dashboard
- Enter using English letters, numbers, and special characters (
-_) within 3 to 40 characters
Widget name Required When adding a widget to the dashboard, enter the widget name - English letters, numbers, special characters(
-_.\
Table. Widget duplication itemsAfter entering the required information, click the Complete button. A popup window notifying the addition of the widget will open.
Click the Confirm button in the popup window. The widget will be duplicated and added to the dashboard.
Download widget file
You can download widget information as a file. To download widget information, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard from which you want to download widget information. You will be taken to the Dashboard Detail page.
- Dashboard Details page, click the More > File Download button at the top right of the widget whose information you want to download. The File Download popup window opens.
- After selecting the file download method, click the Confirm button. The download will start.
- Download methods can be selected simultaneously.
Category Detailed description CSV Convert the widget’s metrics and monitoring data to an Excel (*.csv) file and download it. PNG Convert the widget chart to an image (*.png) file and download Table. Widget file download item
- Download methods can be selected simultaneously.
Check widget metrics
You can view the widget’s resource and metric information on the Metrics page. To view widget metrics on the metrics page, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view widget metrics for. You will be taken to the Dashboard Details page.
- On the Dashboard Detail page, click the More > View Metrics button at the top right of the widget you will view on the Metrics page. You will be taken to the Metrics page.
- The resources and metric information of the selected widget are automatically configured and displayed on the Metrics page.
Check widget source code
You can view the source code of the dashboard.
To check the dashboard’s source code, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Detail page.
- On the Dashboard Details page, click the More > View Source button located at the top right of the widget to view its source code. The Widget Source View popup will open.
Category Detailed description Source information Display the widget source code in JSON format Copy code Copy the source code to the clipboard Table. Widget source view item
Download widget file
You can download widget information as a file. To download widget information, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- Dashboard List page, click the dashboard to download widget information. You will be taken to the Dashboard Detail page.
- Dashboard Details page, click the More > File Download button at the top right of the widget whose information you want to download. The File Download popup window opens.
- After selecting the file download method, click the Confirm button. The download will start.
- Download methods can be selected simultaneously.
Category Detailed description CSV Convert the widget’s metrics and monitoring data to an Excel (*.csv) file and download it. PNG Convert the widget chart to an image (*.png) file and download Table. Widget file download item
- Download methods can be selected simultaneously.
Export to Object Storage
You can store widget information in Object Storage.
User permissions are required to store data in Object Storage.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
To store widget information in Object Storage, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard from which you want to download widget information. You will be taken to the Dashboard Detail page.
- On the Dashboard Details page, click the More > Export to Object Storage button located at the top right of the widget whose information you want to download. The Export to Object Storage popup will open.
- After selecting the bucket to store widget information, click the Done button. A popup confirming the save will appear.
- Click the Confirm button in the popup window. Data export will begin.
- The limitations of metrics that can be exported to Object Storage are as follows.
- Number of indicators: up to 10
- Query period: within 2 months (63 days)
- If the query period exceeds 2 months (63 days), only data for up to 63 days will be stored.
- If there is no Object Storage to store metric data, create an Object Storage first, then proceed.
- Metric data is stored in the “metricname-yyyymmddhhmmss.json” file format and can be accessed in the ~/servicewatch/metric path of the Object Storage bucket.