How-to guides
Users can monitor resources created on the Samsung Cloud Platform through ServiceWatch.
Using the Dashboard
You can monitor resources on the ServiceWatch dashboard detail screen.
- To use the dashboard, you must first create a dashboard and register monitoring metrics as widgets.
- Please refer to Creating a Dashboard for detailed information on dashboard creation.
To monitor resources with the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigate to the Dashboard List page.
- On the Dashboard List page, click the dashboard for the resource you want to monitor. 3. Navigate to the Dashboard Details page.
- Dashboard Details page, select the monitoring period and time zone, then monitor resources using the widget.
Category Detailed description Dashboard name Dashboard name - click 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 Settings Section 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 displays information anew based on the current time
- Click the refresh interval to select the desired period: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
Edit Edit dashboard information - When the Edit button is clicked, navigate to the Dashboard Edit page
- For detailed information about dashboard editing, see 대시보드 관리하기
More Display additional tasks for managing the dashboard - For detailed information on dashboard management items, see Dashboard Management
Alert Status Show the number of active alerts linked to recommended metrics on the service dashboard, displayed by stage - When the View All Alert Policies button is clicked, navigate to the Alert Policy List page
- When the Expand button is clicked, the content is provided as widgets (up to 12)
- For detailed information on widget management, refer to 위젯 관리하기
- View Alert Policy: navigate to the Alert Policy Details page for the corresponding metric
Dashboard status Display metric widgets for monitoring each resource - Click the Widget Expand View button to view detailed information about the metric
- For more details on metric information, refer to Widget Details
- Click the More button to manage widgets
- For detailed information on widget management, refer to Widget Management
- When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data for that point
- You can drag the mouse to zoom in on a specific area of the graph
- Clicking a resource name shown in the legend displays detailed information about that resource in a popup
Table. Dashboard detailed items
- Click the More > View Metrics button at the top right of the widget to view metric information for that widget on the Metrics page.
- For detailed information about the Metric page, please refer to Metric View.
Setting dashboard favorites
You can bookmark frequently used dashboards and easily navigate to the dashboard from the ServiceWatch Service Home page. To bookmark the dashboard, follow these steps.
- All Services > Management > ServiceWatch menu, click. 1. Go to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigate to the Dashboard List page.
- Dashboard List page, check the favorite icon of the dashboard you want to bookmark. Click the dashboard to view its details. 3. Navigate to the Dashboard Details page.
- Bookmarked dashboards are added to the bottom of the Dashboard > Dashboard Favorites menu and the Dashboard Favorites section on the Service Home page.
Widget Details
You can enlarge widgets within the dashboard to view them individually. To enlarge and view an individual widget, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Go to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigate to the Dashboard List page.
- Dashboard List page, click the dashboard for the resource you want to monitor. 3. Navigate to the Dashboard Details page.
- On the Dashboard Details page, click the Widget Zoom button for the widget you wish to enlarge. 4. The Metric Details popup opens for this widget.
Category Detailed description Widget name Display widget name Period setting area Period selection applied to the widget - Metric lookup can be set from now up to a maximum of 455 days
Time Zone Settings Section Select the time zone applied to the period setting Reset button Reset all actions and settings made on the dashboard detail screen. Statistics Select statistical basis for the metric displayed in the widget - Click the statistical basis to select: average, minimum, maximum, sum
Aggregation Period Setting Area Select aggregation period for widget information - Click the aggregation period to choose the desired interval: 1 minute, 5 minutes, 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
Refresh Settings Area Select refresh interval for widget information - Refresh button displays information anew based on the current time
- Click the refresh interval to select the desired period: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
Chart area Display monitoring results as a chart - When the mouse cursor is placed over the graph or legend area, a popup shows the time, data value, and metric data for that point
- You can drag the graph area to zoom into the selected region
- Clicking a resource name displayed in the legend opens a popup with the alarm status for that resource
Table. Detailed indicator items
Check alarm history
You can view the alert history for metrics registered on the ServiceWatch dashboard. To view the alarm history, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Service Home Go to the page.
- On the Service Home page, click the Alarm > Alarm History menu. 2. Go to the Alarm History page.
- Check the alarm history on the Alarm History page.
Category Detailed description Alert filter and search area Filter or search alarm history - All alarm statuses: Filter by selecting an alarm status
- Enter the alarm policy name in the search field to search
- Advanced search: Search by entering the alarm policy name, alarm status, or change timestamp
Alert Policy Name Alert policy name - Click the alert policy name to view detailed information of that alert policy
Condition Alarm trigger conditions and total occurrence time - Stage display according to severity: High, Middle, Low
Category Distinguish alarm creation and alarm status change information Alarm status Current alert status - Normal: when the metric does not meet the configured condition
- Insulfficient data: when the metric data cannot be retrieved (missing, nonexistent, not arrived)
- Alert: when the metric meets the configured condition
Alert level When the alarm status is Alert, display the alarm level - High, Middle, Low
Table. Alarm History Items
- You can view the recent alarm status through Copilot.
- ‘Alarm name’ or ‘ID’ alarm query: You can view the alarm status widget for the past 3 hours. * When you click the Alert Policy Shortcut button, you will be taken to the detail page of that alert policy.
- ‘Show recent alerts’: You can view up to 5 of the most recent alerts. * Click the Alert Policy List Shortcut button to go to the alert policy list page.
- You can create and manage new alert policies. * For detailed information about the alert policy, please refer to View alert policy.
Monitoring Metrics
You can view and monitor the metrics available in ServiceWatch.
Compare by indicator
You can select one or multiple metrics and resources to monitor. To compare and monitor by metric, follow these steps.
All Services > Management > ServiceWatch menu, click. 1. Navigate to the Service Home page.
On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
On the Metrics page, in metric view mode, click Metric Comparison.
Select the metric to monitor from the metric list on the Metric page. 4. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
Category Detailed description Indicator List Area List of metrics that can be monitored in ServiceWatch - Click the + button in front of 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 sub-dimension names 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 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
Table. Indicator list itemsCheck the monitoring chart in the Selected metric area.
Category Detailed description Period setting area Select the period applied to the chart - Indicator lookup can be set from now up to a maximum of 455 days
Time Zone Settings Area Select the time zone applied to the chart Reset button Reset all modifications and settings made on the chart Refresh Settings Area Select chart refresh interval - Refresh button displays information anew 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 Display additional tasks for managing charts - For detailed information on chart management, see Metric Chart Management
graph 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 a label name displayed in the legend shows detailed information about that legend in a popup
Table area View and edit labels, statistics, and aggregation periods for each legend - Legend: Color per legend
- Click a legend color to change it to another color
- Label: Displays the namespace, resource name, and metric name of the selected metric
- Click the legend name to edit it
- Enter using letters, numbers, and special characters, between 3 and 255 characters
- Statistics: Choose how to aggregate metric data
- Select from Average (default), Minimum, Maximum, Sum
- Aggregation period: Choose the time unit for aggregating metric values
- Select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
- More: Delete a legend or create an alert policy for the legend
- For details on creating an alert policy, see Create an alert policy
Table. Indicator comparison monitoring chart itemsReference- The statistical method is as follows.
- Total: sum of all data point values collected during the period
- Average: the value obtained by dividing the sum over the specified period by the number of data pointers during that period.
- Minimum: the lowest value observed during the specified period
- Maximum: the highest value observed during the specified period
- For a detailed description of the metric, refer to Metric Overview.
Compare by Date
You can monitor by comparing a metric and a resource across dates or time periods. To compare and monitor by date or period, follow these steps.
All Services > Management > ServiceWatch menu, click it. 1. Navigate to the Service Home page.
On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
On the Metrics page, in view mode, click Date Comparison.
Select the metric to monitor from the metric list on the Metric page. 4. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
Category Detailed description Indicator List Area List of metrics that can be monitored in ServiceWatch - Click the + button in front of 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 metric 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: 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
- Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key
- Tag Key: Search using the selected tag key
Table. Indicator list itemsCheck the monitoring chart in the selected metric area.
Category Detailed description Date comparison / period comparison Select criteria for comparing indicators - Date comparison: Compare by selecting a specific date
- Period comparison: Compare by selecting a specific period
Date and period setting area Select date or period to compare - Date comparison: Select the date to view on the chart
- Period comparison: Select the period to view on the chart
- You can select up to four dates or periods within a maximum of 455 days from today
Time Zone Settings Section Select the time zone applied to the chart Reset button Reset all manipulations and settings made on the chart Refresh Settings Area Select chart refresh interval - 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 Display additional tasks for managing charts - For detailed information on chart management, see Managing Metric Charts
graph 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 date or period shown in the legend displays detailed information about that legend in a popup
Table area View and edit labels, statistics, and aggregation periods for each legend - Legend: Color per legend
- Click a legend color to change it to another color
- Period: Period applied to the chart
- Metric: Displays the namespace, resource name, and metric name of the selected metric
- Statistics: Choose how to aggregate metric data
- Average(default), Minimum, Maximum, Sum can be selected.
- Refer to the green icon displayed to the right of a meaningful metric in the relevant metric
- Aggregation Period: Select the aggregation period unit for metric values
- 1 minute, 5 minutes(default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day can be selected
- More: Delete a legend or create an alert policy for a legend
- For details on creating an alert policy, see Create an Alert Policy
Table. Date comparison monitoring chart itemsReference- The statistical method is as follows.
- Total: sum of all data point values collected during the period
- Average: the value obtained by dividing the sum over the specified period by the number of data pointers during that period
- Minimum: the lowest value observed during the specified period
- Maximum: the highest value observed during the specified period
- For detailed explanations of the metrics, refer to the Metric Overview.
Log Monitoring
You can monitor logs collected from the Samsung Cloud Platform service.
To view the log monitoring data, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
- On the Service Home page, click the Log > Log Group menu. 2. Navigate to the Log Group List page.
- On the Log Group List page, click the log group name to view its details. 3. Navigate to the Log Group Details page.
- On the Log Group Details page, click the Log Stream tab. 4. Log Stream list is displayed.
- log stream Click the log stream name in the list to view detailed information. 5. Navigate to the Log Stream Details page.
- Click the All Log Streams View button at the top of the log stream list to go to the All Log Streams Details page.
Category Detailed description Excel download Log stream history can be downloaded as an Excel file Timestamp list Message list by timestamp - Select period, user time zone, can filter using message input
Table. Log group details - Log stream detail items
- Click the All Log Streams View button at the top of the log stream list to go to the All Log Streams Details page.
Receive event notifications
You can create a system event rule for changes to resources generated in Samsung Cloud Platform and receive them as notifications.
Installing ServiceWatch Agent
You can install the ServiceWatch Agent to collect custom metrics and logs from the monitoring target.
To install the ServiceWatch Agent, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
- On the Service Home page, click the Agent Setup & Guideline button. 2. Agent Setup & Guideline A popup window opens.
- Agent Setup & Guideline Copy the installation file URL from the popup window and go to that address. 3. Agent, manager, and configuration files can be downloaded.
- For detailed information on installing the ServiceWatch Agent, refer to Using ServiceWatch Agent.