The page has been translated by Gen AI.

How-to guides

Users can monitor resources created in Samsung Cloud Platform through ServiceWatch.

Using Dashboards

You can monitor resources on the dashboard detail screen of ServiceWatch.

Note
  • To use a dashboard, you must first create a dashboard and register monitoring metrics as widgets.
  • For details on dashboard creation, refer to Creating a Dashboard.

Follow these steps to monitor resources using a dashboard.

  1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
  2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
  3. On the Dashboard List page, click the dashboard for the resources you want to monitor. You will be taken to the Dashboard Detail page.
  4. On the Dashboard Detail page, select the monitoring period and time zone, then monitor resources through widgets.
    DivisionDetailed Description
    Dashboard NameDashboard name
    • Click the name to select another dashboard
    Period Setting AreaSelect 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 AreaSelect the time zone to apply to the period setting
    Reset ButtonReset all manipulations or settings on the dashboard detail screen
    Refresh Setting AreaSelect 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
    EditModify dashboard information
    • When you click the Edit button, you will be taken to the Edit Dashboard page
    MoreDisplay additional task items for managing the dashboard
    Alert StatusDisplay the number of active alerts among the alerts linked to the recommended metrics of the service dashboard by level
    • When you click the View All Alert Policies button, you will be taken to the Alert Policy List page
    • When you click the Expand button, it is provided in widget format (up to 12)
      • View Alert Policy: Go to the Alert Policy Detail page for that metric
    Dashboard StatusDisplay metric widgets for monitoring each resource
    • Click the View Widget Enlarged button to view detailed information about the metric
    • Click the More button to manage the widget
    • 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
    Table. Dashboard Detail Items
Reference
  • When you click the More > View Metrics button in the upper right corner of a widget, you can view metric information for that widget on the Metrics page.
  • For details on the Metrics page, refer to Viewing Metrics.

Setting Dashboard Favorites

You can set frequently used dashboards as favorites to easily navigate to those dashboards on the Service Home page of ServiceWatch. Follow these steps to set a dashboard as a favorite.

  1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
  2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
  3. On the Dashboard List page, check the favorite icon of the dashboard you want to add to favorites. Click the dashboard for which you want to view detailed information. You will be taken to the Dashboard Detail page.
    • The favorited dashboard is added to the bottom of the Dashboard > Dashboard Favorites menu and the Dashboard Favorites area of the Service Home page.

Viewing Widget Details

You can individually view widgets in the dashboard by enlarging them. Follow these steps to view an individual widget in enlarged mode.

  1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
  2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
  3. On the Dashboard List page, click the dashboard for the resources you want to monitor. You will be taken to the Dashboard Detail page.
  4. On the Dashboard Detail page, click the View Widget Enlarged button of the widget you want to view in enlarged mode. The Metric Detail popup window for that widget will open.
    DivisionDetailed Description
    Widget NameDisplay the widget name
    Period Setting AreaSelect the period to apply to the widget
    • For metric query, you can set up to 455 days from the current time
    Time Zone Setting AreaSelect the time zone to apply to the period setting
    Reset ButtonReset all manipulations or settings on the dashboard detail screen
    StatisticsSelect the statistics criterion for the metrics displayed in the widget
    • Click the statistics criterion to select the criterion: Average, Minimum, Maximum, Sum
    Aggregation Period Setting AreaSelect the aggregation period for widget information
    • Click the aggregation period to select the desired period: 1 minute, 5 minutes, 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
    Refresh Setting AreaSelect 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
    Chart AreaDisplay monitoring results as a chart
    • When you place the mouse cursor on the graph and legend areas, the time, data value, and metric data information at that point are displayed in a popup
    • You can zoom in on that area by dragging the graph area
    • When you click the resource name displayed in the legend, the alert status for that resource opens in a popup
    Table. Metric Detail Items

Viewing Alert History

You can view alert history for metrics registered in ServiceWatch dashboards. Follow these steps to view alert history.

  1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
  2. On the Service Home page, click the Alert > Alert History menu. You will be taken to the Alert History page.
  3. On the Alert History page, view the alert history.
    DivisionDetailed Description
    Alert Filter and Search AreaFilter or search alert history
    • All Alert Status: Filter by selecting alert status
    • Search by entering the alert policy name in the search input field
    • Detailed Search: Search by entering alert policy name, alert status, or change date
    Alert Policy NameAlert policy name
    • When you click the alert policy name, you can view detailed information of that alert policy
    ConditionAlert occurrence condition and total occurrence time
    • Display levels by importance: High, Middle, Low
    DivisionClassification of alert creation and alert status change information
    Alert StatusCurrent alert status
    • Normal: When the metric does not meet the set condition
    • Insufficient data: When metric data cannot be verified (missing, non-existent, not arrived)
    • Alert: When the metric meets the set condition
    Alert LevelWhen alert status is Alert, display the alert level
    • High, Middle, Low
    Table. Alert History Items
Reference
You can create and manage new alert policies. For details on alert policies, refer to Viewing Alert Policies.

Monitoring Metrics

You can view and monitor metrics available in ServiceWatch.

Comparing by Metrics

You can select one or more metrics and resources to monitor. Follow these steps to monitor by comparing metrics.

  1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.

  2. On the Service Home page, click the Metrics menu. You will be taken to the Metrics page.

  3. On the Metrics page, click Compare by Metrics in the metric view mode.

  4. On the Metrics page, select the metrics you want to monitor from the metric list. A monitoring chart for the selected metrics is displayed in the Selected Metrics area at the bottom.

    DivisionDetailed Description
    Metric List AreaList 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 AreaSet 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
    Table. Metric List Items

  5. View the monitoring chart in the Selected Metrics area.

    DivisionDetailed Description
    Period Setting AreaSelect the period to apply to the chart
    • For metric query, you can set up to 455 days from the current time
    Time Zone Setting AreaSelect the time zone to apply to the chart
    Reset ButtonReset all manipulations or settings on the chart
    Refresh Setting AreaSelect the refresh cycle for the chart
    • 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
    MoreDisplay additional task items for managing the chart
    Graph AreaData 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
    Table AreaCheck and modify labels, statistics, and aggregation period by legend
    • Legend: Color by legend
      • Click the legend color to change to a different color
    • Label: Display the namespace, resource name, and metric name of the selected metric
      • Click the legend name to change
      • Enter within 3 to 255 characters using English letters, numbers, and special 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, 1 day
    • More: Delete the legend or create an alert policy for the legend
    Table. Compare by Metrics Monitoring Chart Items
    Reference
    • Statistics methods are as follows.
      • Sum: Sum of all data point values collected during the period
      • Average: Value obtained by dividing the Sum during the specified period by the number of data pointers during that period
      • Minimum: Lowest value observed during the specified period
      • Maximum: Highest value observed during the specified period
    • For a detailed explanation of metrics, refer to Metrics Overview.

Comparing by Date

You can monitor by comparing one metric and resource by date or period. Follow these steps to monitor by comparing by date or period.

  1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.

  2. On the Service Home page, click the Metrics menu. You will be taken to the Metrics page.

  3. On the Metrics page, click Compare by Date in the metric view mode.

  4. On the Metrics page, select the metrics you want to monitor from the metric list. A monitoring chart for the selected metrics is displayed in the Selected Metrics area at the bottom.

    DivisionDetailed Description
    Metric List AreaList 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 AreaSet 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
    Table. Metric List Items

  5. View the monitoring chart in the Selected Metrics area.

    DivisionDetailed Description
    Date Comparison/Period ComparisonSelect the criterion to compare metrics
    • Date Comparison: Compare by specifying a specific date
    • Period Comparison: To be provided in the future
    Date and Period Setting AreaSelect the date or period to compare
    • Date Comparison: Specify the date to view in the chart
      • You can set up to 455 days from the current time
      • You can set up to 4
    • Period Comparison: To be provided in the future
    Time Zone Setting AreaSelect the time zone to apply to the chart
    Reset ButtonReset all manipulations or settings on the chart
    Refresh Setting AreaSelect the refresh cycle for the chart
    • 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
    MoreDisplay additional task items for managing the chart
    Graph AreaData 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 date or period displayed in the legend, detailed information about that legend is displayed in a popup
    Table AreaCheck 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.
      • Note the green icon displayed to the right of meaningful metrics for that metric
    • 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
    • More: Delete the legend or create an alert policy for the legend
    Table. Compare by Date Monitoring Chart Items
    Reference
    • Statistics methods are as follows.
      • Sum: Sum of all data point values collected during the period
      • Average: Value obtained by dividing the Sum during the specified period by the number of data pointers during that period
      • Minimum: Lowest value observed during the specified period
      • Maximum: Highest value observed during the specified period
    • For a detailed explanation of metrics, refer to Metrics Overview.

Monitoring Logs

You can monitor logs collected from Samsung Cloud Platform services.

Note
To view log monitoring data, you must first create a Log Group and Log Stream. For details on log groups, refer to Monitoring Logs.
Follow these steps to view log monitoring data.

  1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
  2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
  3. On the Log Group List page, click the log group name for which you want to view detailed information. You will be taken to the Log Group Detail page.
  4. On the Log Group Detail page, click the Log Stream tab. The Log Stream list is displayed.
  5. On the Log Stream list, click the log stream name for which you want to view detailed information. You will be taken to the Log Stream Detail page.
    • When you click the View All Log Streams button at the top of the log stream list, you will be taken to the All Log Streams Detail page.
      DivisionDetailed Description
      Excel DownloadDownload log stream history as an Excel file
      Timestamp ListMessage list by timestamp
      • Filter using Period Selection, User Time Zone, and message input
      Table. Log Group Detail - Log Stream Detail Items

Receiving Event Notifications

You can receive notifications by creating system event rules for changes in resources created in Samsung Cloud Platform.

Note
To receive event notifications, you must first create an Event Rule. For details on event rule creation, refer to Creating an Event Rule.

Installing ServiceWatch Agent

You can install ServiceWatch Agent to collect custom metrics and logs from monitoring targets.

Warning
Metric collection through ServiceWatch Agent is classified as custom metrics and is charged differently from metrics collected by default from each service, so be careful not to set up unnecessary metric collection. Make sure to set it up so that only necessary metrics are collected.
Follow these steps to install ServiceWatch Agent.

  1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
  2. On the Service Home page, click the Agent Setup & Guideline button. The Agent Setup & Guideline popup window will open.
  3. Copy the Installation File URL from the Agent Setup & Guideline popup window and navigate to that address. You can download the agent, manager, and configuration files.
Reference
Custom metric and log collection through ServiceWatch Agent is currently available only in Samsung Cloud Platform For Enterprise. It will be provided in other offerings in the future.
Custom Metrics and Logs
Managing Dashboards and Widgets