Managing Dashboards and Widgets
You can create and manage dashboards to monitor resources of services in use on the Samsung Cloud Platform Console.
Creating a Dashboard
You can create dashboards in ServiceWatch.
Creating a Dashboard by Adding Individual Widgets
Follow these steps to create a dashboard.
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 a name for the dashboard.
- The dashboard name must be 3 to 40 characters long, using English letters, numbers, and special characters (
-_). - You cannot enter a name that is already in use in the service dashboard.
- The dashboard name must be 3 to 40 characters long, using English letters, numbers, and special characters (
Add widgets to configure the dashboard. Depending on the widget addition method, a corresponding popup window will open.
- Add Individual Widget: You can add a single widget combining metrics and resources. When you click the button, the Add Individual Widget popup window will open.
Division RequiredDetailed Description Metric Division Optional Filter the metrics that can be monitored in ServiceWatch by All or Key Metrics and display them in the metric list Metric List Area Required List of metrics that can be monitored in ServiceWatch - Click the + button in front of the namespace and dimensions to view the lower-level list
- When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
Search Filter Area - Set the search items to filter, then click the Apply Filter button to filter the metric list - Namespace-Dimension Name: Search based on the sub-dimension name of the selected namespace
- Metric Name: Search by entering the exact metric name
- Resource Name: Search by entering the exact resource name
- Resource ID: Search by entering the exact resource ID
- Keyword: Search based on the selected upper category and entered keyword
- Search for each item excluding metric name, resource name, resource ID, and Tag-Key
- Tag Key: Search with the selected tag key
Selected Metrics Area - Monitoring chart for the metric selected in the metric list area - Data graph collected during the period applied to the chart
- When you place the mouse cursor on the graph, the time, data value, and metric data information at that point are displayed in a popup
- You can zoom in on a specific area of the graph by dragging the mouse
- When you click the resource name displayed in the legend, detailed information about that resource is displayed in a popup
- You can modify item values in the table area within the chart
- Label: Enter the legend name using English letters, numbers, and special characters within 3 to 255 characters
- Statistics: Select the method to aggregate metric data
- You can select from Average (default), Minimum, Maximum, Sum
- Aggregation Period: Select the aggregation period unit of metric values
- You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours
- Delete: Delete that legend
Table. Add Individual Widget Items
- Add Individual Widget: You can add a single widget combining metrics and resources. When you click the button, the Add Individual Widget popup window will open.
Click the Done button in the widget addition popup window. The widget is added to the dashboard on the dashboard creation page.
After confirming the added widget, click the Create button. A popup window will open announcing the dashboard creation.
Click the Confirm button. The dashboard creation is complete.
Creating a Dashboard by Adding Multiple Widgets
Follow these steps to create a dashboard.
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 a name for the dashboard.
- The dashboard name must be 3 to 40 characters long, using English letters, numbers, and special characters (
-_). - You cannot enter a name that is already in use in the service dashboard.
- The dashboard name must be 3 to 40 characters long, using English letters, numbers, and special characters (
Add widgets to configure the dashboard. Depending on the widget addition method, a corresponding popup window will open.
- Add Multiple Widgets: You can select desired resources by metric unit and add multiple widgets at once. When you click the button, the Add Multiple Widgets popup window will open.
Division RequiredDetailed Description Metric Division Optional Filter the metrics that can be monitored in ServiceWatch by All or Key Metrics and display them in the metric list Metric Selection Area Required Select the namespace and resources to add - Click the + button in front of the namespace and resources to view the lower-level resources and metric list
- When you check a metric to add to a widget from the metric list, the Selected Metrics and Selected Resources areas are displayed
- You can select multiple metrics
Selected Metrics Required Display the list of metrics selected from the namespace and resource list - When you click a metric, the list of resources included in that metric is displayed in the Selected Resources area
Selected Resources Required Add resources to the metrics selected in the Selected Metrics list - After clicking the Select button, select resources that can be added to that metric and add up to 5
- You must add resources for all metrics in the Selected Metrics list
Statistics Required Select the statistics criterion for metric values - You can select from Average (default), Minimum, Maximum, Sum
Aggregation Period Required Select the aggregation period unit of metric values - You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours
Table. Add Multiple Widgets Items
- Add Multiple Widgets: You can select desired resources by metric unit and add multiple widgets at once. When you click the button, the Add Multiple Widgets popup window will open.
Click the Done button in the widget addition popup window. The widget is added to the dashboard on the dashboard creation page.
After confirming the added widget, click the Create button. A popup window will open announcing the dashboard creation.
Click the Confirm button. The dashboard creation is complete.
Creating a Dashboard by Importing a Dashboard
Follow these steps to create a dashboard.
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 a name for the dashboard.
- The dashboard name must be 3 to 40 characters long, using English letters, numbers, and special characters (
-_). - You cannot enter a name that is already in use in the service dashboard.
- The dashboard name must be 3 to 40 characters long, using English letters, numbers, and special characters (
Add widgets to configure the dashboard. Depending on the widget addition method, a corresponding popup window will open.
- Import Dashboard: You can import widgets from a dashboard registered in ServiceWatch. When you click the button, the Import Dashboard popup window will open.
Division RequiredDetailed Description Dashboard Required Display the list of dashboards registered in ServiceWatch - When you select a dashboard, the widgets applied to that dashboard are displayed in the Preview area
Preview Required Display the widgets applied to the dashboard selected from the dashboard list - Check the widget name to select the widget to add to the dashboard to create
- When you check the Select All item, all metrics of that dashboard are selected
Table. Import Dashboard Items
- Import Dashboard: You can import widgets from a dashboard registered in ServiceWatch. When you click the button, the Import Dashboard popup window will open.
Click the Done button in the widget addition popup window. The widget is added to the dashboard on the dashboard creation page.
After confirming the added widget, click the Create button. A popup window will open announcing the dashboard creation.
Click the Confirm button. The dashboard creation is complete.
Viewing Dashboards
You can view information about the dashboard selected on the Dashboard List page. Follow these steps to view a dashboard.
- 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.
Division Detailed Description Dashboard Name Dashboard name - User dashboard is the dashboard name set by the user. Service dashboard is the Samsung Cloud Platform service name matching the service namespace
Dashboard Division Dashboard division - User: Dashboard created directly by the user
- Service: Dashboard composed of key metrics for each service automatically pre-built
Modified Date Dashboard modification date Created Date Dashboard creation date Favorites Displayed in yellow if favorites are set - To set or unset favorites, click the star icon
Table. Dashboard List Items - On the Dashboard List page, click the dashboard for which you want to view detailed information. You will be taken to the Dashboard Detail page.
Division Detailed Description Dashboard Name Display the dashboard name - Click the name to select another dashboard
Period Setting Area Select the period to apply to widgets in the dashboard - For metric query, you can set up to 455 days from the current time
Time Zone Setting Area Select the time zone to apply to the period setting Reset Button Reset all manipulations or settings on the dashboard detail screen Refresh Setting Area Select the refresh cycle for widget information - Click the Refresh button to display information based on the current time
- Click the refresh cycle to select the desired cycle: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
Edit Modify the dashboard name or manage widgets - When you click the Edit button, you will be taken to the Edit Dashboard page
- For details on dashboard editing, refer to Editing a Dashboard
More Display additional task items for managing the dashboard - You can clone and delete the dashboard, view detailed information, and view source
- For details on dashboard management items, refer to Managing Dashboards
- For details on widget management items, refer to Managing Widgets
Widget Area Display widgets for monitoring each resource - Click the More button in the upper right corner of the widget to manage the widget
- You can edit and clone the widget, download files, view metrics, and view source
- For details on widget management items, refer to Managing Widgets
Table. Dashboard Detail Items
Managing Dashboards
On the Dashboard Detail page, you can modify or manage dashboard information and widgets.
Editing a Dashboard
You can modify the dashboard name or change the widget configuration.
- 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 for which you want to view detailed information. You will be taken to the Dashboard Detail page.
- Click the Edit button in the upper right corner of the Dashboard Detail page. You will be taken to the Edit Dashboard page.
- After modifying the dashboard information or widgets, click the Save button.
Division Detailed Description Dashboard Name Dashboard name cannot be modified - Enter within 34 characters using English letters, numbers, and special characters (
-_)
- Duplicate dashboard names in use cannot be used
Widget Name Widget name can be modified - Enter within 3 to 255 characters using English letters, numbers, spaces, and special characters (
-_.|)
Widget Management When you place the mouse cursor on a widget, management buttons are displayed on the right side of the widget border - Edit: You can modify the widget’s metrics and resources in the Edit Widget popup window
- For details on widget editing, refer to Edit Individual Widget in Managing Widgets
- Clone: Clone the current widget and add it to the dashboard
- Delete: Delete the current widget from the dashboard
- Expand: Display the current widget in an expanded size
- Shrink: If displayed in expanded size, click again to shrink the widget size
Add Widget Add a new widget to the dashboard - Add Individual Widget: Add a single widget combining metrics and resources
- Add Multiple Widgets: Select desired resources by metric unit and add multiple widgets at once
- Import Dashboard: Import widgets from another dashboard and add them
- For details on widget addition methods, refer to Creating a Widget
Table. Edit Dashboard Items - Enter within 34 characters using English letters, numbers, and special characters (
Viewing Dashboard Detailed Information
You can view detailed information about a dashboard. Follow these steps to view dashboard detailed information.
- 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 for which you want to view detailed information. You will be taken to the Dashboard Detail page.
- Click the More > Detailed Information button in the upper right corner of the Dashboard Detail page. The Dashboard Detailed Information popup window will open.
Division Detailed Description Dashboard Name Dashboard name Dashboard Division Usage division of the dashboard - User: Dashboard created directly by the user
- Service: Dashboard composed of key metrics for each service automatically pre-built
Service Service name Resource Type dashboard SRN Unique resource ID in Samsung Cloud Platform - In ServiceWatch, it means the SRN of the dashboard
Resource Name Resource name - In ServiceWatch, it means the dashboard name
Resource ID Unique resource ID in the service Creator User who created the dashboard Created Date Date and time when the dashboard was created Modifier User who modified the dashboard information Modified Date Date and time when the dashboard information was modified Table. Dashboard Detail - Detailed 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
Viewing Dashboard Source Code
You can view the dashboard source code. Follow these steps to view dashboard source code.
- 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 for which you want to view detailed information. You will be taken to the Dashboard Detail page.
- Click the More > View Source button in the upper right corner of the Dashboard Detail page. The Dashboard View Source popup window will open.
Division Detailed Description Source Information Display dashboard source code in JSON format Copy Code Copy source code to clipboard Table. Dashboard Detail - Dashboard View Source Popup Items
Cloning a Dashboard
You can clone the widgets of the current dashboard and add them to another dashboard.
User permissions are required to clone a dashboard.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
Follow these steps to clone a dashboard.
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 for which you want to view detailed information. You will be taken to the Dashboard Detail page.
Click the More > Clone button in the upper right corner of the Dashboard Detail page. The Clone Dashboard popup window will open.
Select a dashboard cloning method and enter the required information. The required information varies depending on the cloning method.
Division RequiredDetailed Description Clone Target - Dashboard name to clone Clone Method Required After cloning the dashboard widgets, select the dashboard to add to - New Dashboard: Create a new dashboard and create by cloning the widgets of the current dashboard
- Existing Dashboard: Clone the widgets of the current dashboard and add them to an existing dashboard
Dashboard Name Required Enter the name of the dashboard to create - Displayed when clone method is selected as New Dashboard
- Enter within 3 to 40 characters using English letters, numbers, and special characters (
-_)
Dashboard Selection Required Select a dashboard to add the cloned widgets from among previously created dashboards - Displayed when clone method is selected as Existing Dashboard
Table. Clone Dashboard ItemsAfter entering the required information, click the Done button. A popup window will open announcing the dashboard cloning.
Click the Confirm button in the popup window. The dashboard cloning is complete.
Deleting a Dashboard
You can delete dashboards that are not in use.
- 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 to delete and click the Delete button. A popup window will open announcing the dashboard deletion.
- You can delete multiple dashboards at the same time.
- You can also delete individually by clicking the More > Delete button in the upper right corner of the Dashboard Detail page.
- After entering Delete in the delete confirmation input area, click the Confirm button. The dashboard is deleted.
Managing Widgets
On the Dashboard Detail page, you can modify or manage widgets.
Editing a Widget
You can modify the metrics and resources of a widget.
- 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 for which you want to edit widgets. You will be taken to the Dashboard Detail page.
- Click the More > Edit Widget button in the upper right corner of the widget to edit on the Dashboard Detail page. The Edit Widget popup window will open.
- After modifying the widget’s metrics and resources, click the Confirm button. The widget editing is complete.
Division RequiredDetailed Description Metric Division Optional Filter the metrics that can be monitored in ServiceWatch by All or Key Metrics and display them in the metric list Metric List Area Required List of metrics that can be monitored in ServiceWatch - Click the + button in front of the namespace and dimensions to view the lower-level list
- When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
Search Filter Area - Set the search items to filter, then click the Apply Filter button to filter the metric list - Namespace-Dimension Name: Search based on the sub-dimension name of the selected namespace
- Metric Name: Search by entering the exact metric name
- Resource Name: Search by entering the exact resource name
- Resource ID: Search by entering the exact resource ID
- Keyword: Search based on the selected upper category and entered keyword
- Search for each item excluding metric name, resource name, resource ID, and Tag-Key
- Tag Key: Search with the selected tag key
Selected Metrics Area - Monitoring chart for the metric selected in the metric list area - Data graph collected during the period applied to the chart
- When you place the mouse cursor on the graph, the time, data value, and metric data information at that point are displayed in a popup
- You can zoom in on a specific area of the graph by dragging the mouse
- When you click the label name displayed in the legend, detailed information about that legend is displayed in a popup
- In the table area within the chart, you can check and modify labels, statistics, and aggregation period by legend
- Legend: Color by legend
- Click the legend color to change to a different color
- Period: Period applied to the chart
- Metric: Display the namespace, resource name, and metric name of the selected metric
- Statistics: Select the method to aggregate metric data
- You can select from Average (default), Minimum, Maximum, Sum
- Aggregation Period: Select the aggregation period unit of metric values
- You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
- Delete: Delete that legend
- Legend: Color by legend
Table. Add Individual Widget Items
Cloning a Widget
You can copy a widget and add it to another dashboard.
User permissions are required to clone a dashboard.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
Follow these steps to clone a widget.
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 to clone. You will be taken to the Dashboard Detail page.
Click the More > Clone Widget button in the upper right corner of the widget to clone on the Dashboard Detail page. The Clone Widget popup window will open.
Select a widget cloning method and enter the required information. The required information varies depending on the cloning method.
Division RequiredDetailed Description Clone Target - Dashboard name to clone Clone Method Required After cloning the widget, select the dashboard to add to - Existing Dashboard: Add the widget to an existing dashboard
- New Dashboard: Create a new dashboard and add the widget
Dashboard Selection Required Select a dashboard to add the cloned widget from among previously created dashboards - Displayed when clone method is selected as Existing Dashboard
Dashboard Name Required Enter the name of the dashboard to create - Displayed when clone method is selected as New Dashboard
- Enter within 3 to 40 characters using English letters, numbers, and special characters (
-_)
Widget Name Required Enter the widget name when adding the widget to the dashboard - Enter within 3 to 255 characters using English letters, numbers, and special characters (
-_.|)
Table. Clone Widget ItemsAfter entering the required information, click the Done button. A popup window will open announcing the widget addition.
Click the Confirm button in the popup window. The widget is cloned and added to the dashboard.
Downloading Widget Files
You can download widget information as a file. Follow these steps to download widget information.
- 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 for which you want to download widget information. You will be taken to the Dashboard Detail page.
- Click the More > File Download button in the upper right corner of the widget for which you want to download widget information on the Dashboard Detail page. The File Download popup window will open.
- Select a file download method and click the Confirm button. The download will start.
- You can select multiple download methods at the same time.
Division Detailed Description CSV Convert the widget’s metrics and monitoring data to Excel (*.csv) file format and download PNG Convert the widget chart to image (*.png) file format and download Table. Widget File Download Items
- You can select multiple download methods at the same time.
Viewing Widget Metrics
You can view the resource and metric information of a widget on the Metrics page. Follow these steps to view widget metrics on the metrics page.
- 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 for which you want to view widget metrics. You will be taken to the Dashboard Detail page.
- Click the More > View Metrics button in the upper right corner of the widget to view on the Metrics page on the Dashboard Detail page. You will be taken to the Metrics page.
- The resource and metric information of the selected widget are automatically set and displayed on the Metrics page.
Viewing Widget Source Code
You can view the dashboard source code.
- 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 for which you want to view detailed information. You will be taken to the Dashboard Detail page.
- Click the More > View Source button in the upper right corner of the widget for which you want to view source code on the Dashboard Detail page. The Widget View Source popup window will open.
Division Detailed Description Source Information Display widget source code in JSON format Copy Code Copy source code to clipboard Table. Widget View Source Items
Downloading Widget Files
You can download widget information as a file. Follow these steps to download widget information.
- 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 for which you want to download widget information. You will be taken to the Dashboard Detail page.
- Click the More > File Download button in the upper right corner of the widget for which you want to download widget information on the Dashboard Detail page. The File Download popup window will open.
- Select a file download method and click the Confirm button. The download will start.
- You can select multiple download methods at the same time.
Division Detailed Description CSV Convert the widget’s metrics and monitoring data to Excel (*.csv) file format and download PNG Convert the widget chart to image (*.png) file format and download Table. Widget File Download Items
- You can select multiple download methods at the same time.
Exporting to Object Storage
You can save widget information to Object Storage.
User permissions are required to save to Object Storage.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
Follow these steps to save widget information to Object Storage.
- 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 for which you want to download widget information. You will be taken to the Dashboard Detail page.
- Click the More > Export to Object Storage button in the upper right corner of the widget for which you want to download widget information on the Dashboard Detail page. The Export to Object Storage popup window will open.
- Select the bucket to save the widget information and click the Done button. A popup window will open announcing the save.
- Click the Confirm button in the popup window. The data export will start.
- The limitations for metrics that can be exported to Object Storage are as follows.
- Number of metrics: 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 saved.
- If there is no Object Storage to save metric data, create Object Storage and proceed.
- Metric data is saved in the file format “metric name-yyyymmddhhmmss.json” and can be viewed in the ~/servicewatch/metric path of the Object Storage bucket.