How-to guides

• 1: Managing Dashboard and Widgets
• 2: Alert
• 3: Metric
• 4: Log
• 5: Event
• 6: ServiceWatch Agent Using

1 - Managing Dashboard and Widgets

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

Creating a dashboard

You can create a dashboard of ServiceWatch.

To create a dashboard, follow the next procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
3. Dashboard List page, click the Create Dashboard button.
4. Please enter the name of the dashboard.

• The name of the dashboard should be entered within 34 characters using English, numbers, and special characters (-_).

5. Add a widget to compose the dashboard. A corresponding popup window opens according to the method of adding a widget.

• Add individual widgets: You can add a single widget combined with metrics and resources. When you click the button, the Add individual widgets popup window opens.

• Multiple Widget Addition: You can add multiple widgets at once by selecting the desired resources by metric unit. When you click the button, the Multiple Widget Addition popup window opens.

• Dashboard Import: You can import widgets from the dashboard registered in ServiceWatch. When you click the button, the Dashboard Import popup window opens.

5. Click the Complete button on the widget add popup window. The widget will be added to the dashboard on the dashboard creation page.
6. After checking the added widget, click the Complete button. A pop-up window announcing the creation of the dashboard will open.
7. Confirm button should be clicked. Dashboard creation will be completed.

Check the dashboard

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

To check the dashboard, follow the next procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.

Managing Dashboard

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

Modifying the dashboard

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

To modify the dashboard, follow the following procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
4. Dashboard Details page’s top right Edit button is clicked. It moves to the Dashboard Edit page.
5. After modifying the information or widgets on the dashboard, click the Save button.

   Classification	Detailed Description
   Dashboard Name	The name of the dashboard can be modified Enter within 3~40 characters using English, numbers, and special characters (-_) Cannot use the existing registered dashboard name
   Widget Name	Widget Name Editable Use English, numbers, spaces, and special characters (-_.|) to enter within 3 ~ 255 characters
   Widget Management	When the mouse cursor is placed on the widget, the management button is displayed on the right side of the widget border Edit: Widget modification is possible in the Widget Edit popup window, where you can modify the widget’s metrics and resources For more information on widget editing, see Individual Widget Editing in Widget Management Duplicate: Duplicate the current widget and add it to the dashboard Delete: Delete the current widget from the dashboard Expand: Expand the size of the current widget to display Shrink: If expanded, clicking again will shrink the widget size
   Add Widget	Add a new widget to the dashboard Add Individual Widget: Add a single widget combined with metrics and resources Add Multiple Widgets: Select the desired resources by metric unit to add multiple widgets at once Load Dashboard: Load widgets from other dashboards and add them For more information on how to add widgets, see Create a Widget

   Table. Dashboard Modification Items

Check detailed dashboard information

You can check detailed information about the dashboard.

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

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. It moves to the Dashboard List page.
3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
4. Dashboard Details page’s upper right corner More > Details button click. Dashboard Details popup window opens.

Check the dashboard source code

You can check the source code of the dashboard.

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

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. It moves to the Dashboard List page.
3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
4. Dashboard Details page’s upper right corner click the More > View Source button. Dashboard Source View popup window opens.

Dashboard duplication

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

To replicate the dashboard, follow the following procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. It moves to the Dashboard List page.
3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
4. Dashboard Details page’s upper right corner More > Duplicate button, click. Dashboard Duplicate popup window opens.
5. Select the dashboard replication method and enter the required information. The required information varies depending on the replication method.

6. When the essential information input is complete, click the completed button. A popup window announcing the dashboard replication will open.
7. Click the Confirm button on the popup window. The dashboard replication task will be completed.

Delete Dashboard

You can delete the dashboard that is not used.

To delete the dashboard, follow the following procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
3. Dashboard List page, select the checkbox of the dashboard to be deleted, and then click the Delete button. A popup window announcing the deletion of the dashboard will open.

• You can delete multiple dashboards at the same time.
• Dashboard Details page’s top right corner has More > Delete button to delete individually.

4. Enter delete in the delete confirmation input area, then click the confirm button. The dashboard will be deleted.

Managing widgets

Dashboard Details page where you can modify or manage widgets.

Modifying widgets

You can modify the widget’s metrics and resources.

To modify the widget, follow the following procedure.

1. All services > Management > ServiceWatch menu, click. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
3. Dashboard List page, click the dashboard you want to modify the widget. It moves to the Dashboard Details page.
4. Dashboard Details page, click the More > Edit Widget button located at the top right of the widget you want to modify. The Edit Widget popup window opens.
5. After modifying the widget’s metrics and resources, click the Confirm button. The widget modification will be completed.

Widget duplication

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

To replicate a widget, follow the following procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
3. Dashboard List page, click the dashboard to replicate. It moves to the Dashboard Details page.
4. Dashboard Details page, click the More > Widget Duplicate button located at the top right of the widget to be duplicated. The Widget Duplicate popup window opens.
5. Select the widget replication method and enter the required information. The required information varies depending on the replication method.

6. When the required information input is complete, click the completed button. A popup window announcing the addition of a widget will open.
7. Click the Confirm button on the popup window. The widget will be replicated and added to the corresponding dashboard.

Downloading widget files

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

To download widget information, follow the next procedure.

1. All services > Management > ServiceWatch menu, click. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
3. Dashboard List page, click the dashboard to download widget information. It moves to the Dashboard Details page.
4. Dashboard Details page, click the More > File Download button located at the top right of the widget to download the widget information. The File Download popup window opens.
5. Select the file download method, then click the Confirm button. The download will start.

• The download methods can be selected simultaneously.

Widget Metric Details

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

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

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
3. Dashboard List page, click the dashboard to check the widget metrics. It moves to the Dashboard Details page.
4. Dashboard Details page, click the More > View Metrics button located at the top right of the widget to be checked on the Metrics page. It moves to the Metrics page.

• The resource and metric information of the selected widget is automatically set and displayed on the Metrics page.

Widget source information

You can check the source code of the dashboard.

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

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. Move to the Dashboard List page.
3. Dashboard List page, click the dashboard to check the detailed information. It moves to the Dashboard Details page.
4. Dashboard Details page, click the More > View Source button located at the top right of the widget to check the source code. The Widget Source View popup window opens.

2 - Alert

In ServiceWatch, you can set threshold criteria for the metrics to be monitored, and create and manage alert policies so that an alert notification is generated when the set conditions are met.

Create Alert Policy

You can create an alert policy for a metric and set the alert triggering criteria.

To create an alert policy, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. Go to the Service Home page.
2. Click the Alert > Alert Policy menu on the Service Home page. You will be taken to the Alert Policy List page.
3. Alert Policy List page, click the Create Alert Policy button. It navigates to the Create Alert Policy page.
4. Basic Information Input area, after entering the name and description of the alert policy, click the Select Metric button. The Select Metric popup opens.
5. After selecting the metric to create an alert policy in the Metric Selection popup, click the Confirm button. The Metric and Condition Settings area will be displayed.

6. Indicator and Condition Settings area, set the threshold values for alarm generation.

7. In the Notification Settings area, select the user who will receive notifications when an alarm occurs.
   • Only users with login history (users who have registered email or mobile phone number) can be added as notification recipients.
   • You can add up to 100 notification recipients.

8. In the Add Additional Information area, after adding tag information, click the Complete button. A popup window notifying the creation of the alert policy opens.
9. Confirm 버튼을 클릭하세요. 경보 정책 생성이 완료됩니다.

Check detailed alarm policy information

You can view and manage detailed information about the alarm policy.

To view detailed information about the alert policy, follow the steps below.

1. Click the All Services > Management > ServiceWatch menu. Navigate to the Service Home page.
2. On the Service Home page, click the Alert > Alert Policy menu. It navigates to the Alert Policy List page.

• Click the Alert Stage button displayed in the Alert Policy menu to filter and view only the list of alert policies for that stage.

3. Alert Policy List page, click the alert policy name to view detailed information. You will be taken to the Alert Policy Details page.

Detailed Information

Alarm Policy List page, you can view the basic information and metric information of the selected alarm policy.

Notification

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

Alert History

Alarm Policy List page allows you to view the alarm status change history of the selected alarm policy.

Tag

On the Alert Policy List page, you can view the tag information of the selected alert policy, and you can add, modify, or delete it.

Work History

Alert Policy List page allows you to view the operation history of the selected alert policy.

Edit Alarm Policy

You can modify the target metrics and policy settings of the alert policy.

To modify the alert policy, follow the steps below.

1. Click the All Services > Management > ServiceWatch menu. Go to the Service Home page.
2. Click the Alert > Alert Policy menu on the Service Home page. You will be taken to the Alert Policy List page.
3. Click the alert policy name on the Alert Policy List page to view detailed information. It moves to the Alert Policy Details page.
4. Alarm Policy Details page’s Detailed Information tab, click the Edit button of Metric Information. Edit Metric Information popup opens.
5. After modifying the indicator information and policy settings, click the Confirm button. A popup window notifying the indicator modification will open.
   • For detailed information about metric modification items, please refer to Create Alert Policy.
6. Confirm 버튼을 클릭하세요. 경보 정책 수정이 완료됩니다.

Delete alert policy

You can delete unused alarm policies.

To delete the alert policy, follow these steps.

1. All Services > Management > ServiceWatch Click the menu. Navigate to the Service Home page.
2. Service Home page, click the Alert > Alert Policy menu. Navigate to the Alert Policy List page.
3. Alert Policy List on the page, after selecting the checkbox of the alert policy to delete, click the Delete button. A popup notifying the alert policy deletion will open.
   • You can delete multiple alert policies at the same time.
   • You can also delete individually by clicking the Delete button at the far right of each alert policy, or by clicking the Delete Alert Policy button on the corresponding Alert Policy Details page.
4. Confirm 버튼을 클릭하세요. 경보 정책이 삭제됩니다.

3 - Metric

The user can monitor and manage metrics for service resources in the Samsung Cloud Platform Console.

Check the metric

You can check the metrics available on ServiceWatch.

To check the metrics, follow the next procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the metric menu. It moves to the metric page.
3. Metric page’s metric list, please check the metric.

Managing Metric Charts

You can add the chart of monitoring result metrics as a widget or manage the data.

Add as a widget

To check the metric, follow the next procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the metric menu. It moves to the metric page.
3. Metric page, select the metric to be monitored from the list of metrics. The monitoring chart for the selected metric will be displayed in the Selected Metric area at the bottom.
4. Selected Metric area’s monitoring chart, set the table 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. The required information varies depending on the addition method.

6. When the required information input is complete, click the completed button. A pop-up window announcing the addition of the widget will open.
7. Click the Confirm button on the popup window. A widget will be added to the corresponding dashboard.

Monitoring chart file download

You can download the monitoring chart information in the form of a file.

To download the monitoring chart information, follow the next procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the metric menu. It moves to the metric page.
3. Metric page, select the metrics to be monitored from the metric list. The monitoring chart for the selected metric will be displayed in the Selected Metric area below.
4. Selected metric area’s monitoring chart, set the table area, then click the More > File Download button. The File Download popup window will open.
5. Select the file download method, then click the Confirm button. The download will start.

• The download methods can be selected simultaneously.

Export to Object Storage

You can store monitoring chart data in Object Storage.

To store monitoring chart data in Object Storage, follow the next procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Metrics menu. It moves to the Metrics page.
3. Metric page, select the metric to be monitored from the metric list. The monitoring chart for the selected metric will be displayed in the Selected Metric area at the bottom.
4. Selected metric area’s monitoring chart, set the table area, then click the More > Object Storage Export button. The Object Storage Export popup window will open.
5. After selecting a bucket to store the data, click the Complete button. A popup window announcing data storage will open.
6. Click the Confirm button in the popup window. Data export will begin.

Monitoring chart source view

You can check the source code of the monitoring chart.

To check the source code of the monitoring chart, follow the next procedure.

1. All services > Management > ServiceWatch menu, click. It moves to the Service Home page.
2. Service Home page, click the Metrics menu. It moves to the Metrics page.
3. Metric page, select the metrics to be monitored from the list of metrics. The monitoring chart for the selected metric will be displayed in the Selected Metric area below.
4. Selected Metric area’s monitoring chart, set the table area, then click the More > View Source button. The Widget Source View popup window opens.

4 - Log

ServiceWatch allows you to create and manage log groups to generate alert notifications when the set conditions are met by setting threshold criteria for the metrics to be monitored.

Create a log group

You can create a log group for the metric.

To create a log group, follow these procedures.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Log > Log Group menu. It moves to the Log Group List page.
3. Log Group List page, click the Create Log Group button. Move to the Create Log Group page.
4. Enter the basic information and tag information required for log group creation, and then click the Complete button. A pop-up window announcing the creation of the log group will open.

5. Confirm button will be clicked. Log group creation will be completed.

Log group detailed information check

You can check and manage detailed information about the log group.

To check detailed information about the log group, follow the next procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Log > Log Group menu. It moves to the Log Group List page.
3. Log Group List page, click the log group name to check the detailed information. It moves to the Log Group Details page.

Detailed Information

Log Group List page where you can check the basic information and log group information of the selected log group.

Log Stream

Log Group List page where you can check the log stream of the selected log group.

Tag

Log Group List page where you can check the tag information of the selected log group, and add, change or delete it.

Work History

Log Group List page where you can check the operation history of the selected log group.

Managing log streams

You can create and manage log streams.

Creating a log stream

You can create a new log stream in the log group.

To create a hog stream, follow the next procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Log > Log Group menu. It moves to the Log Group List page.
3. Log Group List page, click the log group name to check the detailed information. It moves to the Log Group Details page.
4. Log Group Details page, click the Log Stream tab. The list of log streams will be displayed.
5. Create Log Stream button, the Create Log Stream popup window opens.
6. Log Stream Name을 입력한 후, Confirm 버튼을 클릭하세요. Log stream creation will be completed.

• The name should be entered within 3 ~ 512 characters using English and numbers.

Log Stream Detailed Information Check

You can check and manage detailed information about the log stream.

To check detailed information about the log stream, follow the next procedure.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Log > Log Group menu. It moves to the Log Group List page.
3. Log Group List page, click the log group name to check the detailed information. It moves to the Log Group Details page.
4. Log Group Details page, click the Log Stream tab. The Log Stream list will be displayed.
5. Log Stream Click the log stream name to check the detailed information in the Log Stream list. It moves to the Log Stream Details page.

• Clicking the All Log Streams Query button at the top of the log stream list will move to the All Log Streams Details page.

  Classification	Detailed Description
  Excel Download	Possible to download log stream history as an Excel file
  Time Stamp List	Message List by Time Stamp Period Selection, User Time Zone, message input can be used for filtering

  Table. Log Group Details - Log Stream Details Item

Deleting log streams

You can delete unused log streams.

To delete a log stream, follow these procedures.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Log > Log Group menu. Move to the Log Group List page.
3. Log Group List page, click the log group name to check the detailed information. It moves to the Log Group Details page.
4. Log Group Details page, click the Log Stream tab. The list of log streams will be displayed.
5. Select the checkbox of the log stream to be deleted from the log stream list, then click the More > Delete button. A popup window notifying log stream deletion will be opened.

• You can delete multiple log streams at the same time.
• You can also delete them individually by clicking the delete button at the far right end of each log stream.

4. Confirm button will be clicked. The log group will be deleted.

Export log group

You can store log group data in Object Storage.

To store log group data in Object Storage, follow these procedures.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Log > Log Group Export menu. It moves to the Log Group Export List page.
3. Log Group Export List page, click the Log Group Export button. Move to the Log Group Export page.

5. After selecting a bucket to store the data, click the Complete button. A pop-up window notifying data storage will open.
6. Click the Confirm button in the popup window. Data export will begin.

• The progress can be checked on the log group export list page.

Delete log group

You can delete unused log groups.

To delete a log group, follow these procedures.

1. All services > Management > ServiceWatch menu is clicked. It moves to the Service Home page.
2. Service Home page, click the Log > Log Group menu. Move to the Log Group List page.
3. Log Group List page, select the checkbox of the log group to be deleted, and then click the Delete button. A popup window announcing the deletion of the log group will open.

• You can delete multiple log groups at the same time.
• You can also delete them individually by clicking the Delete button at the far right of each log group or the Delete Log Group button on the corresponding Log Group Details page.

4. Confirm button will be clicked. The log group will be deleted.

5 - Event

In ServiceWatch, you can check and process events generated by the Samsung Cloud Platform service.

Create Event Rules

You can create event rules to receive notifications when events occur.

To create an event rule, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. Navigate to the Service Home page.
2. Service Home page, click the Event Rules menu. Navigate to the Event Rules List page.
3. Click the Create Event Rule button on the Event Rule List page. You will be taken to the Create Event Rule page.
4. Basic Information Input Enter the name and description of the event rule in the area.
5. Event Pattern Settings Please set the required information in the area. The configured event pattern is entered in JSON code format in Event Pattern Settings Status.

6. Notification Settings Select the user(s) to receive the notification when an event occurs in the area.
   • Only users with login history (users who have registered email or mobile phone number) can be added as notification recipients.
   • Notification recipients can be added up to a maximum of 100.

7. Additional Information Input area, after adding tag information, click the Complete button. A popup notifying the creation of an event rule will open.
8. Click the Confirm button. Event rule creation is complete.

Check detailed event rule information

You can view and manage detailed information about event rules.

Follow the steps below to view detailed information about the event rules.

1. Click the All Services > Management > ServiceWatch menu. Navigate to the Service Home page.
2. Click the Event Rules menu on the Service Home page. Navigate to the Event Rules List page.
3. Event Rules List page, click the event name to view detailed information. You will be taken to the Event Rules Detail page.

Detailed Information

On the Event Rule List page, you can view the basic information and event rule information of the selected event rule.

Notification

You can check the notification recipients of the selected event rule on the Event Rule List page.

Tag

Event Rules page allows you to view the tag information of the selected event rule, and you can add, modify, or delete it.

Work History

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

Edit event pattern

You can modify the event pattern.

To modify the event pattern, follow the steps below.

1. All Services > Management > ServiceWatch Click the menu. Service Home page will be displayed.
2. Service Home page, click the Event Rule menu. Navigate to the Event Rule List page.
3. Event Rule List page, click the event name to edit the event pattern. Event Rule Details page will be opened.
4. Click the Edit button in the Event Pattern Settings on the Event Rule Details page. The Edit Event Pattern popup window opens.
5. After modifying the event pattern settings, click the Confirm button. A popup notifying the event pattern modification will open.
   • For detailed information on event pattern modification items, refer to Create Event Rule.
6. Confirm Click the button. The event pattern modification is complete.

Delete event rules

You can delete unused event rules.

To delete the event rules, follow the steps below.

1. All Services > Management > ServiceWatch Click the menu. Service Home page will be displayed.
2. Click the Event Rules menu on the Service Home page. You will be taken to the Event Rules List page.
3. On the Event Rule List page, after selecting the checkbox of the event rule to delete, click the Delete button. A popup notifying the deletion of the event rule will open.
   • You can delete multiple event rules at the same time.
   • You can also delete individually by clicking the More > Delete button at the far right of each alert policy, or by clicking the Delete Event Rule button on the Event Rule Details page.
4. Confirm Click the button. The event rule will be deleted.

6 - ServiceWatch Agent Using

Users can install the 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 the server for collecting ServiceWatch’s custom metrics and logs can be broadly divided into two types. Prometheus Exporter and Open Telemetry Collector.

Open Telemetry Collector preset for ServiceWatch

Install according to the steps below to use the Open Telemetry Collector for collecting ServiceWatch metrics and logs on the server.

1. Download the Agent file from the URL where the Agent file can be downloaded for ServiceWatch.

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 permission as below.
     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	Detailed description
     examples	Example configuration file folder. Each folder contains example files agent.json, log.json, metric.json os-metrics-min-examples: Example of minimal metric configuration using Node Exporter os-metrics-all-examples: Example of memory/filesystem Collector metric configuration using Node Exporter gpu-metrics-min-examples: Example of minimal metric configuration using DCGM Exporter gpu-metrics-all-examples: Example of major metric configuration 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. Agent file configuration for ServiceWatch

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

   Category	Detailed description
   namespace	Custom namespace for custom metrics A namespace is a logical separation used to distinguish and group metrics, designated as a custom metric to differentiate custom metrics. The namespace must be 3 to 128 characters long, consisting of letters, numbers, spaces, and special characters (_-/), and must start with a letter.
   accessKey	IAM authentication key Access Key
   accessSecret	IAM authentication key Secret Key
   resourceId	Resource ID of the server on Samsung Cloud Platform Example: Resource ID of Virtual Server
   openApiEndpoint	ServiceWatch OpenAPI Endpoint by region/offering Example: https://servicewatch.region.offering.samsungsdscloud.com The region and offering information can be found in the Samsung Cloud Platform Console access URL
   telemetryPort	ServiceWatch Agent’s Telemetry Port Usually uses port 8888. Change required if port 8888 is already in use

   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 on the server's Samsung Cloud Platform
      "openApiEndpoint": "https://servicewatch.kr-west1.e.samsungsdscloud.com",    # Region/Environment-specific ServiceWatch OpenAPI Endpoint
      "telemetryPort": 8889               # ServiceWatch Agent's Telemetry Port (usually uses port 8888. Change if port 8888 is in use)
   "}

   {
      "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 on the server's Samsung Cloud Platform
      "openApiEndpoint": "https://servicewatch.kr-west1.e.samsungsdscloud.com",    # Region/Environment-specific ServiceWatch OpenAPI Endpoint
      "telemetryPort": 8889               # ServiceWatch Agent's Telemetry Port (usually uses port 8888. Change if port 8888 is in use)
   "}

4. Define the metric configuration file for collecting metrics for ServiceWatch.

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

     Category	Detailed description
     prometheus > scrape_configs > targets	Endpoint of metric collection target For a server, install Prometheus Exporter on the same server, so set this endpoint Example: localhost:9100
     prometheus > scrape_configs > jobName	Job Name setting. Usually set to the type of Prometheus Exporter used for metric collection Example: node-exporter
     metricMetas > metricName	Set the name of the metric to be collected. The metric name must be 3 to 128 characters long, including English letters, numbers, and special characters (_), and must start with an English letter. Example: node_cpu_seconds_total
     metricMetas > dimensions	Set the label among the Collector’s labels provided to identify the source of the Exporter’s metric data, for visualizing on the Console. When visualizing the collected metrics on the Console, they are displayed in combinations according to the dimensions setting. Example: If no special label is provided, as with the metrics of Node Exporter’s Memory Collector, set it to resource_id Example: The metrics of Node Exporter’s Filesystem Collector can have the dimension set to mountpoint, which represents the path where the filesystem is mounted on the system
     metricMetas > unit	Metric unit can be set Example: Bytes, Count, etc.
     metricMetas > aggregationMethod	Method of aggregating based on the specified dimension(s) Example: Choose among 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 the Prometheus Exporter installed on 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 with ServiceWatch among the metrics collected from the Prometheus Exporter
              "dimensions": [
                 [
                    "resource_id"        # Set the label for visualizing on the Console among the Collector's labels provided to identify the source of Node Exporter's metric data.
                                         # If there is no special label provided, such as the relevant Memory-related metric, set it to resource_id
                 ]
              ],
              "unit": "bytes",           # Collection metric data unit
              "aggregationMethod": "SUM",    # aggregation method
               "descriptionKo": "Total physical memory size of the server",    # Indicator's Korean description
              "descriptionEn": "node memory total bytes"      # English description of the metric
           },
           {
              "metricName": "node_filesystem_size_bytes",    # Set the metric name to be linked with ServiceWatch among the metrics collected from the Prometheus Exporter
              "dimensions": [
                 [
                    "mountpoint"        # Set the label for visualization on the Console among the Collector's labels provided to identify the source of Node Exporter's metric data.
                                        # Set dimension (dimensions) as mountpoint indicating the path where the filesystem related to the Filesystem metric is mounted on the system
                 ]
              ],
              "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 the Prometheus Exporter installed on 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 with ServiceWatch among the metrics collected from the Prometheus Exporter
              "dimensions": [
                 [
                    "resource_id"        # Set the label for visualizing on the Console among the Collector's labels provided to identify the source of Node Exporter's metric data.
                                         # If there is no special label provided, such as the relevant Memory-related metric, set it to resource_id
                 ]
              ],
              "unit": "bytes",           # Collection metric data unit
              "aggregationMethod": "SUM",    # aggregation method
               "descriptionKo": "Total physical memory size of the server",    # Indicator's Korean description
              "descriptionEn": "node memory total bytes"      # English description of the metric
           },
           {
              "metricName": "node_filesystem_size_bytes",    # Set the metric name to be linked with ServiceWatch among the metrics collected from the Prometheus Exporter
              "dimensions": [
                 [
                    "mountpoint"        # Set the label for visualization on the Console among the Collector's labels provided to identify the source of Node Exporter's metric data.
                                        # Set dimension (dimensions) as mountpoint indicating the path where the filesystem related to the Filesystem metric is mounted on the system
                 ]
              ],
              "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"
           }
        ]
     "}

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

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

     Category	Detailed description
     fileLog > include	Log file location to collect
     fileLog > operators	Definition for parsing log messages to be collected
     fileLog > operators > regex	Express log message format as a regular expression
     fileLog > operators > timestamp	The format of the Time Stamp of the log message to be sent to ServiceWatch
     logMetas > log_group_value	Log group name created to send logs to ServiceWatch
     logMetas > log_stream_value	ServiceWatch log group log stream name

     Table. log.json configuration file items
     Sample Code Download

     Copy Code

     Color mode

     {
        "fileLog": {
           "include": [
              "/var/log/syslog",        # Log file to be collected by ServiceWatch
              "/var/log/auth.log"
           ],
           "operators": {
              "regex": "^(?P<timestamp>\\S+)\\s+(?P<hostname>\\S+)\\s+(?P<process>[^:]+):\\s+(?P<message>.*)$",    # Represent log file format with regex
              "timestamp": {            # Set the format of the log message's Time Stamp
                 "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"   # The log stream name within the pre-created ServiceWatch log group
        }
     }

     {
        "fileLog": {
           "include": [
              "/var/log/syslog",        # Log file to be collected by ServiceWatch
              "/var/log/auth.log"
           ],
           "operators": {
              "regex": "^(?P<timestamp>\\S+)\\s+(?P<hostname>\\S+)\\s+(?P<process>[^:]+):\\s+(?P<message>.*)$",    # Represent log file format with regex
              "timestamp": {            # Set the format of the log message's Time Stamp
                 "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"   # The log stream name within the pre-created ServiceWatch log group
        }
     }

Running Open Telemetry Collector for ServiceWatch

ServiceWatch Agent Execution (for Linux)

1. Run the ServiceWatch Agent.

   • agent.json, metric.json, log.json file locations and servicewatch-agent-manager-linux-amd64,otelcontribcol_linux_amd64 file locations are checked to start the 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 only want to collect metrics, rename the log.json file to a different name or move it so that it is not in a directory such as agent.json, metric.json, and run as below.
     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 only want to collect logs, rename the metric.json file to a different filename or move it so that it is not in the same directory as agent.json, log.json, and then run as shown below.
     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 the 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

ServiceWatch Agent Run (for Windows)

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