How-to guides

• 1: Managing Dashboards and Widgets
• 2: Alert
• 3: Metric
• 4: Logs
• 5: Events
• 6: Using ServiceWatch Agent

1 - 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.

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 Create Dashboard button.

4. 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.

5. 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	Required	Detailed 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

6. Click the Done button in the widget addition popup window. The widget is added to the dashboard on the dashboard creation page.

7. After confirming the added widget, click the Create button. A popup window will open announcing the dashboard creation.

8. Click the Confirm button. The dashboard creation is complete.

Creating a Dashboard by Adding Multiple Widgets

Follow these steps to create 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 Create Dashboard button.

4. 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.

5. 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	Required	Detailed 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

6. Click the Done button in the widget addition popup window. The widget is added to the dashboard on the dashboard creation page.

7. After confirming the added widget, click the Create button. A popup window will open announcing the dashboard creation.

8. Click the Confirm button. The dashboard creation is complete.

Creating a Dashboard by Importing a Dashboard

Follow these steps to create 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 Create Dashboard button.

4. 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.

5. 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	Required	Detailed 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

6. Click the Done button in the widget addition popup window. The widget is added to the dashboard on the dashboard creation page.

7. After confirming the added widget, click the Create button. A popup window will open announcing the dashboard creation.

8. 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.

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.

   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
3. 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.

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 which you want to view detailed information. You will be taken to the Dashboard Detail page.
4. Click the Edit button in the upper right corner of the Dashboard Detail page. You will be taken to the Edit Dashboard page.
5. 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

Viewing Dashboard Detailed Information

You can view detailed information about a dashboard. Follow these steps to view dashboard detailed information.

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 which you want to view detailed information. You will be taken to the Dashboard Detail page.
4. 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

Viewing Dashboard Source Code

You can view the dashboard source code. Follow these steps to view dashboard source code.

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 which you want to view detailed information. You will be taken to the Dashboard Detail page.
4. 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.

Follow these steps to clone 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 which you want to view detailed information. You will be taken to the Dashboard Detail page.

4. Click the More > Clone button in the upper right corner of the Dashboard Detail page. The Clone Dashboard popup window will open.

5. Select a dashboard cloning method and enter the required information. The required information varies depending on the cloning method.

   Division	Required	Detailed 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 Items

6. After entering the required information, click the Done button. A popup window will open announcing the dashboard cloning.

7. 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.

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, 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.
4. 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.

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 which you want to edit widgets. You will be taken to the Dashboard Detail page.
4. 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.
5. After modifying the widget’s metrics and resources, click the Confirm button. The widget editing is complete.

   Division	Required	Detailed 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

   Table. Add Individual Widget Items

Cloning a Widget

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

Follow these steps to clone a widget.

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 to clone. You will be taken to the Dashboard Detail page.

4. 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.

5. Select a widget cloning method and enter the required information. The required information varies depending on the cloning method.

   Division	Required	Detailed 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 Items

6. After entering the required information, click the Done button. A popup window will open announcing the widget addition.

7. 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.

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 which you want to download widget information. You will be taken to the Dashboard Detail page.
4. 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.
5. 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

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.

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 which you want to view widget metrics. You will be taken to the Dashboard Detail page.
4. 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.

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 which you want to view detailed information. You will be taken to the Dashboard Detail page.
4. 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.

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 which you want to download widget information. You will be taken to the Dashboard Detail page.
4. 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.
5. 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

Exporting to Object Storage

You can save widget information to Object Storage.

Follow these steps to save widget information to Object Storage.

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 which you want to download widget information. You will be taken to the Dashboard Detail page.
4. 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.
5. Select the bucket to save the widget information and click the Done button. A popup window will open announcing the save.
6. Click the Confirm button in the popup window. The data export will start.

2 - Alert

In ServiceWatch, you can create and manage alert policies by setting threshold criteria for metrics to monitor, and generate alert notifications when the set conditions are met.

Creating an Alert Policy

You can create an alert policy for a metric to set the criteria for alert generation. Follow the steps below to create an alert policy.

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 Policy menu. You will be taken to the Alert Policy List page.

3. On the Alert Policy List page, click the Create Alert Policy button. You will be taken to the Create Alert Policy page.

4. In the Enter Basic Information area, enter the name and description of the alert policy, then click the Select Metric button. The Select Metric popup window opens.

5. In the Select Metric popup window, select the metric for which you want to create an alert policy, then click the Confirm button. The Metric and Condition Settings area is displayed.

   Category	Required	Description
   Metric Category	Required	Filter and display the list of metrics available for monitoring in ServiceWatch by All or Key Metrics
   Metric List Area	Required	List of metrics available for monitoring in ServiceWatch Click the + button in front of namespace, dimension to view the lower-level list When you select a metric to monitor, it is displayed as a chart in the Selected Metric area If the metric is linked to a namespace, Service Dashboard is displayed Clicking Service Dashboard takes you to the detail page of that dashboard
   Search Filter Area	-	Set the search item to filter, then click the Apply Filter button to filter the metric list Namespace-Dimension Name: Search based on the lower-level dimension name of the selected namespace Metric Name: Enter the exact metric name to search Resource Name: Enter the exact resource name to search Resource ID: Enter the exact resource ID to search Keyword: Search based on the selected upper category and the entered keyword Search for each item excluding metric name, resource name, resource ID, tag-Key Tag Key: Search with the selected tag Key
   Selected Metric Area	-	Monitoring chart for the metric selected in the metric list area Data graph of data collected during the period applied to the chart Place the mouse cursor on the graph to display the time, data value, and metric data information of that point in a popup Drag the mouse to zoom in on a specific area of the graph Click the label name displayed in the legend to display detailed information about that legend in a popup In the chart display area, you can check and modify the labels, statistics, and aggregation period by legend Legend: Color by legend Click the legend color to change to another color Period: 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 Can select from Average (default), Minimum, Maximum, Sum Aggregation Period: Select the aggregation period unit of the metric value 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

   Table. Select Metric Popup Items

6. In the Metric and Condition Settings area, set the threshold for alert generation.

   Category	Required	Description
   Namespace	-	Namespace of the selected metric
   Metric Name	-	Name of the selected metric
   Unit	-	Data unit of the selected metric
   Evaluation Range	Required	Time (seconds) range for alert evaluation Can enter up to 604,800 seconds in multiples of 60 If set smaller than the collection period or not in multiples of the collection period, alert evaluation may be applied abnormally
   Statistics	Required	Select the method for calculating metric data during the evaluation range Sum: Sum of all data point values collected during that period Average: Value of dividing the Sum during the specified period by the number of data points during that period Minimum: Lowest value observed during the specified period Maximum: Highest value observed during the specified period
   Additional Configuration	Optional	Set the number of evaluations, number of violations, and method for handling missing data When additional configuration is set to Enable, you can set the number of evaluations and number of violations used when evaluating alerts. If the violation count condition is met out of the number of evaluations during the evaluation range (seconds), the alert status changes to Alert Number of Evaluations: Number of evaluations for alert generation Can enter 1 ~ 8,640 Number of Violations: Number of allowed violations until alert generation Can enter 1 ~ within Number of Evaluations If the evaluation range is less than 1 hour (3,600 seconds), Number of Evaluations/Evaluation Range can be set up to maximum 1 day (86,400 seconds) If the evaluation range is 1 hour (3,600 seconds) or more, Number of Evaluations/Evaluation Range can be set up to maximum 7 days (604,800 seconds) When additional configuration is set to Enable, you can set how to handle missing data when evaluating alerts. Treat missing data as missing (Missing) Treat missing data as ignore to maintain current alert status (Ignore) Treat missing data as satisfying the condition (Breaching) Treat missing data as normal that does not satisfy the condition (Not breaching)
   Condition Setting	Required	Condition Operator: Select the condition operator to compare the calculated metric data value during the evaluation range with the threshold Threshold: Set the threshold to compare with the calculated metric data value during the evaluation range using the condition operator Can enter 0 ~ 2,147,483,647 Condition: Description of the condition for alert status (Alert) change according to the set Condition Operator and Threshold
   Alert Level	Required	Select the alert level according to the importance of the alert policy
   Resource ID	-	Resource ID of the metric monitoring target
   Resource Name	-	Resource name of the metric monitoring target

   Table. Metric and Condition Settings Items

7. In the Notification Settings area, select the users to receive notifications when an alert occurs.

   • Only users with login history (users who have registered email, mobile phone number) can be added as notification recipients.
   • You can add up to 100 notification recipients.
     Note

     • If there is no user you want to add, you can create a user on the Create User page of the IAM service. For more information about creating a user, see Creating a User.
     • The notification method (E-mail or SMS) can be changed by selecting the notification target as Service > Alert on the Notification Settings page. For more information about notification settings, see Checking Notification Settings.

8. In the Enter Additional Information area, add tag information.

9. After checking the summary information, click the Create button. A popup window announcing the creation of the alert policy opens.

10. Click the Confirm button. The alert policy creation is completed.

Viewing Alert Policy Details

You can view and manage detailed information about an alert policy. To view detailed information about an alert policy, follow the steps below.

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 Policy menu. You will be taken to the Alert Policy List page.
   • You can also click the Alert Level button displayed in the Alert Policy menu to view only the list of alert policies corresponding to that alert level.
3. On the Alert Policy List page, click the alert policy name for which you want to view detailed information. You will be taken to the Alert Policy Details page.

   Category	Description
   Alert Policy Status	Status of the alert policy Active: Alert policy is activated Inactive: Alert policy is deactivated Can be changed by clicking the Activate or Deactivate button
   Alert Policy Deletion	Delete the corresponding alert policy
   Alert Status	Current alert status Normal: When the metric does not meet the set condition Insufficient data: When metric data cannot be checked (missing, non-existent, not arrived) Alert: When the metric meets the set condition When alert status is Alert, the alert level (>High, Middle, Low) is also displayed
   Metric Monitoring Chart	Metric monitoring chart during the set period For details about the monitoring chart, see Monitoring Metrics
   Information Category Tabs	Information category tabs for the alert policy Detailed Information, Notifications, Alert History, Tags, Operation History Click each tab to view the corresponding information

   Table. Alert Details Items

Detailed Information

You can view the basic information and metric information of the alert policy selected on the Alert Policy List page.

Notifications

You can view the notification recipients of the alert policy selected on the Alert Policy List page.

Alert History

You can view the history of alert status changes for the alert policy selected on the Alert Policy List page.

Tags

You can view the tag information of the alert policy selected on the Alert Policy List page, and add, change, or delete it.

Operation History

You can view the operation history of the alert policy selected on the Alert Policy List page.

Modifying an Alert Policy

You can modify the target metric and policy settings of an alert policy. To modify an alert policy, follow the steps below.

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 Policy menu. You will be taken to the Alert Policy List page.
3. On the Alert Policy List page, click the alert policy name for which you want to view detailed information. You will be taken to the Alert Policy Details page.
4. On the Alert Policy Details page, click the Modify button in the Metric Information of the Detailed Information tab. The Modify Metric Information popup window opens.
5. After modifying the metric information and policy settings, click the Confirm button. A popup window announcing the metric modification opens.
   • For details about metric modification items, see Creating an Alert Policy.
6. Click the Confirm button. The alert policy modification is completed.

Deleting an Alert Policy

You can delete unused alert policies. To delete an alert policy, follow the steps below.

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 Policy menu. You will be taken to the Alert Policy List page.
3. On the Alert Policy List page, select the checkbox of the alert policy you want to delete, then click the Delete button. A popup window announcing the deletion of the alert policy opens.
   • You can delete multiple alert policies at the same time.
   • You can also individually delete by clicking the Delete button at the right end of each alert policy or by clicking the Delete Alert Policy button on the corresponding Alert Policy Details page.
4. Click the Confirm button. The alert policy is deleted.

3 - Metric

Users can monitor metrics for service resources in Samsung Cloud Platform Console and use them for management.

Viewing Metrics

You can view the metrics available in ServiceWatch. To view metrics, follow the steps below.

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 Metric menu. You will be taken to the Metric page.
3. Check the metrics in the metric list on the Metric page.

Managing Metric Charts

You can add metric monitoring result charts as widgets or manage data.

Adding as Widget

You can add selected metrics as widgets to 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 Metric menu. You will be taken to the Metric page.

3. Select the metric to monitor in the metric list on the Metric page. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.

4. Set the chart area in the monitoring chart in the Selected Metric area, then click the More > Add Widget button. The Add Widget popup window opens.

5. Select the widget addition method and enter the required information. Required information varies depending on the addition method.

   Category	Required	Description
   Duplication Method	Required	Select the dashboard to add after duplicating the widget Existing Dashboard: Add widget to existing dashboard New Dashboard: Create a new dashboard and add widget
   Dashboard Selection	Required	Select the dashboard to add the duplicated widget among existing dashboards Displayed when duplication method is selected as Existing Dashboard
   Dashboard Name	Required	Enter the name of the dashboard to be newly created Displayed when duplication method is selected as New Dashboard Enter within 3 ~ 40 characters using English, numbers, and special characters (-_)
   Widget Name	Required	Enter the name of the widget when adding the widget to the dashboard Enter within 3 ~ 255 characters using English, numbers, and special characters (-_.|)

   Table. Add Widget Items

6. After entering the required information, click the Complete button. A popup window announcing the widget addition opens.

7. Click the Confirm button in the popup window. The widget is added to the dashboard.

Sharing Monitoring Chart URL

You can download monitoring chart information in file format. To download monitoring chart information, follow the steps below.

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 Metric menu. You will be taken to the Metric page.
3. Select the metric to monitor in the metric list on the Metric page. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. Set the chart area in the monitoring chart in the Selected Metric area, then click the More > Share URL button. The Share URL popup window opens.
5. Click the Copy URL button in the Share URL popup window. The generated URL is copied.
   • Information in the monitoring chart is provided in the form of a metadata link.

Downloading Monitoring Chart File

You can download monitoring chart information in file format. To download monitoring chart information, follow the steps below.

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 Metric menu. You will be taken to the Metric page.
3. Select the metric to monitor in the metric list on the Metric page. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. Set the chart area in the monitoring chart in the Selected Metric area, then click the More > Download File button. The Download File popup window opens.
5. Select the file download method, then click the Confirm button. Download starts.
   • You can select download methods simultaneously.

     Category	Description
     CSV	Convert chart metrics and monitoring data to Excel (*.csv) files and download
     PNG	Convert chart to image (*.png) files and download Can only be selected when metric comparison mode is selected as Metric Comparison Can download up to 100 metric data

     Table. Metric Monitoring File Download Items

Exporting to Object Storage

You can save monitoring chart data to Object Storage.

To save monitoring chart data to Object Storage, follow the steps below.

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 Metric menu. You will be taken to the Metric page.
3. Select the metric to monitor in the metric list on the Metric page. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. Set the chart area in the monitoring chart in the Selected Metric area, then click the More > Export to Object Storage button. The Export to Object Storage popup window opens.
5. Select the bucket to save data, then click the Complete button. A popup window announcing data saving opens.
6. Click the Confirm button in the popup window. Data export starts.

Viewing Monitoring Chart Source

You can view the source code of the monitoring chart.

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 Metric menu. You will be taken to the Metric page.
3. Select the metric to monitor in the metric list on the Metric page. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. Set the chart area in the monitoring chart in the Selected Metric area, then click the More > View Source button. The View Widget Source popup window opens.

   Category	Description
   Source Information	Display source code of monitoring chart in JSON format
   Copy Code	Copy source code to clipboard

   Table. Monitoring Chart View Source Items

4 - Logs

In ServiceWatch, you can create and manage log groups to generate alert notifications when set conditions are met by setting threshold criteria for metrics to monitor.

Creating a Log Group

You can create a log group for metrics. Follow these steps to create a log group.

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 Create Log Group button. You will be taken to the Create Log Group page.

4. Enter the basic information and tag information required to create a log group.

   Division	Required	Detailed Description
   Log Group Name	Required	Enter the name of the log group to monitor in ServiceWatch Enter within 3 to 512 characters using English letters, numbers, and special characters (-_./#)
   Log Retention Policy	Required	Select the period to retain monitored log data
   Tag	Optional	Add tag information You can add up to 50 tags per resource When adding a tag, after entering Key and Value values, you can select from the list of existing tag Keys and Values

   Table. Create Log Group Items

5. After checking the summary information, click the Create button. A popup window will open announcing the log group creation.

6. Click the Confirm button. The log group creation is complete.

Viewing Log Group Detailed Information

You can view and manage detailed information about log groups.

Follow these steps to view detailed information about log groups.

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.

   Division	Detailed Description
   Log Group Status	Status of the log group Active: Log group is activated Inactive: Log group is deactivated
   Export Log Group	Save log data of the log group to Object Storage For details on log group export, refer to Exporting Log Group
   Delete Log Group	Delete the corresponding log group
   Information Division Tab	Information division tabs for the log group Detailed information, Log Streams, Tags, Operation History Click each tab to view the corresponding information

   Table. Log Group Detail Items

   Reference

   On the Log Group List page, you can export data by clicking the More > Export Log Group button of the log group to save to Object Storage.

Detailed Information

You can view basic information and log group information for the log group selected on the Log Group List page.

Log Streams

You can view log streams for the log group selected on the Log Group List page.

Log Patterns

You can view log patterns for the log group selected on the Log Group List page.

Tags

You can view tag information for the log group selected on the Log Group List page, and add, modify, or delete them.

Operation History

You can view the operation history of the log group selected on the Log Group List page.

Managing Log Streams

You can create and manage log streams.

Creating a Log Stream

You can create a new log stream in a log group. Follow these steps to create a log stream.

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 create a log stream. 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. Click the Create Log Stream button. The Create Log Stream popup window will open.
6. After entering the Log Stream Name, click the Create button. The log stream creation is complete.
   • Enter the name within 3 to 512 characters using English letters and numbers.

Viewing Log Stream Detailed Information

You can view and manage detailed information about log streams. Follow these steps to view detailed information about log streams.

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.

   Division	Detailed Description
   Excel Download	Download log stream history as an Excel file
   Timestamp List	Message list by timestamp Can filter using Period Selection, User Time Zone, and message input

   Table. Log Group Detail - Log Stream Detail Items

   Reference

   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.

Deleting a Log Stream

You can delete unused log streams. Follow these steps to delete a log stream.

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 delete a log stream. 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, select the checkbox of the log stream to delete and click the More > Delete button. A popup window will open announcing the log stream deletion.
   • You can delete multiple log streams at the same time.
   • You can also delete individually by clicking the Delete button at the right end of each log stream.
6. Click the Confirm button. The log stream is deleted.

Managing Log Patterns

Creating a Log Pattern

Follow these steps to create a log pattern.

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 create a log pattern. You will be taken to the Log Group Detail page.

4. On the Log Group Detail page, click the Log Pattern tab. The log pattern list is displayed.

5. Click the Create Log Pattern button. You will be taken to the Create Log Pattern page.

6. Set the basic information and metric information required to create a log group.

   • Enter and select basic information for the log pattern in the Basic Information area.

     Division	Required	Detailed Description
     Log Pattern Name	Required	Enter the name of the log pattern Enter within 3 to 512 characters using English letters, numbers, and special characters (-_./#)
     Pattern Format	Required	Select or directly enter the pattern format Pattern Format: Select one of string pattern, space-separated pattern, JSON format pattern provided as pattern format Direct Input: After selecting one of string pattern, space-separated pattern, JSON format pattern, enter within 1 to 1,024
     Pattern Test	Optional	Directly enter or select log data to verify using the pattern Direct Input: Directly enter the log data to use in Log Event Message Separate log events using line breaks Can enter up to 50 log events Can enter within 1 to 1,024 bytes for one log event Select log data: Select the log data to use When selecting log data, the corresponding log data is displayed in Log Event Message Test Pattern: Perform test on log event message When test succeeds, test result is displayed at the bottom

     Table. Create Log Pattern - Basic Information Items
   • Enter and select metric information in the Metric Information area.

     Division	Required	Detailed Description
     Namespace	Required	Select the namespace for the log pattern If there is no namespace for the log pattern, select Create New to create a new one Namespace Name: When creating a new namespace, enter within 3 to 128 characters using English letters, numbers, spaces, and special characters (-_\/#)
     Metric Name	Required	Enter the name of the metric Enter within 3 to 128 characters using English letters, numbers, and special characters (_)
     Metric Value	Required	Enter the metric value Enter a number of 0 or higher or $indetifier
     Default Value	Optional	Enter if using the default value Enter as a float value of 0 or higher Cannot use Dimension when using default value
     Unit	Required	Select the metric unit
     Dimension	Optional	Set the dimension of the metric created by the log pattern Can be used only when Log Pattern Format is space-separated pattern or JSON format pattern Cannot be used when entering Default Value When you check Use, you can add custom dimension fields After clicking the Add button, enter Field Name and Field Value to add Can add up to 3

     Table. Create Log Pattern - Metric Information Items

7. After checking the summary information, click the Create button. A popup window will open announcing the log pattern creation.

8. Click the Confirm button. The log pattern creation is complete.

Viewing Log Pattern Detailed Information

Follow these steps to view detailed information about a log pattern.

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 Pattern tab. The log pattern list is displayed.
5. On the Log Pattern list, click the log pattern name for which you want to view detailed information. You will be taken to the Log Pattern Detail page.

   Division	Detailed Description
   Create Alert Policy	Can create alert policy Click the button to go to the alert policy creation page
   Delete Log Pattern	Delete the log pattern currently being viewed
   Log Pattern Name	Log pattern name
   Creator	User who created the log pattern
   Created Date	Date and time when the log pattern was created
   Modifier	User who modified the log pattern information
   Modified Date	Date and time when the log pattern information was modified
   Pattern	Pattern format
   Metric Information	Metric information of the pattern group Namespace name, metric name, metric value, default value, unit, alert policy name, dimension name Click the Edit button to modify Metric Value, Default Value, Unit information

   Table. Log Pattern Detail Items

Deleting a Log Pattern

Follow these steps to delete a log pattern.

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 delete a log pattern. You will be taken to the Log Group Detail page.
4. On the Log Group Detail page, click the Log Pattern tab. The log pattern list is displayed.
5. On the log pattern list, select the checkbox of the log pattern to delete and click the Delete button. A popup window will open announcing the log pattern deletion.
   • You can delete multiple log patterns at the same time.
   • You can also delete individually by clicking the More > Delete button at the right end of each log pattern or by clicking the Delete Log Pattern button on the log pattern detail page.
6. Click the Confirm button. The log pattern is deleted.

Exporting Log Group

You can save log group data to Object Storage. Follow these steps to save log group data to Object Storage.

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 > Export Log Group menu. You will be taken to the Export Log Group List page.

3. On the Export Log Group List page, click the Export Log Group button. You will be taken to the Export Log Group page.

   Division	Required	Detailed Description
   Select Log Group	Required	Select the log group to save to Object Storage If there are log streams included in the log group, click the Select button to select the log streams to save If you do not select a log group, all data of the log group is saved
   Select Period	Optional	Select the user time zone and data storage interval For the data storage interval, you can select the desired interval in the Time Setting area or click the Direct Input button to set the start and end date and time
   Storage Bucket	Required	Select the bucket to save data You can add up to 50 tags per resource When adding a tag, after entering Key and Value values, you can select from the list of existing tag Keys and Values

   Table. Export Log Group Items

4. After selecting the bucket to save the data, click the Done button. A popup window will open announcing the data save.

5. Click the Confirm button in the popup window. The data export will start.

   • You can check the progress on the Export Log Group List page.

Deleting a Log Group

You can delete unused log groups.

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, select the checkbox of the log group to delete and click the Delete button. A popup window will open announcing the log group deletion.
   • You can delete multiple log groups at the same time.
   • You can also delete individually by clicking the Delete button at the right end of each log group or by clicking the Delete Log Group button on the corresponding Log Group Detail page.
4. Click the Confirm button. The log group is deleted.

5 - Events

In ServiceWatch, you can view and handle events generated from Samsung Cloud Platform services.

Creating an Event Rule

You can create an event rule to receive notifications when an event occurs. Follow these steps to create an event rule.

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 Event Rule menu. You will be taken to the Event Rule List page.

3. On the Event Rule List page, click the Create Event Rule button. You will be taken to the Create Event Rule page.

4. In the Enter Basic Information area, enter the name and description of the event rule.

5. In the Set Event Pattern area, set the required information. The set event pattern is entered in JSON code format in the Event Pattern Setting Status.

   Division	Required	Detailed Description
   Event Source	Required	Select the service name of the event you want to receive in ServiceWatch Refer to Event Source for the event source list
   Event Type	Required	Select the event type of the event source to use in the event rule Classified the same as resource type
   Applied Event	Required	Select the events to apply the event pattern among events occurring in the event type All Events: Apply all events occurring in the event type Individual Events: Select events to set as event patterns among events occurring in the event type
   Applied Resource	Required	Select resources to apply the event pattern All Resources: Set event patterns for all events occurring from all resources Individual Resources: Set event patterns for corresponding events occurring from specific resources When selecting individual resources, the event resource selection area is displayed Click the Add Resource button to select resources You can delete added resources by selecting the resource from the resource list and clicking the Delete button
   Event Pattern Setting Status	-	Display converted to JSON code format according to the event pattern setting values Reset when event pattern setting values change You can copy the source code by clicking the Copy Code item

   Table. Event Pattern Setting Items

6. In the Notification Setting area, select users to receive notifications when an event occurs.

   • Only users with login history (users who have registered email and mobile phone number) can be added as notification recipients.
   • You can add up to 100 notification recipients.
     Reference

     • If there is no user to add, you can create a user on the Create User page of the IAM service. For details on user creation, refer to Creating a User.
     • You can change the notification method (E-mail or SMS) by selecting the notification target as Service > Event Rule on the Notification Setting page. For details on notification settings, refer to Checking Notification Settings.

7. In the Enter Additional Information area, add tag information.

8. After checking the summary information, click the Create button. A popup window will open announcing the event rule creation.

9. Click the Confirm button. The event rule creation is complete.

Viewing Event Rule Detailed Information

You can view and manage detailed information about event rules. Follow these steps to view detailed information about event rules.

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 Event Rule menu. You will be taken to the Event Rule List page.
3. On the Event Rule List page, click the event name for which you want to view detailed information. You will be taken to the Event Rule Detail page.

   Division	Detailed Description
   Event Rule Status	Status of the event rule Active: Event rule is activated Inactive: Event rule is deactivated Can be changed by clicking the Activate or Deactivate button
   Delete Event Rule	Delete the corresponding event rule
   Information Division Tab	Information division tabs for the alert policy Detailed information, Notifications, Tags, Operation History Click each tab to view the corresponding information

   Table. Event Rule Detail Items

Detailed Information

You can view basic information and event rule information for the event rule selected on the Event Rule List page.

Notifications

You can view notification recipients for the event rule selected on the Event Rule List page.

Tags

You can view tag information for the event rule selected on the Event Rule page, and add, modify, or delete them.

Operation History

You can view the operation history of the event rule selected on the Alert Policy List page.

Modifying Event Pattern

You can modify the event pattern. Follow these steps to modify the event pattern.

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 Event Rule menu. You will be taken to the Event Rule List page.
3. On the Event Rule List page, click the event name for which you want to modify the event pattern. You will be taken to the Event Rule Detail page.
4. Click the Edit button in the Event Pattern Setting Status on the Event Rule Detail page. The Edit Event Pattern popup window will open.
5. After modifying the event pattern settings, click the Confirm button. A popup window will open announcing the event pattern modification.
   • For details on event pattern modification items, refer to Creating an Event Rule.
6. Click the Confirm button. The event pattern modification is complete.

Deleting an Event Rule

You can delete unused event rules. Follow these steps to delete an event rule.

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 Event Rule menu. You will be taken to the Event Rule List page.
3. On the Event Rule List page, select the checkbox of the event rule to delete and click the Delete button. A popup window will open announcing the event rule deletion.
   • You can delete multiple event rules at the same time.
   • You can also delete individually by clicking the More > Delete button at the right end of each alert policy or by clicking the Delete Event Rule button on the corresponding Event Rule Detail page.
4. Click the Confirm button. The event rule is deleted.

6 - Using ServiceWatch Agent

Users can install ServiceWatch Agent on Virtual Server/GPU Server/Bare Metal Server, etc. to collect custom metrics and logs.

ServiceWatch Agent

The agents that need to be installed on a server for custom metric and log collection of ServiceWatch can be largely divided into two types. Prometheus Exporter and Open Telemetry Collector.

Pre-environment Configuration for ServiceWatch Agent

You must add Security Group and Firewall rules for communication between ServiceWatch Agent and ServiceWatch.

1. Adding Security Group Rules

   • To send data collected from ServiceWatch Agent installed on Virtual Server/GPU Server to ServiceWatch, you must add rules to the Security Group as follows.

     Direction	Type	Port	Destination Address
     Outbound	Custom TCP	443	ServiceWatch OpenAPI Endpoint IP Address

     Table. Security Group Rules for ServiceWatch Agent Communication

2. Adding Firewall Rules

   • If firewall is enabled on the Internet Gateway of the VPC, you must add Firewall rules as follows.

     Direction	Type	Port	Action	Source Address	Destination Address
     Outbound	TCP	443	Allow	Private IP address assigned when creating Virtual Server. Virtual Server Private IP address can be checked in Checking Virtual Server Details.	ServiceWatch OpenAPI Endpoint IP Address

     Table. Internet Gateway Firewall Rules for ServiceWatch Agent Communication

ServiceWatch OpenAPI Endpoint IP Address

The Endpoint IP address required for ServiceWatch Agent to send collected data to ServiceWatch is as follows.

Configuring Open Telemetry Collector for ServiceWatch

To use Open Telemetry Collector for ServiceWatch metric and log collection on a server, install it in the following order.

1. Download the Agent file from the URL where you can download the Agent file for ServiceWatch.

   Guide

   The file download link for ServiceWatch Agent installation will be provided through Samsung Cloud Platform Console announcements and Support Center > Contact Us.
   Sample Code Download

   Copy Code

   Color mode

   wget [ServiceWatch Agent File Download URL]

   wget [ServiceWatch Agent File Download URL]

2. The Open Telemetry Collector Agent file for ServiceWatch can be checked as follows.

   • Extract the Agent file for ServiceWatch.
     Sample Code Download

     Copy Code

     Color mode

     unzip ServiceWatch_Agent.zip

     unzip ServiceWatch_Agent.zip

   • If the environment using ServiceWatch Agent is Linux OS, you must grant execution permissions as follows.
     Sample Code Download

     Copy Code

     Color mode

     chmod +x agent/otelcontribcol_linux_amd64
     chmod +x agent/servicewatch-agent-manager-linux-amd64

     chmod +x agent/otelcontribcol_linux_amd64
     chmod +x agent/servicewatch-agent-manager-linux-amd64

     Category	Description
     examples	Example configuration file folder. Inside each folder, there are agent.json, log.json, metric.json example files os-metrics-min-examples: Minimum metric setting example using Node Exporter os-metrics-all-examples: Metric setting example using Node Exporter memory/filesystem Collector gpu-metrics-min-examples: Minimum metric setting example using DCGM Exporter gpu-metrics-all-examples: Key metric setting example using DCGM Exporter
     otelcontribcol_linux_amd64	Open Telemetry Collector for Linux for ServiceWatch
     otelcontribcol_windows_amd64.exe	Open Telemetry Collector for Windows for ServiceWatch
     servicewatch-agent-manager-linux-amd64	ServiceWatch Agent Manager for Linux
     servicewatch-agent-manager-windows-amd64.exe	ServiceWatch Agent Manager for Windows

     Table. ServiceWatch Agent File Configuration

3. Define the Agent configuration file of ServiceWatch Agent Manager for the Open Telemetry Collector for ServiceWatch.

   Category	Description
   namespace	Custom namespace for custom metrics Namespace is a logical division used to classify and group metrics, and is specified as a custom metric to classify custom metrics Namespace must be 3~128 characters including English, numbers, spaces, and special characters (_-/), and must start with English.
   accessKey	IAM authentication key Access Key
   accessSecret	IAM authentication key Secret Key
   resourceId	Resource ID of the server in Samsung Cloud Platform Example: Resource ID of Virtual Server
   openApiEndpoint	ServiceWatch OpenAPI Endpoint by region/offering Example: https://servicewatch.region.offering.samsungsdscloud.com region and offering information can be checked from Samsung Cloud Platform Console access URL
   telemetryPort	Telemetry Port of ServiceWatch Agent Usually uses 8888 Port. If 8888 Port is in use, it needs to be changed

   Table. agent.json Configuration File Items
   Sample Code Download

   Copy Code

   Color mode

   {
       "namespace": "swagent-windows",     # Custom namespace for custom metrics
       "accessKey": "testKey",             # IAM authentication key Access Key
       "accessSecret": "testSecret",       # IAM authentication key Secret Key
       "resourceId": "resourceID",         # Resource ID of the server in Samsung Cloud Platform
       "openApiEndpoint": "https://servicewatch.kr-west1.e.samsungsdscloud.com",    # ServiceWatch OpenAPI Endpoint by region/environment
       "telemetryPort": 8889               # Telemetry Port of ServiceWatch Agent (Usually uses 8888 Port. If 8888 Port is in use, it needs to be changed)
   }

   {
       "namespace": "swagent-windows",     # Custom namespace for custom metrics
       "accessKey": "testKey",             # IAM authentication key Access Key
       "accessSecret": "testSecret",       # IAM authentication key Secret Key
       "resourceId": "resourceID",         # Resource ID of the server in Samsung Cloud Platform
       "openApiEndpoint": "https://servicewatch.kr-west1.e.samsungsdscloud.com",    # ServiceWatch OpenAPI Endpoint by region/environment
       "telemetryPort": 8889               # Telemetry Port of ServiceWatch Agent (Usually uses 8888 Port. If 8888 Port is in use, it needs to be changed)
   }

4. Define the Metric configuration file for metric collection for ServiceWatch.

   • If you want to collect metrics through the Agent, configure metric.json.

     Category	Description
     prometheus > scrape_configs > targets	Endpoint of the metric collection target In the case of a server, since Prometheus Exporter is installed on the same server, set it to that endpoint Example: localhost:9100
     prometheus > scrape_configs > jobName	Job Name setting. Usually set to the Prometheus Exporter type used when collecting metrics Example: node-exporter
     metricMetas > metricName	Set the name of the metric you want to collect. The metric name must be 3~128 characters including English, numbers, and special characters (_), and must start with English. Example: node_cpu_seconds_total
     metricMetas > dimensions	Set the label to visualize and display in the Console among the Collector’s labels provided to identify the source of the Exporter’s metric data. When displaying the collected metric in the Console, it is displayed by combining according to the dimensions setting. Example: In the case of metrics like the Memory Collector of Node Exporter that do not provide special labels, set it to resource_id Example: Node Exporter Filesystem Collector metrics can set dimensions to mountpoint, which represents the path where the filesystem is mounted on the system
     metricMetas > unit	Can set the unit of the metric Example: Bytes, Count, etc.
     metricMetas > aggregationMethod	Method of aggregating based on the specified dimensions Example: Select from SUM, MAX, MIN, COUNT
     metricMetas > descriptionKo	Korean description of the metric being collected
     metricMetas > descriptionEn	English description of the metric being collected

     Table. metric.json Configuration File Items
     Sample Code Download

     Copy Code

     Color mode

     {
         "prometheus": {
            "scrape_configs": {
               "targets": [
                  "localhost:9100" # Endpoint of Prometheus Exporter installed in the server
               ],
               "jobName": "node-exporter" # Usually set to the name of the installed Exporter
            }
         },
         "metricMetas": [
            {
               "metricName": "node_memory_MemTotal_bytes",    # Set the metric name to be linked to ServiceWatch among metrics collected from Prometheus Exporter
               "dimensions": [
                  [
                     "resource_id"        # Set the label to visualize and display in the Console among the Collector's labels provided to identify the source of Node Exporter's metric data
                                          # In the case of metrics like Memory that do not provide special labels, set it to resource_id
                  ]
               ],
               "unit": "Bytes",           # Unit of collected metric data
               "aggregationMethod": "SUM",    # Aggregation method
               "descriptionKo": "Total physical memory size of the server",    # Korean description of the metric
               "descriptionEn": "node memory total bytes"      # English description of the metric
            },
            {
               "metricName": "node_filesystem_size_bytes",    # Set the metric name to be linked to ServiceWatch among metrics collected from Prometheus Exporter
               "dimensions": [
                  [
                     "mountpoint"        # Set the label to visualize and display in the Console among the Collector's labels provided to identify the source of Node Exporter's metric data
                                         # Set dimensions to mountpoint, which represents the path where the filesystem is mounted on the system for Filesystem-related metrics
                  ]
               ],
               "unit": "Bytes",
               "aggregationMethod": "SUM",
               "descriptionKo": "node filesystem size bytes",
               "descriptionEn": "node filesystem size bytes"
            },
            {
               "metricName": "node_memory_MemAvailable_bytes",
               "dimensions": [
                  [
                     "resource_id"
                  ]
               ],
               "unit": "Bytes",
               "aggregationMethod": "SUM",
               "descriptionKo": "node memory available bytes",
               "descriptionEn": "node memory available bytes"
            },
            {
               "metricName": "node_filesystem_avail_bytes",
               "dimensions": [
                  [
                     "mountpoint"
                  ]
               ],
               "unit": "Bytes",
               "aggregationMethod": "SUM",
               "descriptionKo": "node filesystem available bytes",
               "descriptionEn": "node filesystem available bytes"
            }
         ]
     }

     {
         "prometheus": {
            "scrape_configs": {
               "targets": [
                  "localhost:9100" # Endpoint of Prometheus Exporter installed in the server
               ],
               "jobName": "node-exporter" # Usually set to the name of the installed Exporter
            }
         },
         "metricMetas": [
            {
               "metricName": "node_memory_MemTotal_bytes",    # Set the metric name to be linked to ServiceWatch among metrics collected from Prometheus Exporter
               "dimensions": [
                  [
                     "resource_id"        # Set the label to visualize and display in the Console among the Collector's labels provided to identify the source of Node Exporter's metric data
                                          # In the case of metrics like Memory that do not provide special labels, set it to resource_id
                  ]
               ],
               "unit": "Bytes",           # Unit of collected metric data
               "aggregationMethod": "SUM",    # Aggregation method
               "descriptionKo": "Total physical memory size of the server",    # Korean description of the metric
               "descriptionEn": "node memory total bytes"      # English description of the metric
            },
            {
               "metricName": "node_filesystem_size_bytes",    # Set the metric name to be linked to ServiceWatch among metrics collected from Prometheus Exporter
               "dimensions": [
                  [
                     "mountpoint"        # Set the label to visualize and display in the Console among the Collector's labels provided to identify the source of Node Exporter's metric data
                                         # Set dimensions to mountpoint, which represents the path where the filesystem is mounted on the system for Filesystem-related metrics
                  ]
               ],
               "unit": "Bytes",
               "aggregationMethod": "SUM",
               "descriptionKo": "node filesystem size bytes",
               "descriptionEn": "node filesystem size bytes"
            },
            {
               "metricName": "node_memory_MemAvailable_bytes",
               "dimensions": [
                  [
                     "resource_id"
                  ]
               ],
               "unit": "Bytes",
               "aggregationMethod": "SUM",
               "descriptionKo": "node memory available bytes",
               "descriptionEn": "node memory available bytes"
            },
            {
               "metricName": "node_filesystem_avail_bytes",
               "dimensions": [
                  [
                     "mountpoint"
                  ]
               ],
               "unit": "Bytes",
               "aggregationMethod": "SUM",
               "descriptionKo": "node filesystem available bytes",
               "descriptionEn": "node filesystem available bytes"
            }
         ]
     }

   • To display the resource name, set resource_name in commonLabels as follows and also set resource_name in metricMetas.dimensions, so you can check the resource name together when viewing metrics in ServiceWatch.
     Sample Code Download

     Copy Code

     Color mode

     ...
         "commonLabels": {
            "resource_name": "ResourceName" # Resource name that can be checked in User Console
         },
         "metricMetas": [
            {
               "metricName": "metric_name",
               "dimensions": [
                  [
                     "resource_id",
                     "resource_name"        # Add the resource_name set in commonLabels to each metric's dimensions
     
                  ]
               ],
               "unit": "Bytes",
               "aggregationMethod": "SUM",
               "descriptionKo": "metric_name description"
               "descriptionEn": "metric_name description"
            },
         ...
         ]
     ...

     ...
         "commonLabels": {
            "resource_name": "ResourceName" # Resource name that can be checked in User Console
         },
         "metricMetas": [
            {
               "metricName": "metric_name",
               "dimensions": [
                  [
                     "resource_id",
                     "resource_name"        # Add the resource_name set in commonLabels to each metric's dimensions
     
                  ]
               ],
               "unit": "Bytes",
               "aggregationMethod": "SUM",
               "descriptionKo": "metric_name description"
               "descriptionEn": "metric_name description"
            },
         ...
         ]
     ...

5. Define the Log configuration file for log collection for ServiceWatch.

   • If you want to collect logs, you must configure log.json.

     Category	Description
     fileLog > include	Location of log files to collect
     fileLog > operators	Defined to parse log messages to collect
     fileLog > operators > regex	Express log message format as regular expression
     fileLog > operators > timestamp	Format of Time Stamp of log message to be sent to ServiceWatch
     logMetas > log_group_value	Log group name created to send logs to ServiceWatch
     logMetas > log_stream_value	Log stream name in ServiceWatch log group

     Table. log.json Configuration File Items
     Sample Code Download

     Copy Code

     Color mode

     {
         "fileLog": {
            "include": [
               "/var/log/syslog",        # Log file to collect in ServiceWatch
               "/var/log/auth.log"
            ],
            "operators": {
               "regex": "^(?P<timestamp>\\S+)\\s+(?P<hostname>\\S+)\\s+(?P<process>[^:]+):\\s+(?P<message>.*)$",    # Express log file format as regular expression
               "timestamp": {            # Set Time Stamp format of log message
                  "layout_type": "gotime",
                  "layout": "2006-01-02T15:04:05.000000Z07:00"
               }
            }
         },
         "logMetas": {
            "log_group_value": "custom-log-group",    # Log group name of ServiceWatch created in advance
            "log_stream_value": "custom-log-stream"   # Log stream name in ServiceWatch log group created in advance
         }
     }

     {
         "fileLog": {
            "include": [
               "/var/log/syslog",        # Log file to collect in ServiceWatch
               "/var/log/auth.log"
            ],
            "operators": {
               "regex": "^(?P<timestamp>\\S+)\\s+(?P<hostname>\\S+)\\s+(?P<process>[^:]+):\\s+(?P<message>.*)$",    # Express log file format as regular expression
               "timestamp": {            # Set Time Stamp format of log message
                  "layout_type": "gotime",
                  "layout": "2006-01-02T15:04:05.000000Z07:00"
               }
            }
         },
         "logMetas": {
            "log_group_value": "custom-log-group",    # Log group name of ServiceWatch created in advance
            "log_stream_value": "custom-log-stream"   # Log stream name in ServiceWatch log group created in advance
         }
     }

     Note

     To link server log files to ServiceWatch through ServiceWatch Agent, you must first create a log group and log streams within the log group.

     • For more information about creating log groups and log streams, see Logs.

Running Open Telemetry Collector for ServiceWatch

Running ServiceWatch Agent (for Linux)

1. Run ServiceWatch Agent.

   • Check the location of agent.json, metric.json, log.json files and the location of servicewatch-agent-manager-linux-amd64, otelcontribcol_linux_amd64 files and start ServiceWatch Agent.
     Sample Code Download

     Copy Code

     Color mode

     ./agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64

     ./agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64

   • If you want to collect only metrics, rename the log.json file to a different file name or move it so it’s not in the same directory as agent.json, metric.json, and execute as follows.
     Sample Code Download

     Copy Code

     Color mode

     ./agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64

     ./agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64

   • If you want to collect only logs, rename the metric.json file to a different file name or move it so it’s not in the same directory as agent.json, log.json, and execute as follows.
     Sample Code Download

     Copy Code

     Color mode

     ./agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64

     ./agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64

2. Stop ServiceWatch Agent.

   Sample Code Download

   Copy Code

   Color mode

   ./agent/servicewatch-agent-manager-linux-amd64 -action stop -dir ./agent/examples/os-metrics-min-examples

   ./agent/servicewatch-agent-manager-linux-amd64 -action stop -dir ./agent/examples/os-metrics-min-examples

Running ServiceWatch Agent (for Windows)

1. Run ServiceWatch Agent.

   Sample Code Download

   Copy Code

   Color mode

   servicewatch-agent-manager-windows-amd64.exe -action run -dir ./examples -collector otelcontribcol_windows_amd64.exe

   servicewatch-agent-manager-windows-amd64.exe -action run -dir ./examples -collector otelcontribcol_windows_amd64.exe

2. Stop ServiceWatch Agent.

   Sample Code Download

   Copy Code

   Color mode

   servicewatch-agent-manager-windows-amd64.exe -action stop -dir ./examples

   servicewatch-agent-manager-windows-amd64.exe -action stop -dir ./examples