How-to guides
Users can monitor resources created in the Samsung Cloud Platform using ServiceWatch.
Using the Dashboard
You can monitor resources on the ServiceWatch dashboard details screen.
- To use the dashboard, you must first create a dashboard and register the monitoring metrics as widgets.
- For details on creating a dashboard, see Create a dashboard.
To monitor resources with the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigates to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigates to the Dashboard List page.
- Click the dashboard for the resource you want to monitor on the Dashboard List page. 3. Navigates to the Dashboard Details page.
- On the Dashboard Details page, select the monitoring period and time zone, then monitor resources using widgets.
Category Detailed Description Dashboard name Dashboard name - Click the name to select a different dashboard
Period Settings Area Period selection applied to widgets on the dashboard - Metric queries can be configured for up to 455 days from the current date.
Time zone settings area Time zone selection applied to period settings Initialize button Reset all operations and settings made in the dashboard detail view Refresh Settings Area Select the refresh interval for widget information - The Refresh button updates the information based on the current time
- Click the refresh interval to select your preferred interval: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
Edit Modify dashboard information - When you click the Modify button, you are redirected to the Modify Dashboard page.
- For details on modifying a dashboard, see Manage Dashboards.
Show more Displays additional action items for managing the dashboard. - For details on dashboard management items, see Manage Dashboards.
Alert Status Displays the number of active alerts associated with the recommended metrics on the service dashboard, broken down by stage. - Clicking the View All Alert Policies button navigates to the Alert Policy List page.
- Clicking the Expand button provides the content in widget format (up to 12 widgets).
- For details on widget management, refer to Manage Widgets.
- View Alert Policy: Navigates to the Alert Policy Details page for the corresponding metric.
Dashboard Status Display metric widgets for monitoring each resource. - Click the Expand Widget button to view detailed information about the metric.
- For more information about metric details, see Widget Details.
- Click the More button to manage widgets.
- For more information about widget management, see Manage Widgets.
- Hover the mouse cursor over the graph to display a popup showing the time, data value, and metric data information for that point.
- Drag the mouse to zoom in on a specific area of the graph.
- Click a resource name in the legend to display a popup with detailed information about that resource.
Table. Dashboard details
- Click the More > View Metrics button in the upper-right corner of the widget to view the metric information for that widget on the Metrics page.
- For details about the Metrics page, see View Metrics.
Set dashboard favorites
You can add frequently used dashboards to your favorites to easily navigate to them from the Service Home page in ServiceWatch. To add a dashboard to your favorites, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigates to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigates to the Dashboard List page.
- On the Dashboard List page, check the favorite icon for the dashboard you want to favorite. Click the dashboard whose details you want to view. 3. Navigates to the Dashboard Details page.
- Bookmarked dashboards are added to the bottom of the Dashboard > Dashboard Bookmarks menu and to the Dashboard Bookmarks area on the Service Home page.
Widget Details
You can zoom in on widgets within the dashboard to view them individually. To zoom in on an individual widget, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigates to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigates to the Dashboard List page.
- Click the dashboard for the resource you want to monitor on the Dashboard List page. 3. Navigates to the Dashboard Details page.
- Click the Widget Zoom button for the widget you want to view in detail on the Dashboard Details page. 4. A Metric Details popup window opens for the widget.
Category Detailed Description Widget name Displaying the widget name Period Settings Area Select the period applied to the widget - Metric queries can be configured for up to 455 days from the current date
Time zone settings area Time zone selection applied to period settings Initialize button Reset all operations and settings made on the dashboard detail screen Statistics Select the statistical basis for the metrics displayed in the widget - Click the statistical basis to select a basis: Average, Minimum, Maximum, Sum
Aggregation Period Settings Area Select 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 Settings Area Select the refresh interval for widget information - The Refresh button updates the information based on the current time
- Click the refresh interval to select the desired interval: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
Chart area Display monitoring results in a chart - When you hover the mouse cursor over the graph or legend area, a popup displays the time, data value, and metric data information for that point.
- Drag the graph area to zoom in on the selected region.
- Click a resource name in the legend to open a popup showing the alert status for that resource.
Table. Metric details
Checking Alert History
You can view the alert history for metrics registered on the ServiceWatch dashboard. To check the alarm history, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigates to the Service Home page.
- On the Service Home page, click the Alerts > Alert History menu. 2. Go to the Alert History page.
- Check the alert history on the Alert History page.
Category Detailed Description Alert Filters and Search Area You can filter or search alert details. - Overall Alert Status: Select an alert status to filter.
- Enter an alert policy name in the search field to search.
- Advanced Search: Enter an alert policy name, alert status, or modification date and time to search.
Alert policy name The name of the alert policy - Click the alert policy name to view the detailed information for that alert policy
Condition Alert occurrence conditions and total occurrence time - Severity-based level display: High, Middle, Low
Category Distinguishing between alert creation and alert status change information Alert Status Current alert status - Normal: When the metric does not meet the configured conditions
- Insufficient data: When metric data cannot be verified (missing, non-existent, or not received)
- Alert: When the metric meets the configured conditions
Alert Level If the alert status is Alert, display the alert level: - High, Middle, Low
Table. Alarm history items
- You can check the status of recent alerts through Copilot.
- Query alerts by ‘Alert Name’ or ‘ID’: You can view the alert status widget for alerts that occurred in the last 3 hours. * Click the Alert Policy Shortcut button to navigate to the details page for the corresponding alert policy.
- ‘Recent Alert Lookup’: You can view up to the 5 most recent alerts. * Click the Go to Alert Policy List button to navigate to the alert policy list page.
- You can create and manage new alert policies. * For details about alert policies, see Viewing alert policies.
Monitor Metrics
You can view and monitor the metrics available in ServiceWatch.
Comparing by Metric
You can monitor one or more metrics and resources. To monitor by comparing metrics, follow these steps.
Click the All Services > Management > ServiceWatch menu. 1. Navigates to the Service Home page.
On the Service Home page, click the Metrics menu. 2. Go to the Metrics page.
On the Metrics page, in the metrics view mode, click Compare Metrics.
Select the metrics to monitor from the metrics list on the Metrics page. 4. The monitoring chart for the selected metric is displayed in the Selected Metrics area at the bottom.
Category Detailed Description Metrics List Area List of metrics that can be monitored in ServiceWatch - Click the + button before the namespace or 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 configuring the search items to filter, click the Apply Filter button to filter the metric list. - Namespace-Dimension Name: Search based on the dimension names under 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 top-level category and the entered keyword.
- Search is performed for each item, excluding Metric Name, Resource Name, Resource ID, and Tag Key.
- Tag Key: Search by the selected Tag Key.
- Click the Save button to apply the filtering, which maintains the filter state even after reconnection.
- Applies only within the same region.
Table. List of metric itemsCheck the monitoring chart in the Selected Metrics area.
Category Detailed Description Period Settings Area Select the period to apply to the chart - Metric queries can be configured for up to 455 days from the current date
Time zone settings area Time zone selection applied to the chart Initialize button Reset all manipulations and settings made in the chart Refresh Settings Area Select the chart refresh interval - The Refresh button updates the information based on the current time
- Click the refresh interval to select the desired interval: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
Show more Displays additional work items for chart management. - For details on chart management, see Manage Metric Charts.
Graph area A data graph collected over the period applied to the chart. - When you hover the mouse cursor over the graph, a popup displays the time, data value, and metric data information for that point.
- You can zoom in on a specific area of the graph by dragging the mouse.
- Clicking a label name in the legend displays detailed information for that legend in a popup.
Table area You can view and modify the labels, statistics, and aggregation period for each legend. - Legend: The color for each legend
- Click a legend color to change it to a different color
- Label: Displays the namespace, resource name, and metric name of the selected metric
- Click a legend name to change it
- Enter 3 to 255 characters using letters, numbers, and special characters
- Statistics: Select the method for aggregating metric data
- You can select from Average (default), Minimum, Maximum, Sum, and Number of collected data points
- Aggregation Period: Select the unit for the aggregation period of metric values
- You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, and 1 day
- More: You can delete a legend or create an alert policy for the legend
- For details on creating an alert policy, see Create an Alert Policy
- Click the Metric Information button to view metric information through Copilot and navigate to the corresponding metric.
Table. Metric comparison monitoring chart itemsReference- The statistical method is as follows.
- Total: The sum of all data point values collected during the specified period
- Average: The sum over the specified period divided by the number of data points during that period
- Minimum: The lowest value observed during the specified period
- Maximum: The highest value observed during the specified period
- For detailed descriptions of the metrics, see Metric Overview.
Comparing by date
You can monitor and compare a single metric and resource by date or period. To monitor by comparing dates or periods, follow these steps.
Click the All Services > Management > ServiceWatch menu. 1. Navigates to the Service Home page.
On the Service Home page, click the Metrics menu. 2. Go to the Metrics page.
On the Metrics page, in the metrics view mode, click Date Comparison.
Select the metrics to monitor from the metrics list on the Metrics page. 4. The monitoring chart for the selected metric is displayed in the Selected Metrics area at the bottom.
Category Detailed Description Indicator list area List of metrics that can be monitored in ServiceWatch - Click the + button before the namespace or 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 dimension names under 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 top-level category and the entered keyword.
- Search is performed for each item, excluding Metric Name, Resource Name, Resource ID, and Tag Key.
- Tag Key: Search by the selected Tag Key.
- Click the Save button to apply the filtering. The filtered state is maintained even after reconnection.
- Applies only within the same region.
Table. List of metric itemsCheck the monitoring chart in the Selected Metrics area.
Category Detailed Description Date Comparison/Period Comparison Select a baseline for comparing metrics - Date Comparison: Select a specific date to compare
- Period Comparison: Select a specific period to compare
Date and Period Settings Area Select the date or period to compare - Date Comparison: Select the date to view in the chart
- Period Comparison: Select the period to view in the chart
- You can select up to 4 dates or periods within 455 days from the current date
Time zone settings area Time zone selection applied to the chart Initialize button Reset all manipulations and settings made on the chart Refresh Settings Area Select the chart refresh interval - The Refresh button updates the information based on the current time
- Click the refresh interval to select the desired interval: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
More Displays additional work items for chart management. - For details on chart management, see Manage Metric Charts.
Graph area A data graph collected over the period applied to the chart. - When you hover the mouse cursor over the graph, a popup displays the time, data value, and metric data information for that point.
- You can zoom in on a specific area of the graph by dragging the mouse.
- Clicking a date or period displayed in the legend shows detailed information for that legend in a popup.
Table area You can view and modify labels and statistics by legend, as well as the aggregation period. - Legend: Legend colors
- Click a legend color to change it to a different color.
- Period: The period applied to the chart
- Metric: Displays the namespace, resource name, and metric name of the selected metric
- Statistics: Select the method for aggregating metric data
- You can select from Average (default), Minimum, Maximum, Sum, and Number of collected data points.
- Note that a green icon is displayed to the right of meaningful metrics within the applicable metric.
- Aggregation Period: Select the unit for the aggregation period of metric values
- You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, and 1 day.
- More: You can delete a legend or create an alert policy for the legend.
- For details on creating an alert policy, see Create an alert policy.
- Click the Metric Information button to view metric information through Copilot and navigate to the corresponding metric.
Table. Date comparison monitoring chart itemsReference- The statistical method is as follows.
- Total: The sum of all data point values collected during the specified period
- Average: The sum over the specified period divided by the number of data points during that period
- Minimum: The lowest value observed during the specified period
- Maximum: The highest value observed during the specified period
- For detailed descriptions of the metrics, see Metric Overview.
Monitoring Logs
You can monitor logs collected from the Samsung Cloud Platform service.
To review log monitoring data, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigates to the Service Home page.
- On the Service Home page, click the Logs > Log Groups menu. 2. Go to the Log Group List page.
- On the Log Group List page, click the log group name for which you want to view detailed information. 3. Navigates to the Log Group Details page.
- On the Log Group Details page, click the Log Stream tab. 4. The log stream list is displayed.
- Click the log stream name in the Log Streams list to view its details. 5. Navigates to the Log Stream Details page.
- Click the View All Log Streams button at the top of the log stream list to navigate to the All Log Streams Details page.
Category Detailed Description Download Excel You can download the log stream history as an Excel file. Timestamp list Message list by timestamp - Filter by period selection, user time zone, and message input
Table. Log group details - Log stream details
- Click the View All Log Streams button at the top of the log stream list to navigate to the All Log Streams Details page.
Receiving Event Notifications
You can create system event rules for changes to resources created in Samsung Cloud Platform and receive them as notifications.
Installing the ServiceWatch Agent
Install the ServiceWatch Agent to collect custom metrics and logs from monitoring targets.
To install the ServiceWatch Agent, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigates to the Service Home page.
- On the Service Home page, click the Agent Setup & Guideline button. 2. The Agent Setup & Guideline popup opens.
- Copy the Installation File URL from the Agent Setup & Guideline popup and navigate to that address. 3. You can download the agent, manager, and configuration files.
- For details on installing the ServiceWatch Agent, see Using the ServiceWatch Agent.