The page has been translated by Gen AI.

Managing Dashboard and Widgets

You can create and manage a dashboard to monitor the resources of the services being used in the Samsung Cloud Platform Console.

Creating a dashboard

You can create a dashboard of ServiceWatch.

To create a dashboard, follow the next procedure.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
  3. Dashboard List page, click the Create Dashboard button.
  4. Please enter the name of the dashboard.
  • The name of the dashboard should be entered within 34 characters using English, numbers, and special characters (-_).
  1. Add a widget to compose the dashboard. A corresponding popup window opens according to the method of adding a widget.
  • Add individual widgets: You can add a single widget combined with metrics and resources. When you click the button, the Add individual widgets popup window opens.
Classification
Necessity
Detailed Description
metric list arearequiredlist of metrics that can be monitored in ServiceWatch
  • you can check the lower level list by clicking the + button in front of the namespace and dimension
  • if you select a metric to monitor, it will be displayed as a chart in the selected metric area
search filter areaselectionnamespace-dimension name, metric name, resource name, resource ID, tag-key are set, and then filter apply button is clicked to filter the metric list
  • namespace-dimension name: select namespace and dimension name
  • metric name: enter the exact metric name
  • resource name: enter the exact resource name
  • resource ID: enter the exact resource ID
  • tag key: select the tag key
Selected Metric Area-Monitoring Chart for the Selected Metric in the Metric List Area
  • Graph of Data 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 at that point
    • Dragging the mouse allows zooming in on a specific area of the graph
    • Clicking on the resource name displayed in the legend shows detailed information about the resource in a popup
  • Item Values in the Table Area of the Chart can be Modified
    • Label: Enter the legend name using English, numbers, and special characters within 3 to 255 characters
    • Statistics: Select the Method for Aggregating Metric Data
      • Choose from Average (default), Minimum, Maximum, and Sum
    • Aggregation Period: Select the Unit of Time for Aggregating Metric Values
      • Choose from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, and 12 hours
    • Delete: Delete the Corresponding Legend
Table. Individual widget addition items
  • Multiple Widget Addition: You can add multiple widgets at once by selecting the desired resources by metric unit. When you click the button, the Multiple Widget Addition popup window opens.
Classification
Necessity
Detailed Description
Service and Resource ListRequiredSelect resources to add metrics
  • Click the + button in front of the service and resources to check the list of sub-resources and metrics
  • If you check the metrics to be added to the widget in the metric list, the Selected Metrics and Selected Resources areas are displayed
  • Multiple metrics can be selected
selection metricessentialdisplays the list of metrics selected from the service and resource list
  • when you click on an metric, it displays the list of resources included in that metric in the selected resource area
Selected ResourcesRequiredSelected Metrics list, add resources to the selected metrics
  • After clicking the Select button, you can select resources to add to the metrics, up to a maximum of 5
  • Resources must be added for all metrics in the Selected Metrics list
StatisticsRequiredSelect the statistical criteria for the metric value
  • Average (default), minimum, maximum, sum can be selected
Accumulation periodRequiredSelect the unit of accumulation period for the metric value
  • 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours can be selected
Table. Multiple widget addition items
  • Dashboard Import: You can import widgets from the dashboard registered in ServiceWatch. When you click the button, the Dashboard Import popup window opens.
Classification
Necessity
Detailed Description
dashboardrequiredDisplays a list of dashboards registered in ServiceWatch
  • When a dashboard is selected, the widgets applied to the dashboard are displayed in the preview area
PreviewRequiredDisplays widgets applied to the dashboard selected in the dashboard list
  • Select widgets to add to the dashboard to be created by checking the widget name
  • Checking the All Select item selects all metrics of the corresponding dashboard
Table. Dashboard Loading Items
  1. Click the Complete button on the widget add popup window. The widget will be added to the dashboard on the dashboard creation page.
  2. After checking the added widget, click the Complete button. A pop-up window announcing the creation of the dashboard will open.
  3. Confirm button should be clicked. Dashboard creation will be completed.

Check the dashboard

Dashboard List page where you can check the information of the selected dashboard.

To check the dashboard, follow the next procedure.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
  3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
ClassificationDetailed Description
Dashboard NameName of the dashboard display
  • Click the name to select a different dashboard
Period Setting AreaPeriod selection applied to widgets in the dashboard
Time zone setting areaSelect the time zone to which the period setting is applied
Initialization ButtonInitialize all operations or settings made on the dashboard detail screen
Refresh settings areaSelect the refresh cycle of widget information
  • Refresh button to display information based on the current time
  • Refresh cycle can be selected by clicking: off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
EditModify the name of the dashboard or manage widgets
  • Edit button click, move to the Dashboard Edit page
MoreDisplays additional work items for managing the dashboard
  • Dashboard replication and deletion, detailed information confirmation, source view available
Widget AreaDisplay widgets for monitoring each resource
  • Click the More button at the top right of the widget to manage the widget
  • Modification and replication of widgets, file download, metric view, and source view are possible
Table. Dashboard Details

Managing Dashboard

Dashboard Details page where you can modify or manage dashboard information and widgets.

Modifying the dashboard

You can modify the name of the dashboard or change the widget composition.

To modify the dashboard, follow the following procedure.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
  3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
  4. Dashboard Details page’s top right Edit button is clicked. It moves to the Dashboard Edit page.
  5. After modifying the information or widgets on the dashboard, click the Save button.
    ClassificationDetailed Description
    Dashboard NameThe name of the dashboard can be modified
    • Enter within 3~40 characters using English, numbers, and special characters (-_)
    • Cannot use the existing registered dashboard name
    Widget NameWidget Name Editable
    • Use English, numbers, spaces, and special characters (-_.|) to enter within 3 ~ 255 characters
    Widget ManagementWhen the mouse cursor is placed on the widget, the management button is displayed on the right side of the widget border
    • Edit: Widget modification is possible in the Widget Edit popup window, where you can modify the widget’s metrics and resources
      • For more information on widget editing, see Individual Widget Editing in Widget Management
    • Duplicate: Duplicate the current widget and add it to the dashboard
    • Delete: Delete the current widget from the dashboard
    • Expand: Expand the size of the current widget to display
      • Shrink: If expanded, clicking again will shrink the widget size
    Add WidgetAdd a new widget to the dashboard
    • Add Individual Widget: Add a single widget combined with metrics and resources
    • Add Multiple Widgets: Select the desired resources by metric unit to add multiple widgets at once
    • Load Dashboard: Load widgets from other dashboards and add them
    Table. Dashboard Modification Items

Check detailed dashboard information

You can check detailed information about the dashboard.

To check the detailed information of the dashboard, please follow the following procedure.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. It moves to the Dashboard List page.
  3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
  4. Dashboard Details page’s upper right corner More > Details button click. Dashboard Details popup window opens.
ClassificationDetailed Description
ServiceService Name
Resource TypeResource Type
SRNunique resource ID in Samsung Cloud Platform
  • In ServiceWatch, it means the SRN of the dashboard
Resource NameResource Name
  • In ServiceWatch, it means the name of the dashboard
Resource IDUnique resource ID in the service
CreatorThe user who created the service
Creation TimeThe time when the service was created
EditorUser who modified the service information
Revision TimeTime when service information was revised
Table. Dashboard Details - Detailed Information Popup Window Items

Check the dashboard source code

You can check the source code of the dashboard.

To check the source code of the dashboard, follow the next procedure.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. It moves to the Dashboard List page.
  3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
  4. Dashboard Details page’s upper right corner click the More > View Source button. Dashboard Source View popup window opens.
ClassificationDetailed Description
Source InformationDisplay dashboard source code in JSON format
code copycopy source code to clipboard
Fig. Dashboard Details - Dashboard Source View Popup Window Items

Dashboard duplication

You can currently replicate a widget on the dashboard and add it to another dashboard.

Guidance

To replicate the dashboard, user permissions are required.

  • User: {email}
  • Action: iam:CreatGroup
  • On resource: {SRN}
  • Context: no identity-based policy allows the action

To replicate the dashboard, follow the following procedure.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. It moves to the Dashboard List page.
  3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
  4. Dashboard Details page’s upper right corner More > Duplicate button, click. Dashboard Duplicate popup window opens.
  5. Select the dashboard replication method and enter the required information. The required information varies depending on the replication method.
Classification
Necessity
Detailed Description
Clone target-Name of the dashboard to be cloned
Replication MethodRequiredAfter replicating the widget on the dashboard, select the dashboard to add
  • New Dashboard: Create a new dashboard and add the current dashboard’s widgets by replicating them
  • Existing Dashboard: Add the current dashboard’s widgets to an existing dashboard by replicating them
Dashboard NameRequiredEnter the name of the new dashboard to be created
  • Displayed when the replication method is selected as New Dashboard
  • Enter within 3 ~ 40 characters using English, numbers, and special characters (-_)
dashboard selectionrequiredselect a dashboard to add a replicated widget among the existing created dashboards
  • displayed when the replication method is selected as existing dashboard
Table. Dashboard Replication Items
  1. When the essential information input is complete, click the completed button. A popup window announcing the dashboard replication will open.
  2. Click the Confirm button on the popup window. The dashboard replication task will be completed.

Delete Dashboard

You can delete the dashboard that is not used.

To delete the dashboard, follow the following procedure.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
  3. Dashboard List page, select the checkbox of the dashboard to be deleted, and then click the Delete button. A popup window announcing the deletion of the dashboard will open.
  • You can delete multiple dashboards at the same time.
  • Dashboard Details page’s top right corner has More > Delete button to delete individually.
  1. Enter delete in the delete confirmation input area, then click the confirm button. The dashboard will be deleted.

Managing widgets

Dashboard Details page where you can modify or manage widgets.

Modifying widgets

You can modify the widget’s metrics and resources.

To modify the widget, follow the following procedure.

  1. All services > Management > ServiceWatch menu, click. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
  3. Dashboard List page, click the dashboard you want to modify the widget. It moves to the Dashboard Details page.
  4. Dashboard Details page, click the More > Edit Widget button located at the top right of the widget you want to modify. The Edit Widget popup window opens.
  5. After modifying the widget’s metrics and resources, click the Confirm button. The widget modification will be completed.
Classification
Necessity
Detailed Description
Metric List AreaRequiredList of metrics that can be monitored in ServiceWatch
  • Click the + button in front of the namespace and dimension to check the lower-level list
  • If you select a metric to monitor, it will be displayed as a chart in the Selected Metric area
search filter areaselectionnamespace-dimension name, metric name, resource name, resource ID, tag-key are set, and then filter apply button is clicked to filter the metric list
  • namespace-dimension name: select namespace and dimension name
  • metric name: enter the exact metric name
  • resource name: enter the exact resource name
  • resource ID: enter the exact resource ID
  • tag key: select the tag key
Selected metric area-Monitoring chart for the selected metric in the metric list area
  • Graph of data 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 at that point
    • Drag the mouse to zoom in on a specific area of the graph
    • Clicking on the resource name displayed in the legend displays detailed information about the resource in a popup
  • Item values in the table area within the chart can be modified
    • Label: Enter the legend name using English, numbers, and special characters within 3 to 255 characters
    • Statistics: Select the method for aggregating metric data
      • Average (default), minimum, maximum, or sum can be selected
    • Aggregation period: Select the unit of time for aggregating metric values
      • 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, or 12 hours can be selected
    • Delete: Delete the corresponding legend
Table. Individual widget addition items

Widget duplication

You can copy the widget and add it to another dashboard.

Notice

To replicate the dashboard, user permissions are required.

  • User: {email}
  • Action: iam:CreatGroup
  • On resource: {SRN}
  • Context: no identity-based policy allows the action

To replicate a widget, follow the following procedure.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
  3. Dashboard List page, click the dashboard to replicate. It moves to the Dashboard Details page.
  4. Dashboard Details page, click the More > Widget Duplicate button located at the top right of the widget to be duplicated. The Widget Duplicate popup window opens.
  5. Select the widget replication method and enter the required information. The required information varies depending on the replication method.
Classification
Necessity
Detailed Description
Clone Target-Name of the dashboard to be cloned
Replication methodRequiredAfter replicating the widget, select the dashboard to add
  • Existing dashboard: Add a widget to an existing dashboard
  • New dashboard: Create a new dashboard and add a widget
dashboard selectionrequiredselect a dashboard to add a replicated widget among the existing created dashboards
  • displayed when the replication method is selected as existing dashboard
Dashboard NameRequiredEnter the name of the new dashboard to be created
  • Displayed when the replication method is selected as New Dashboard
  • Enter within 3 to 40 characters using English, numbers, and special characters (-_)
Widget NameRequiredEnter the name of the widget when adding it to the dashboard
  • Use English, numbers, and special characters (-_.|) to enter within 3 ~ 255 characters
Table. Widget Duplication Items
  1. When the required information input is complete, click the completed button. A popup window announcing the addition of a widget will open.
  2. Click the Confirm button on the popup window. The widget will be replicated and added to the corresponding dashboard.

Downloading widget files

You can download widget information in the form of a file.

To download widget information, follow the next procedure.

  1. All services > Management > ServiceWatch menu, click. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
  3. Dashboard List page, click the dashboard to download widget information. It moves to the Dashboard Details page.
  4. Dashboard Details page, click the More > File Download button located at the top right of the widget to download the widget information. The File Download popup window opens.
  5. Select the file download method, then click the Confirm button. The download will start.
  • The download methods can be selected simultaneously.
ClassificationDetailed Description
CSVwidget’s metrics and monitoring data are converted to an Excel (*.csv) file for download
PNGwidget chart is converted to an image (*.png) file and downloaded
Table. Widget file download items

Widget Metric Details

Widget’s resource and metric information can be checked on the metric page

To view the widget metrics on the metrics page, follow these procedures.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
  3. Dashboard List page, click the dashboard to check the widget metrics. It moves to the Dashboard Details page.
  4. Dashboard Details page, click the More > View Metrics button located at the top right of the widget to be checked on the Metrics page. It moves to the Metrics page.
  • The resource and metric information of the selected widget is automatically set and displayed on the Metrics page.
Reference
Metrics page for more details, please refer to View Metrics.

Widget source information

You can check the source code of the dashboard.

To check the source code of the dashboard, follow the following procedure.

  1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
  2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
  3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
  4. Dashboard Details page, click the More > View Source button located at the top right of the widget to check the source code. The Widget Source View popup window opens.
ClassificationDetailed Description
Source InformationDisplays widget source code in JSON format
code copycopy source code to clipboard
Table. View widget source items
How-to guides
Alert