ServiceWatch

• 1: Overview
• 1.1: Metric
• 1.2: Alert
• 1.3: Log
• 1.4: Event
• 1.5: ServiceWatch integration service
• 1.6: Custom Metrics and Logs
• 2: How-to guides
• 2.1: Managing Dashboards and Widgets
• 2.2: Alert
• 2.3: indicator
• 2.4: Log
• 2.5: Event
• 2.6: Using ServiceWatch Agent
• 3: API Reference
• 4: CLI Reference
• 5: ServiceWatch Event Reference
• 5.1: ServiceWatch Event
• 5.1.1: Multi-node GPU Cluster
• 5.1.2: MySQL(DBaaS)
• 5.1.3: Global CDN
• 5.1.4: Data Flow
• 5.1.5: GSLB
• 5.1.6: Cloud Control
• 5.1.7: Cloud WAN
• 5.1.8: Object Storage
• 5.1.9: VPC
• 5.1.10: GPU Server
• 5.1.11: Virtual Server
• 5.1.12: Firewall
• 5.1.13: ID Center
• 5.1.14: Microsoft SQL Server(DBaaS)
• 5.1.15: Block Storage(BM)
• 5.1.16: Resource Groups
• 5.1.17: Cloud Functions
• 5.1.18: AI&MLOps Platform
• 5.1.19: Event Streams
• 5.1.20: Security Group
• 5.1.21: Archive Storage
• 5.1.22: API Gateway
• 5.1.23: Load Balancer
• 5.1.24: Data Ops
• 5.1.25: Scalable DB(DBaaS)
• 5.1.26: Cloud LAN-Campus
• 5.1.27: EPAS(DBaaS)
• 5.1.28: PostreSQL(DBaaS)
• 5.1.29: Logging&Audit
• 5.1.30: Search Engine
• 5.1.31: DNS
• 5.1.32: VPN
• 5.1.33: Secrets Manager
• 5.1.34: Quick Query
• 5.1.35: File Storage
• 5.1.36: CacheStore(DBaaS)
• 5.1.37: Secret Vault
• 5.1.38: Queue Service
• 5.1.39: Kubernetes Engine
• 5.1.40: Config Inspection
• 5.1.41: Cloud LAN-Datacenter
• 5.1.42: Identity Access Management
• 5.1.43: Bare Metal Server
• 5.1.44: ServiceWatch
• 5.1.45: MariaDB(DBaaS)
• 5.1.46: Container Registry
• 5.1.47: Vertica(DBaaS)
• 5.1.48: Backup
• 5.1.49: Organization
• 5.1.50: Cloud ML
• 5.1.51: Certificate Manager
• 5.1.52: Key Management Service
• 5.1.53: Direct Connect
• 5.1.54: Support Center
• 6: Release Note

1 - Overview

Service Overview

ServiceWatch is a service that provides various tools to collect metrics, logs, events, and other data from resources created on the Samsung Cloud Platform for monitoring, offering observability of resources overall, including performance and operational status.

Features

We provide the following special features.

• Resource Monitoring: Collects and visualizes performance metrics of resources (CPU Usage, etc.). Also creates a dashboard that allows visual inspection of multiple metrics in one place for quick overview.
• Alert Policy Configuration and Automatic Notification: You can create alert policies by setting predefined conditions and thresholds, and when a threshold is exceeded, you receive notifications, allowing you to quickly check and respond to resource status.
• Log Analysis and Storage: Collect logs generated from resources for easy viewing and searching. Collected logs are stored in log groups for management, and log groups can be stored for free up to 5GB. Additionally, you can set a log retention policy to specify the retention period, and logs that exceed the retention period do not require separate management.
• Cost Efficiency: ServiceWatch offers a flexible pay-as-you-go pricing model, allowing cost‑effective usage. It also provides a free usage tier, so you can try it for free and then scale to a paid plan as needed.

Provided features

We provide the following features.

• Metric Monitoring
  • Metrics: ServiceWatch receives metric data from services of the Samsung Cloud Platform, and ServiceWatch collects and stores the metric data to provide it to users.
  • Dashboard: Visualizes metrics of a single region to provide an integrated view of resources. In ServiceWatch, dashboards are divided into automatically generated service dashboards for each service and user-created custom dashboards.
  • Alert: Provides an alert feature that allows monitoring of metric changes based on user-defined thresholds and sends notifications when thresholds are exceeded.
• Log Monitoring
  • ServiceWatch provides log management capabilities. Logs collected from Samsung Cloud Platform services are stored in log groups for management. You can set log retention policies to manage the retention period. Additionally, you can view and search log data through the console, and it offers the ability to store log groups in Object Storage.
• ServiceWatch Agent
  • Through the ServiceWatch Agent, you can collect detailed metrics on processes, CPU, memory, disk usage, and network performance from Virtual Servers, GPU Servers, Bare Metal Servers, and other resources. GPU performance metrics can also be collected. Additionally, the Agent can collect logs generated by the resources. (Planned for December 2025)
• Event Monitoring
  • ServiceWatch can create event rules from system events about changes to resources created in the Samsung Cloud Platform, allowing you to receive notifications under specific conditions.

Component

Metric

Metrics refer to system performance data. By default, we provide basic monitoring based on free metrics for resources of services integrated with ServiceWatch. Additionally, services such as Virtual Server can enable detailed monitoring to provide paid metrics.

Indicator data can be viewed for up to 15 months (455 days).

For detailed information related to metrics, please refer to Metrics.

log

You can collect, store, and view logs of systems, applications, and services used in Samsung Cloud Platform services such as Virtual Server resources and Kubernetes Engine.

For detailed information related to logs, refer to 로그.

event

An event represents a change in the environment in the Samsung Cloud Platform service. Below are examples of events.

• Generates an event when the status of a Virtual Server changes from Stopped to Running.
• Generates an event when a new bucket is created in Object Storage.
• An event is generated when an IAM user is removed from a user group.

For detailed information about events, refer to the Events.

Dashboard

ServiceWatch provides a pre-built service dashboard for each service automatically, and users can also create dashboards manually.

ServiceWatch Agent

The ServiceWatch Agent is a software component that collects metrics and logs from Virtual Servers, GPU Servers, and on‑premises servers, among others. This enables monitoring of infrastructure and applications with greater granularity than the default monitoring provided out of the box.

Constraints

The limitations of ServiceWatch are as follows.

The following is ServiceWatch’s monthly free offering details.

Provision status by region

ServiceWatch is available in the following environments.

Preliminary Service

There are no prerequisite services for ServiceWatch.

1.1 - Metric

Metric

Metrics are data about system performance. By default, many services provide free metrics for resources (e.g., Virtual Server, File Storage, etc.), which are offered as basic monitoring through ServiceWatch. Detailed monitoring can be used for certain resources such as Virtual Server.

Indicator data is retained for 15 months (455 days), so you can view both the latest data and historical data.

Namespace

A namespace is a logical separation used to distinguish and group ServiceWatch metrics. In Samsung Cloud Platform services, namespaces are generally the same as the service name, and can be found in the ServiceWatch 연계 서비스 목록.

For custom metrics, users can define a namespace in ServiceWatch to distinguish them from other metrics, and can define it via the ServiceWatch Agent settings or OpenAPI. Detailed information about custom metrics and logs can be found in 사용자 정의 지표 및 로그.

Metric (metric)

A metric represents a set of data points sorted chronologically as they are collected in ServiceWatch. Each data point consists of a timestamp, the collected data, and the unit of the data.

For example, the CPU utilization of a specific Virtual Server is one of the basic monitoring metrics provided by Virtual Server. The data point itself can be generated by any application or activity that collects data.

By default, the Samsung Cloud Platform services integrated with ServiceWatch provide resource metrics for free. Detailed monitoring for some resources is offered as a paid service and can be enabled in each service.

Metrics can only be viewed in the region where they were created. Metrics cannot be arbitrarily deleted by users. However, if new data is not posted to ServiceWatch, they will automatically expire after 15 months. Data points older than 15 months (455 days) expire sequentially, and when new data points are added, data older than 15 months (455 days) is deleted.

Timestamp

The timestamp of a data point is the time information indicating when the data point was recorded. Each metric data point consists of a timestamp (time) and data.

A timestamp consists of hours, minutes, seconds, and a date.

Metric retention period

We maintain ServiceWatch metric data as follows.

• Data points with a collection interval set to 60 seconds (1 minute) are available for up to 15 days.
• Data points with a collection interval set to 300 seconds (5 minutes) are available for up to 63 days.
• Data points with a collection interval set to 3600 seconds (1 hour) are usable for up to 455 days (15 months).

Data points that were initially collected at a short interval are downsampled and stored for long-term retention.

For example, if data is collected at a 1‑minute interval, it is retained in 1‑minute granularity for 15 days. After 15 days, the data continues to be retained but can only be queried in 5‑minute intervals. After 63 days, the data is re‑aggregated and provided in 1‑hour intervals. If you need to retain metric data points longer than the metric retention period, you can archive them separately using the File Download or Object Storage Export features.

Dimension(Dimensions)

A key-value pair that serves as a unique identifier for a metric, allowing you to classify and filter data points.

For example, you can identify metrics for a specific server by using the resource_id dimension of the Virtual Server metrics.

Collection interval

It refers to the interval for collecting data points for each service’s metrics and is provided according to the collection interval predefined by each service.

Refer to each service’s ServiceWatch metrics page for the metric collection interval.

For example, Virtual Server provides a collection interval of 5 minutes during basic monitoring, and a 1‑minute interval when detailed monitoring is enabled.

Statistics

Statistics are a method of aggregating metric data over a specified period. ServiceWatch provides data aggregated as statistics based on metric data points supplied to ServiceWatch from each service. Aggregation is performed within the specified aggregation period using namespace, metric name, dimension, and data point units.

The provided statistics are sum, average, minimum, maximum.

• Total: sum of all data point values collected during the period
• Average: During the specified period, (sum of all data pointer values during that period) / (number of data pointers during that period) value
• Minimum: the lowest value observed during the specified period
• Maximum: the highest value observed during the specified period

unit

Each statistic has a measurement unit. Examples of units include Bytes, Second, Count, Percent, etc.

Aggregation period

Each statistic calculates the data points of the metric collected during the selected aggregation interval. The aggregation interval can be chosen from 1 minute, 5 minutes, 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, or 1 day, with the default being 5 minutes. The aggregation interval is closely related to the collection frequency of metric data points, and to obtain correct aggregation results, the aggregation interval must be equal to or longer than the collection frequency.

For example, if you select average, choose 5 minutes as the aggregation period, and pick a metric with a 1‑minute collection interval, data points are collected every minute and the average is calculated over the data points collected during the 5‑minute period. Conversely, if the aggregation period is shorter than the collection interval, it means a valid aggregation result cannot be obtained.

Downsampling is applied for long-term storage of metric data. For example, if data is collected at a 1‑minute interval, after 15 days the data can only be queried in 5‑minute increments. If you set the aggregation period for such metrics from 5 minutes to 30 minutes, up to 5 minutes may be required to retrieve the downsampled data correctly. After 63 days, the data is re‑aggregated and provided in 1‑hour intervals. At that point, selecting an aggregation period from 1 hour to 1 day may take up to 1 hour to retrieve the data correctly. This occurs because aggregating the downsampled metric data takes time, which can cause aggregation delays.

Alert

When creating an alert policy, you can evaluate a single metric over the specified evaluation period, and if it meets the condition set based on the threshold, you can notify the user with an alert.

The alarm status is classified as Alert (alert), Normal (normal), Insufficient data (no data).

• Alert(Alert): when the metric meets the configured condition
• Normal (Normal): when the indicator does not meet the set conditions.
• Insufficient data(no data): when the metric data does not exist, is missing, or has not yet arrived

When the alarm status is Alert, after evaluating the alarm, if it deviates from the condition, the alarm status changes back to Normal.

For detailed information about alerts, refer to the 경보 entry.

Basic monitoring and detailed monitoring

ServiceWatch provides two types of monitoring: basic monitoring and detailed monitoring.

The Samsung Cloud Platform services integrated with ServiceWatch provide basic monitoring by publishing a default set of metrics to ServiceWatch for free. By default, if you use any of these services, basic monitoring is automatically enabled and can be viewed in ServiceWatch.

Detailed monitoring is available only for certain services and incurs charges. To use detailed monitoring, you must enable it in the service details.

Detailed monitoring options vary depending on the service provided.

• The default monitoring for Virtual Server has a collection interval of 5 minutes. When detailed monitoring is enabled, the metrics provided by default monitoring are collected at a 5 minutes → 1 minute interval.
• Basic monitoring of Object Storage is provided for basic metrics, and enabling replication metrics provides additional replication metrics.

The following includes services and guides that provide detailed monitoring.

1.2 - Alert

Alert

You can create alerts that monitor metrics and send notifications. For example, you monitor the CPU usage and disk read/write of a Virtual Server, then send a notification to the user to handle the increased load.

• Alert Policy
  • Alert Status
  • Alert Evaluation
    • Evaluation Scope
    • 조건
  • Alert Notification
  • How to Handle Missing Data During Alarm Evaluation
• Alert History

Alert Policy

The alert policy can monitor metrics of the same Account and evaluate alerts for a single metric. This alert policy compares the specified threshold with metric conditions and sends a notification when the conditions are met.

If you disable the alert policy, its evaluation continues, but you can restrict sending alerts to the designated recipients. If you want to temporarily stop sending alerts for resources with an alarm policy configured, you can use alarm policy deactivation.

When you enable an alert policy, evaluation of the policy starts, and according to the configured conditions, the alert status changes to Alert, with a notification sent each time the alert status changes.

The alarm policy status indicates whether the alarm policy is enabled or disabled.

You can set alert stages in the alert policy. Depending on the alert stage, the alert color (red/pink/purple) is displayed differently, allowing visual distinction of stages by color. You can filter alarm policies by their alarm level and view policies for each level.

Alert Status

The alarm state changes according to the alarm evaluation of the alarm policy. The alarm state is divided into three states: Normal (normal), Insufficient data (insufficient data), Alert (alert).

Alert Evaluation

For example, for a metric with a 1‑minute collection interval, if you set a 1‑minute evaluation window with 4 violations out of 5 evaluation attempts, the evaluation interval is 5 minutes. For a metric with a 5‑minute collection interval, if you set a 10‑minute evaluation window with 3 violations out of 3 evaluation attempts, the evaluation interval is 30 minutes.

Evaluation Scope

The evaluation scope of an alert policy is the time range used for alert evaluation.

• It is recommended to set it as the indicator’s collection interval or a multiple of the collection interval.
• You can enter up to 604,800 (7 days) seconds.

condition

The conditions for alarm evaluation require a conditional operator and threshold setting.

When the namespace is Virtual Server and the metric is CPU Usage (unit: %), the alarm evaluation condition is completed as follows.

Alert Notification

If the alarm evaluation criteria are met, change the alarm status to Alert and send a notification to the recipients configured in the alarm policy.

Method for handling missing data during alarm evaluation

Some resources may be unable to send metric data to ServiceWatch under certain conditions. For example, if a resource is inactive or does not exist, it will not be sent to ServiceWatch. If metrics are not collected for a certain period, the alert evaluation will change the alert status to Insufficient data.

ServiceWatch provides a way to handle missing data during alert evaluation. The methods for handling missing data are as follows:

• Ignore: maintains the current alarm state. (default)
• Missing: Treat missing data points as missing. If all data points within the evaluation range are missing, the alert status changes to Insufficient data.
• Breaching: Process missing data points as satisfying the threshold condition.
• Not breaching: Treat missing data points as normal when they do not satisfy the threshold condition.

Alert History

The change history of the alarm status is recorded in the alarm history. The alarm history can be viewed for 30 days.

1.3 - Log

Log

By using ServiceWatch logs, you can monitor, store, and access log files collected from the resources of the service that provides the logs.

Log Group

Log groups are containers for log streams that share the same retention policy settings. Each log stream must belong to a single log group. For example, if there are separate log streams for the logs of each cluster in Kubernetes Engine, you can group the log streams into a single log group called /scp/ske/{cluster name}.

Log Retention Policy

The log retention policy allows you to set the period for retaining log events in ServiceWatch. Log events whose retention period has expired are automatically deleted. Log The retention period assigned to the group applies to the log streams and log events belonging to the log group.

The retention period can be selected from the following options and is set in days.

Log stream

A log stream is a collection of log events ordered by the sequence in which they occurred from the same source. For example, all log events generated by a particular Kubernetes Engine cluster can form a single log stream.

Log Event

Log events are individual records that capture logs generated by a resource. A log event record includes two attributes: a timestamp of when the event occurred and a log message. Each message must be encoded in UTF-8.

log pattern

You can create log patterns to filter log data that matches the pattern. Log patterns define the words or patterns to search for in the log data collected by ServiceWatch, allow you to view the status of log occurrences as graphs, and serve as metrics for creating alert policies.

Log patterns are not applied retroactively to data. They are applied to log events collected after the log pattern is created.

Log pattern namespace

A namespace is a logical separation used to distinguish and group metrics. In ServiceWatch, it is divided into namespaces associated with services, namespaces for custom metrics, and namespaces for log patterns.

• Namespace associated with services such as Virtual Server
• A namespace consisting of custom metrics, i.e., the namespace of metrics collected through the custom metrics API or ServiceWatch Agent.
• Namespace of the metric generated by the log pattern

When creating metrics for a log pattern, you can either create a new namespace for the log pattern or select from existing log pattern namespaces.

Metric name

The monitored log information is the name of the metric generated by ServiceWatch. You must configure it so that the metric name does not duplicate within the namespace where the metric will exist.

Metric Value

It is the numeric value posted to the metric each time a log matching the pattern is found. For example, when counting occurrences of a specific word (e.g., Error), this value becomes 1 for each occurrence. When calculating transmitted bytes, it can be incremented by the actual number of bytes found in the log event.

default value

This is the value recorded in the log pattern for periods during log collection when no matching logs can be found. Setting the default to 0 prevents the metric from becoming irregular due to periods with no matching data.

When setting a dimension on a metric created from a log pattern, you cannot set a default value for that metric.

dimension

Dimensions are key-value pairs that further define a metric. You can add dimensions to metrics generated from log patterns. Since dimensions are part of a metric’s unique identifier, each time a unique name/value pair is extracted from logs, a new variant of that metric is created.

When you choose the log pattern format as either a whitespace-delimited pattern or a JSON format pattern, you can set the dimension, and it can be configured using one of the parameters defined in the pattern. You can assign up to three dimensions to an indicator. If a default value is set, you cannot configure dimensions. To set dimensions, you must disable the use of the default value.

Pattern format

This explains how ServiceWatch interprets data from each log event. The pattern format can be selected from three options as shown below.

• String Pattern: log containing a specific string
• Space-separated pattern: timestamps, IP addresses, strings, and other logs separated by spaces
• JSON format pattern: log containing specific JSON fields

Available regular expression syntax

When using regular expressions to search and filter log data, you must enclose the expression with %.

Patterns that contain regular expressions can only include the following.

• Alphanumeric - An alphanumeric character is a character that corresponds to a letter (A~Z or a~z) or a digit (0~9).
  • It can be used with A-Z, a-z, 0-9.
• The supported symbol characters are as follows.
  • :, _, #, =, @, /, ;, ,, -
  • For example, %servicewatch!% cannot be used because ! is not supported.
• The supported operators are as follows.
  • It includes ^, $, ?, [, ], {, }, |, \, *, +, ..
  • (, ) The operator is not supported.

string pattern

String pattern using regular expressions

You can search for matching patterns in log events using a regex string pattern wrapped with %(percentage) at the beginning and end. Below is an example pattern that retrieves all log events containing the ERROR keyword. Please refer to Available regex syntax.

%ERROR%

The above pattern matches log event messages like the ones below.

• [2026-02-13 14:22:01] ERROR 500 POST /api/v1/checkout (192.168.1.10) - NullPointerException at com.app.controller.CheckoutController.java:55
• [ERROR] Configuration file not found: /etc/app/config.yaml

String pattern in unstructured log events

It is a string pattern for searching strings in log events that are not in formats such as JSON. Below is an example of a log event message, and you can view log events that match various string pattern classifications.

ERROR CODE 400 BAD REQUEST
ERROR CODE 401 UNAUTHORIZED REQUEST
ERROR CODE 419 MISSING ARGUMENTS
ERROR CODE 420 INVALID ARGUMENTS

Space-separated pattern

Generate a pattern to search for matching strings in space-separated log events.

Whitespace-separated pattern example (1)

The following is an example of log events separated by spaces.

2023-10-27T10:00:01Z [INFO] 1234 login success 192.168.1.1

The above log event is a space‑separated log event that includes timestamp, logLevel, user_id, action, status, ip. Characters between brackets ([]) and double quotes ("") are considered a single field.

To create a pattern that searches for matching strings in space-separated log events, enclose the pattern in brackets ([]) and specify name-separated fields with commas (,). The following pattern parses six fields.

A pattern like [timestamp, logLevel, user_id, action, status = success, ip] can be used to find log events where the fifth field, status, is success.

Whitespace-separated pattern example (2)

abc xxx.log james 2023-10-27T10:00:01Z POST 400 1024
abc xxx.log name 2023-10-27T10:00:02Z POST 410 512

The above log event is a space‑separated log event that includes host, logName, user, timestamp, request, statusCode, and size.

A pattern like [host, logName, user, timestamp, request, statusCode=4*, size] can find log events where the sixth field, statusCode, starts with 4.

If you do not know the exact number of fields in a space-separated log event, you can use an ellipsis (…). A pattern such as […, statusCode=4*, size] represents the first five fields using an ellipsis.

AND(&&) operator and OR(||) operator can be used to create composite expressions. […, statusCode=400 || statusCode=410, size] can find log events where the sixth field, statusCode, is 400 or 410.

You can use regular expressions to provide conditions in a pattern. [host, logName, user, timestamp, request, statusCode=%4[0-9]{2}%, size] can find log events where the sixth field, statusCode, is a number that starts with 4.

JSON format pattern

You can create a pattern to search for matching strings or numeric values in JSON log events. Patterns are enclosed in curly braces ({}).

String-based JSON format pattern

• Use $. to represent JSON fields.
• The operator can use = or !=.
• The string to compare with the field can be enclosed in double quotes (""). Strings containing characters other than alphanumerics and the underscore must be enclosed in double quotes. Use an asterisk (*) as a wildcard to match text.

{ $.resourceType = "trail" }
{ $.resourceType = "%trail%" }
{ $.arrayKey[0] = "value" }

JSON format pattern that searches for numeric values

• Use $. to represent JSON fields.
• You can use numeric operators.
  • greater than(>), less than(<), equal to(=), not equal to(!=), greater than or equal to(>=), less than or equal to(<=)
• You can include addition(+) or subtraction(-) symbols. An asterisk(*) can be used as a wildcard.

{ $.errorCode = 400} 
{ $.errorCode >= 400} 
{ $.errorCode != 500 }
{ $.sourceIPAddress != 123.123.* }

Export Log Group

You can export log data from a log group to Object Storage for log retention and analysis. You can also export log groups for log data that resides in the same account.

To start exporting a log group, you must create an Object Storage bucket to store the log data.

Exporting a log group can take a long time depending on the amount of logs. When exporting a log group, you can reduce the export duration by specifying particular streams within the log group or by defining a time range.

Log group export can only be executed one at a time per account. To start another log group export, the ongoing export task must be completed.

You can delete a log group’s export history after the export succeeds or after the export cancellation is completed. Canceling a log group export does not delete the saved file exported from the log group. To delete the saved file exported from the log group, delete the stored file directly in Object Storage.

1.4 - Event

An event represents a change in the environment in the Samsung Cloud Platform service.

ServiceWatch receives events generated by most Samsung Cloud Platform services. Events from each service can be viewed and processed in the ServiceWatch of the same Account.

Refer to the ServiceWatch Event Reference for the list of services that send events to ServiceWatch and the events they send.

Each service sends events to ServiceWatch based on Best Effort delivery. Best Effort delivery means that the service attempts to send all events to ServiceWatch, but occasionally some events may not be delivered.

When a valid event is delivered to ServiceWatch, ServiceWatch compares the event with the rules and then sends a notification to the alert recipients configured in the event rule.

Event Rules

You can specify the actions that ServiceWatch performs on events delivered from each service to ServiceWatch. To do this, create an event rule. An event rule defines which events are sent to which targets.

Event rules evaluate an event when it arrives. Each event rule checks whether the event matches the rule’s pattern. If the event matches, ServiceWatch processes the event.

Based on the event data criteria (called an event pattern), you can generate matching rules for incoming events. When an event matches the criteria defined in the event pattern, the event is delivered to the target specified in the rule.

• Event rules can, by default, designate the recipients who will receive notifications when an event occurs.
• The event rules are planned to be expanded to include multiple Samsung Cloud Platform services as recipients when events occur. (Planned for 2026)

To create an event rule, refer to How-to Guides > Create Event Rule.

Event source

In ServiceWatch, the event source can be selected as a Samsung Cloud Platform service name. You can select the service name of the event you want to receive as the event source.

Event Type

The Samsung Cloud Platform service has its own resource types. Event types are classified the same as resource types, and you select the type of events from the event source to use in an event rule.

The following are the event types of a Virtual Server.

For other event types available in ServiceWatch, refer to ServiceWatch Event.

Event

Events can select either all events generated from an event source’s event type or specific events.

The following are some events of the Server event type for Virtual Server.

For other events available in ServiceWatch, refer to ServiceWatch Event.

Applied Resources

Set an event pattern for the selected event on all resources or a specific resource.

event pattern

When you select the event source, event type, event, and target resource, the event pattern configuration for the event rule is completed.

The following is an example of an event pattern set in ServiceWatch’s event rule.

{
	"source": [ // namespace
		"Virtual Server"
	],
	"detail-type": [ // event type
		Server
	],
	"detail": {
		"event": [ // individual event
			Compute Virtual Server Create End
		]
	},
	"resources": [ // individual resources
		"srn:{offerring}::{account_id}:{region}::virtualserver:server/{resource_id}"
	]
}

{
	"source": [ // namespace
		"Virtual Server"
	],
	"detail-type": [ // event type
		Server
	],
	"detail": {
		"event": [ // individual event
			Compute Virtual Server Create End
		]
	},
	"resources": [ // individual resources
		"srn:{offerring}::{account_id}:{region}::virtualserver:server/{resource_id}"
	]
}

To create an event rule, refer to How-to Guides > Create Event Rule.

Event Notification

If the event matches the pattern, a notification is sent to the alert recipients configured in the event rule.

1.5 - ServiceWatch integration service

You can view services integrated with ServiceWatch.

Metrics and Log Monitoring

Below you can see the service that integrates ServiceWatch with metric and log monitoring.

event

Below you can see the service that integrates ServiceWatch with events.

1.6 - Custom Metrics and Logs

ServiceWatch can collect custom metrics defined by the user and can gather log files from resources created by the user.

There are two ways to collect custom metrics and logs.

The first method is to install the ServiceWatch Agent directly on the resource, configure the resources to be collected, and collect them.
The second option is to collect custom metrics and logs using the OpenAPI/CLI offered by ServiceWatch.

ServiceWatch Agent

You can install the ServiceWatch Agent on user resources such as Virtual Server, GPU Server, Bare Metal Server, etc., to collect custom metrics and logs.

ServiceWatch Agent Constraints

ServiceWatch Agent network environment

The ServiceWatch Agent is designed to collect data using OpenAPI by default, so installing and using it on server resources requires external communication over the Internet. Please create an Internet Gateway in the VPC where the resources reside and configure a NAT IP on the server resources to enable communication with the outside.

ServiceWatch Agent Supported OS Image

The OS images available for the ServiceWatch Agent are as follows.

Provides the same as the OS Image provided for Virtual Server. Refer to Virtual Server > OS Image 제공 버전.

Quick Guide for Using ServiceWatch Agent

Below, we present a Quick guide for collecting OS metrics and logs of a Virtual Server in a Linux environment.

Installing and Configuring Node Exporter

1. Refer to Node Exporter installation and install Node Exporter on the server to collect custom metrics.
   • When you install Node Exporter, you can collect OS metrics through Node Exporter in addition to the metrics provided by ServiceWatch’s default monitoring.
2. Refer to ServiceWatch Agent 설정, then download the ServiceWatch_Agent archive, configure the ServiceWatch Manager, and run it.
   • By referring to the examples/os-metric-min-examples folder in the archive, you can run the ServiceWatch Agent by configuring at least two metrics.

ServiceWatch Custom Metrics and Logs API

You can collect custom metrics and logs using the OpenAPI/CLI provided by ServiceWatch.

You can deliver custom metric data and custom logs to ServiceWatch via the ServiceWatch OpenAPI/CLI, and view the visualized information in the Console.

Create custom metric metadata

To collect metric data generated from a user’s resources or applications—not the metrics provided by Samsung Cloud Platform services (e.g., Virtual Server, etc.)—into ServiceWatch, you must create custom metric metadata.

For detailed information on creating custom metric metadata, see CreateCustomMetricMetas.

Create custom metric

After generating custom metric metadata, you can send the resulting metric data to ServiceWatch using the CreateCustomMetrics API.

The transmitted metric data can be queried, organized by the configured namespace.

For detailed information on generating custom metric data, see CreateCustomMetrics.

Metric Data Query

Metric data, including custom metrics, can be retrieved using the Console and the ListMetricInfos API.

For detailed information on retrieving metric data, see ListMetricInfos and ListMetricData.

Create log stream

A ServiceWatch log group is required for custom log collection. Log groups can only be created in the Console. After creating a log group in advance, you can use the log stream creation API to create a log stream that will be delivered to ServiceWatch.

For detailed information on creating a log stream, see CreateCustomLogStream.

Log Event Creation

To collect custom logs, after creating a log group and log stream, we use the log event creation API to deliver individual log messages (log events) to ServiceWatch.

For detailed information on creating log events, refer to CreateCustomLogEvents.

2 - How-to guides

Users can monitor resources created on the Samsung Cloud Platform through ServiceWatch.

Using the Dashboard

You can monitor resources on the ServiceWatch dashboard detail screen.

To monitor resources with the dashboard, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigate to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for the resource you want to monitor. 3. Navigate to the Dashboard Details page.
4. Dashboard Details page, select the monitoring period and time zone, then monitor resources using the widget.

   Category	Detailed description
   Dashboard name	Dashboard name click to select another dashboard
   Period setting area	Period selection applied to widgets in the dashboard Metric queries can be set from now up to a maximum of 455 days
   Time Zone Settings Section	Select the time zone applied to the period setting
   Reset button	Reset all actions and settings made on the dashboard detail screen.
   Refresh Settings Area	Select refresh interval for widget information Refresh button displays information anew based on the current time Click the refresh interval to select the desired period: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   Edit	Edit dashboard information When the Edit button is clicked, navigate to the Dashboard Edit page For detailed information about dashboard editing, see 대시보드 관리하기
   More	Display additional tasks for managing the dashboard For detailed information on dashboard management items, see Dashboard Management
   Alert Status	Show the number of active alerts linked to recommended metrics on the service dashboard, displayed by stage When the View All Alert Policies button is clicked, navigate to the Alert Policy List page When the Expand button is clicked, the content is provided as widgets (up to 12) For detailed information on widget management, refer to 위젯 관리하기 View Alert Policy: navigate to the Alert Policy Details page for the corresponding metric
   Dashboard status	Display metric widgets for monitoring each resource Click the Widget Expand View button to view detailed information about the metric For more details on metric information, refer to Widget Details Click the More button to manage widgets For detailed information on widget management, refer to Widget Management When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data for that point You can drag the mouse to zoom in on a specific area of the graph Clicking a resource name shown in the legend displays detailed information about that resource in a popup

   Table. Dashboard detailed items

Setting dashboard favorites

You can bookmark frequently used dashboards and easily navigate to the dashboard from the ServiceWatch Service Home page. To bookmark the dashboard, follow these steps.

1. All Services > Management > ServiceWatch menu, click. 1. Go to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigate to the Dashboard List page.
3. Dashboard List page, check the favorite icon of the dashboard you want to bookmark. Click the dashboard to view its details. 3. Navigate to the Dashboard Details page.
   • Bookmarked dashboards are added to the bottom of the Dashboard > Dashboard Favorites menu and the Dashboard Favorites section on the Service Home page.

Widget Details

You can enlarge widgets within the dashboard to view them individually. To enlarge and view an individual widget, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. 1. Go to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigate to the Dashboard List page.
3. Dashboard List page, click the dashboard for the resource you want to monitor. 3. Navigate to the Dashboard Details page.
4. On the Dashboard Details page, click the Widget Zoom button for the widget you wish to enlarge. 4. The Metric Details popup opens for this widget.

   Category	Detailed description
   Widget name	Display widget name
   Period setting area	Period selection applied to the widget Metric lookup can be set from now up to a maximum of 455 days
   Time Zone Settings Section	Select the time zone applied to the period setting
   Reset button	Reset all actions and settings made on the dashboard detail screen.
   Statistics	Select statistical basis for the metric displayed in the widget Click the statistical basis to select: average, minimum, maximum, sum
   Aggregation Period Setting Area	Select aggregation period for widget information Click the aggregation period to choose the desired interval: 1 minute, 5 minutes, 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
   Refresh Settings Area	Select refresh interval for widget information Refresh button displays information anew based on the current time Click the refresh interval to select the desired period: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   Chart area	Display monitoring results as a chart When the mouse cursor is placed over the graph or legend area, a popup shows the time, data value, and metric data for that point You can drag the graph area to zoom into the selected region Clicking a resource name displayed in the legend opens a popup with the alarm status for that resource

   Table. Detailed indicator items

Check alarm history

You can view the alert history for metrics registered on the ServiceWatch dashboard. To view the alarm history, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. 1. Service Home Go to the page.
2. On the Service Home page, click the Alarm > Alarm History menu. 2. Go to the Alarm History page.
3. Check the alarm history on the Alarm History page.

   Category	Detailed description
   Alert filter and search area	Filter or search alarm history All alarm statuses: Filter by selecting an alarm status Enter the alarm policy name in the search field to search Advanced search: Search by entering the alarm policy name, alarm status, or change timestamp
   Alert Policy Name	Alert policy name Click the alert policy name to view detailed information of that alert policy
   Condition	Alarm trigger conditions and total occurrence time Stage display according to severity: High, Middle, Low
   Category	Distinguish alarm creation and alarm status change information
   Alarm status	Current alert status Normal: when the metric does not meet the configured condition Insulfficient data: when the metric data cannot be retrieved (missing, nonexistent, not arrived) Alert: when the metric meets the configured condition
   Alert level	When the alarm status is Alert, display the alarm level High, Middle, Low

   Table. Alarm History Items

Monitoring Metrics

You can view and monitor the metrics available in ServiceWatch.

Compare by indicator

You can select one or multiple metrics and resources to monitor. To compare and monitor by metric, follow these steps.

1. All Services > Management > ServiceWatch menu, click. 1. Navigate to the Service Home page.

2. On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.

3. On the Metrics page, in metric view mode, click Metric Comparison.

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

   Category	Detailed description
   Indicator List Area	List of metrics that can be monitored in ServiceWatch Click the + button in front of the namespace or dimension to view the sub-level list When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
   Search filter area	After setting the search items to filter, click the Apply Filter button to filter the metric list Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace Metric Name: Search by entering the exact metric name Resource Name: Search by entering the exact resource name Resource ID: Search by entering the exact resource ID Keyword: Search based on the selected top-level category and the entered keyword Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key Tag Key: Search using the selected tag key

   Table. Indicator list items

5. Check the monitoring chart in the Selected metric area.

   Category	Detailed description
   Period setting area	Select the period applied to the chart Indicator lookup can be set from now up to a maximum of 455 days
   Time Zone Settings Area	Select the time zone applied to the chart
   Reset button	Reset all modifications and settings made on the chart
   Refresh Settings Area	Select chart refresh interval Refresh button displays information anew based on the current time Click the refresh interval to select the desired interval: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   More	Display additional tasks for managing charts For detailed information on chart management, see Metric Chart Management
   graph area	Data graph collected during the period applied to the chart When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point You can drag the mouse to zoom in on a specific area of the graph Clicking a label name displayed in the legend shows detailed information about that legend in a popup
   Table area	View and edit labels, statistics, and aggregation periods for each legend Legend: Color per legend Click a legend color to change it to another color Label: Displays the namespace, resource name, and metric name of the selected metric Click the legend name to edit it Enter using letters, numbers, and special characters, between 3 and 255 characters Statistics: Choose how to aggregate metric data Select from Average (default), Minimum, Maximum, Sum Aggregation period: Choose the time unit for aggregating metric values Select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day More: Delete a legend or create an alert policy for the legend For details on creating an alert policy, see Create an alert policy

   Table. Indicator comparison monitoring chart items

   Reference

   • The statistical method is as follows.
     • Total: sum of all data point values collected during the period
     • Average: the value obtained by dividing the sum over the specified period by the number of data pointers during that period.
     • Minimum: the lowest value observed during the specified period
     • Maximum: the highest value observed during the specified period
   • For a detailed description of the metric, refer to Metric Overview.

Compare by Date

You can monitor by comparing a metric and a resource across dates or time periods. To compare and monitor by date or period, follow these steps.

1. All Services > Management > ServiceWatch menu, click it. 1. Navigate to the Service Home page.

2. On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.

3. On the Metrics page, in view mode, click Date Comparison.

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

   Category	Detailed description
   Indicator List Area	List of metrics that can be monitored in ServiceWatch Click the + button in front of the namespace or dimension to view the sub-level list When you select a metric to monitor, it is displayed as a chart in the selected metric area
   Search filter area	After setting the search items to filter, click the Apply Filter button to filter the metric list Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace Metric Name: Search by entering the exact metric name Resource Name: Search by entering the exact resource name Resource ID: Search by entering the exact resource ID Keyword: Search based on the selected top-level category and the entered keyword Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key Tag Key: Search using the selected tag key

   Table. Indicator list items

5. Check the monitoring chart in the selected metric area.

   Category	Detailed description
   Date comparison / period comparison	Select criteria for comparing indicators Date comparison: Compare by selecting a specific date Period comparison: Compare by selecting a specific period
   Date and period setting area	Select date or period to compare Date comparison: Select the date to view on the chart Period comparison: Select the period to view on the chart You can select up to four dates or periods within a maximum of 455 days from today
   Time Zone Settings Section	Select the time zone applied to the chart
   Reset button	Reset all manipulations and settings made on the chart
   Refresh Settings Area	Select chart refresh interval Refresh button updates the information based on the current time Click the refresh interval to select the desired interval: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   More	Display additional tasks for managing charts For detailed information on chart management, see Managing Metric Charts
   graph area	Data graph collected during the period applied to the chart When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point You can drag the mouse to zoom in on a specific area of the graph Clicking the date or period shown in the legend displays detailed information about that legend in a popup
   Table area	View and edit labels, statistics, and aggregation periods for each legend Legend: Color per legend Click a legend color to change it to another color Period: Period applied to the chart Metric: Displays the namespace, resource name, and metric name of the selected metric Statistics: Choose how to aggregate metric data Average(default), Minimum, Maximum, Sum can be selected. Refer to the green icon displayed to the right of a meaningful metric in the relevant metric Aggregation Period: Select the aggregation period unit for metric values 1 minute, 5 minutes(default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day can be selected More: Delete a legend or create an alert policy for a legend For details on creating an alert policy, see Create an Alert Policy

   Table. Date comparison monitoring chart items

   Reference

   • The statistical method is as follows.
     • Total: sum of all data point values collected during the period
     • Average: the value obtained by dividing the sum over the specified period by the number of data pointers during that period
     • Minimum: the lowest value observed during the specified period
     • Maximum: the highest value observed during the specified period
   • For detailed explanations of the metrics, refer to the Metric Overview.

Log Monitoring

You can monitor logs collected from the Samsung Cloud Platform service.

To view the log monitoring data, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
2. On the Service Home page, click the Log > Log Group menu. 2. Navigate to the Log Group List page.
3. On the Log Group List page, click the log group name to view its details. 3. Navigate to the Log Group Details page.
4. On the Log Group Details page, click the Log Stream tab. 4. Log Stream list is displayed.
5. log stream Click the log stream name in the list to view detailed information. 5. Navigate to the Log Stream Details page.
   • Click the All Log Streams View button at the top of the log stream list to go to the All Log Streams Details page.

     Category	Detailed description
     Excel download	Log stream history can be downloaded as an Excel file
     Timestamp list	Message list by timestamp Select period, user time zone, can filter using message input

     Table. Log group details - Log stream detail items

Receive event notifications

You can create a system event rule for changes to resources generated in Samsung Cloud Platform and receive them as notifications.

Installing ServiceWatch Agent

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

To install the ServiceWatch Agent, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
2. On the Service Home page, click the Agent Setup & Guideline button. 2. Agent Setup & Guideline A popup window opens.
3. Agent Setup & Guideline Copy the installation file URL from the popup window and go to that address. 3. Agent, manager, and configuration files can be downloaded.
   • For detailed information on installing the ServiceWatch Agent, refer to Using ServiceWatch Agent.

2.1 - Managing Dashboards and Widgets

In the Samsung Cloud Platform Console, you can create and manage dashboards to monitor the resources of the services you are using.

Create Dashboard

You can create a ServiceWatch dashboard.

Creating a dashboard by adding individual widgets

To create a dashboard, follow these steps.

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

2. Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.

3. On the Dashboard List page, click the Create Dashboard button.

4. Please enter the dashboard name.

   • Enter the dashboard name using English letters, numbers, and special characters (-_) within 3 ~ 40 characters.
   • You cannot enter a name that is already in use on the service dashboard.

5. Add a widget to configure the dashboard. A popup window appropriate to the widget addition method will open.

   • Add Individual Widget: You can add a single widget that combines metrics and resources. Clicking the button opens the Add Individual Widget popup.

     Category	Required status	Detailed description
     Indicator classification	Selection	In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list
     Indicator List Area	Required	List of metrics that can be monitored in ServiceWatch Click the + button in front of the namespace and dimension to view the sub-level list When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
     Search filter area	-	After setting the search items to filter, click the Apply Filter button to filter the metric list Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace Metric Name: 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 top-level category and the entered keyword Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key Tag Key: Search using the selected tag key
     Selected metric area	-	Monitoring chart for the selected metric in the metric list area Data graph collected during the period applied to the chart When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point You can drag the mouse to zoom in on a specific area of the graph Clicking the resource name shown in the legend displays detailed information about that resource in a popup Item values in the table area within the chart can be edited Label: Enter the legend name using English letters, numbers, or special characters, between 3 ~ 255 characters Statistics: Choose the method for aggregating metric data Options: average (default), minimum, maximum, sum Aggregation period: Select the aggregation period unit for metric values Options: 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours Delete: Remove the legend

     Table. Individual widget additional items

6. Click the Complete button in the widget addition popup. The widget will be added to the dashboard on the dashboard creation page.

7. After confirming the added widget, click the Create button. A popup indicating dashboard creation will appear.

8. Click the Confirm button. Dashboard creation is complete.

Creating a dashboard by adding multiple widgets

To create a dashboard, follow these steps.

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 the name of the dashboard.

   • Enter the dashboard name using English letters, numbers, and special characters (-_) within 3 ~ 40 characters.
   • You cannot enter a name that is already in use on the service dashboard.

5. Add a widget to configure the dashboard. A corresponding popup window will open according to the widget addition method.

   • Add Multiple Widgets: Select the desired resources by metric unit and add multiple widgets at once. Clicking the button opens the Add Multiple Widgets popup window.

     Category	Required or not	Detailed description
     Indicator classification	Select	In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list
     Indicator selection area	Required	Select the namespace and resources to add Click the + button in front of the namespace and resources to view the list of sub-resources and metrics When you check the metrics to add to the widget from the metric list, the Selected Metrics and Selected Resources sections are displayed Multiple metrics can be selected
     Selection indicator	Required	Display the list of selected metrics from the namespace and resource list When a metric is clicked, the Selected Resources area shows the list of resources included in that metric
     Selected resource	Required	Selected Indicator list, add resources to the selected indicator After clicking the Select button, choose resources that can be added to the indicator, allowing up to five additions Resources must be added for all indicators in the Selected Indicator list
     Statistics	Required	Select the statistical basis for the indicator value You can choose from average (default), minimum, maximum, or sum
     Aggregation period	Required	Select the aggregation period unit for metric values Choose from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, or 12 hours

     Table: Additional items for multiple widgets

6. Click the Complete button on the widget addition popup. The widget will be added to the dashboard on the dashboard creation page.

7. After confirming the added widget, click the Create button. A popup indicating dashboard creation will appear.

8. Click the Confirm button. The dashboard has been created.

Create a dashboard by loading a dashboard

To create a dashboard, follow these steps.

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

2. Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.

3. On the Dashboard List page, click the Create Dashboard button.

4. Enter the name of the dashboard.

   • Enter the dashboard name using English letters, numbers, and special characters (-_) within 3 ~ 40 characters.
   • You cannot enter a name that is already in use on the service dashboard.

5. Add a widget to configure the dashboard. A corresponding popup window will open according to the widget addition method.

   • Dashboard Load: You can load widgets from dashboards registered in ServiceWatch. When you click the button, the Dashboard Load popup opens.

     Category	Required	Detailed description
     Dashboard	Required	Display the list of dashboards registered in ServiceWatch When a dashboard is selected, the widgets applied to the dashboard are displayed in the preview area
     Preview	Required	Display widgets applied to the selected dashboard from the dashboard list Check the widget name to select widgets to add to the dashboard to be created If you check the Select All item, all metrics of that dashboard are selected

     Table. Load Dashboard Items

6. Click the Complete button in the widget addition popup. The widget will be added to the dashboard on the dashboard creation page.

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

8. Click the Confirm button. Dashboard creation is complete.

Check the dashboard

You can view the information of the selected dashboard on the Dashboard List page. To view the dashboard, 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 Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.

   Category	Detailed description
   Dashboard name	Dashboard name User dashboards are the dashboard names set by the user. Service dashboards are the Samsung Cloud Platform service name that matches the service namespace
   Dashboard Category	Dashboard classification User: Dashboard created directly by the user Service: Dashboard automatically composed of pre-built key metrics for each service
   Modification date and time	Dashboard modification timestamp
   Creation date and time	Dashboard creation date and time
   Favorites	If bookmarked, it is displayed in yellow Click the star icon to set or remove a bookmark

   Table. Dashboard list items
3. On the Dashboard List page, click the dashboard whose details you want to view. You will be taken to the Dashboard Detail page.

   Category	Detailed description
   Dashboard name	Display the dashboard name Click the name to select another dashboard
   Period setting area	Period selection applied to widgets in the dashboard Metric queries can be set from now up to a maximum of 455 days
   Time zone setting area	Select the time zone applied to the period setting
   Reset button	Reset all actions and settings made on the dashboard detail screen
   Refresh Settings Area	Select refresh interval for widget information Refresh button updates the information based on the current time Click the refresh interval to choose the desired period: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   Edit	You can edit the dashboard name or manage widgets When you click the Edit button, you are taken to the Dashboard Edit page For more details on editing the dashboard, see 대시보드 수정하기
   More	Display additional tasks for managing the dashboard Dashboard duplication and deletion, view details, view source are possible For details on dashboard management items, refer to Dashboard Management For details on widget management items, refer to Widget Management
   Widget area	Display widgets for monitoring each resource You can manage the widget by clicking the More button at the top right of the widget You can edit, duplicate, download files, view metrics, and view source of the widget For detailed information on widget management items, see Widget Management

   Table. Dashboard detailed items

Dashboard Management

Dashboard Details page allows you to edit or manage dashboard information and widgets.

Edit Dashboard

You can modify the dashboard name and change the widget configuration.

To modify the dashboard, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
4. Click the Edit button at the top right of the Dashboard Details page. You will be taken to the Dashboard Edit page.
5. After modifying the dashboard’s information or widgets, click the Save button.

   Category	Detailed description
   Dashboard name	Dashboard name cannot be edited Enter within 34 characters using English letters, numbers, and special characters (-_) Dashboard names that are currently in use cannot be used
   Widget Name	Widget name can be edited English letters, numbers, spaces, special characters(-_.\
   Widget Management	When you hover the mouse over a widget, a management button appears on the right side of the widget border Edit: Widget Edit popup allows you to modify the widget’s metrics and resources For details on widget editing, see the Individual Widget Edit in 위젯 관리하기 Duplicate: Duplicate the current widget and add it to the dashboard Delete: Remove the current widget from the dashboard Expand: Display the current widget with an expanded size Collapse: If the widget is expanded, clicking again reduces its size
   Add widget	Add a new widget to the dashboard Add individual widget: Add a single widget that combines metrics and resources Add multiple widgets: Select desired resources per metric to add multiple widgets at once Load dashboard: Load and add widgets from another dashboard For detailed instructions on adding widgets, see Creating Widgets

   Table. Dashboard edit items

View detailed dashboard information

You can view detailed information about the dashboard. To view detailed information of the dashboard, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
4. Dashboard Details page’s top right corner has a More > Details button. Click the button. The Dashboard Details popup opens.

   Category	Detailed description
   Dashboard name	Dashboard name
   Dashboard Category	Dashboard usage classification User: dashboard created directly by the user Service: dashboard composed of automatically pre-built key metrics for each service
   Service	service name
   Resource Type	dashboard
   SRN	Unique resource ID in Samsung Cloud Platform In ServiceWatch, it refers to the dashboard’s SRN
   Resource name	Resource Name In ServiceWatch, the meaning of the dashboard name
   Resource ID	Unique resource ID in the service
   Constructor	User who created the dashboard
   Creation date and time	Dashboard creation date and time
   Editor	User who edited the dashboard information
   Modification date and time	Dashboard information modification timestamp

   Table. Dashboard Details - Detail Information Popup Items

Check the dashboard source code

You can view the dashboard’s source code. To view the source code of the dashboard, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
4. Dashboard Details on the top right of the page, click the More > View Source button. The Dashboard View Source popup opens.

   Category	Detailed description
   Source information	Display the dashboard source code in JSON format
   Copy code	Copy the source code to the clipboard

   Table. Dashboard Details - Dashboard Source View Popup Items

Duplicate Dashboard

You can duplicate a widget from the current dashboard and add it to another dashboard.

To duplicate the dashboard, follow these steps.

1. All Services > Management > ServiceWatch menu, click it. 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 you want to view details for. You will be taken to the Dashboard Details page.

4. Click the More > Duplicate button at the top right of the Dashboard Details page. The Dashboard Duplicate popup opens.

5. After selecting the dashboard duplication method, enter the required information. The required information varies depending on the duplication method.

   Category	Required	Detailed description
   Replication target	-	Name of the dashboard to duplicate
   Cloning method	Required	After duplicating the dashboard widget, select the dashboard to add it to New Dashboard: Create a new dashboard and generate it by duplicating the current dashboard’s widget Existing Dashboard: Duplicate the current dashboard’s widget and add it to an existing dashboard
   Dashboard name	Required	Enter the name of the new dashboard Displayed when the duplication method is set to New Dashboard Enter using English letters, numbers, and special characters (-_) within 3 to 40 characters
   Select Dashboard	Required	Select the dashboard to which the duplicated widget will be added from the existing dashboards Displayed when the duplication method is selected as Existing dashboard

   Table. Dashboard clone items

6. After entering the required information, click the Complete button. A popup notifying that the dashboard is being duplicated will appear.

7. Click the Confirm button on the popup window. The dashboard duplication task is complete.

Delete dashboard

You can delete unused dashboards.

To delete the dashboard, follow these steps.

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 you want to delete, then click the Delete button. A popup confirming the dashboard deletion will appear.
   • You can delete multiple dashboards simultaneously.
   • You can also delete individually by clicking the More > Delete button located at the top right of the Dashboard Details page.
4. In the delete confirmation input field, type Delete and then click the Confirm button. The dashboard will be deleted.

Manage Widgets

Dashboard Details page lets you edit or manage widgets.

Edit Widget

You can modify the widget’s metrics and resources.

To modify the widget, follow these steps.

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 whose widget you want to edit. You will be taken to the Dashboard Details page.
4. On the Dashboard Details page, click the More > Edit Widget button at the top right of the widget you want to edit. The Edit Widget popup will open.
5. After modifying the widget’s metrics and resources, click the Confirm button. The widget modification is complete.

   Category	Required status	Detailed description
   Indicator classification	Select	In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list
   Indicator List Area	Required	List of metrics that can be monitored in ServiceWatch Click the + button in front of the namespace and dimension to view the sub-level list When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
   Search filter area	-	After setting the search items to filter, click the Apply Filter button to filter the metric list Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace Metric Name: 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 top-level category and the entered keyword Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key Tag Key: Search using the selected tag key
   Selected metric area	-	Monitoring chart for the selected metric in the metric list area Data graph collected during the period applied to the chart When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point You can drag the mouse to zoom in on a specific area of the graph Clicking the label name displayed in the legend shows detailed information for that legend in a popup In the table area within the chart, you can view and edit legend labels, statistics, and aggregation periods Legend: color per legend Click a legend color to change it to another color Period: period applied to the chart Metric: displays the selected metric’s namespace, resource name, and metric name Statistics: select the method for aggregating metric data Choose among Average (default), Minimum, Maximum, Sum Aggregation period: select the aggregation period unit for metric values Choose among 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day Delete: remove the legend

   Table. Individual widget additional items

Widget Replication

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

To duplicate a widget, follow these steps.

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

2. 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 you want to duplicate. You will be taken to the Dashboard Details page.

4. On the Dashboard Detail page, click the More > Widget Clone button located at the upper right of the widget to be duplicated. The Widget Clone popup window opens.

5. After selecting the widget duplication method, enter the required information. The required information varies depending on the duplication method.

   Category	Whether required	Detailed description
   Replication target	-	Name of the dashboard to duplicate
   Cloning method	Required	After duplicating the widget, select the dashboard to add it to Existing Dashboard: Add the widget to an existing dashboard New Dashboard: Create a new dashboard and add the widget
   Select Dashboard	Required	Select the dashboard to which the duplicated widget will be added from the existing dashboards When the duplication method is selected as Existing Dashboard, it is displayed
   Dashboard name	Required	Enter the name of the new dashboard Displayed when the duplication method is set to New Dashboard Enter using English letters, numbers, and special characters (-_) within 3 to 40 characters
   Widget name	Required	When adding a widget to the dashboard, enter the widget name English letters, numbers, special characters(-_.\

   Table. Widget duplication items

6. After entering the required information, click the Complete button. A popup window notifying the addition of the widget will open.

7. Click the Confirm button in the popup window. The widget will be duplicated and added to the dashboard.

Download widget file

You can download widget information as a file. To download widget information, follow these steps.

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 from which you want to download widget information. You will be taken to the Dashboard Detail page.
4. Dashboard Details page, click the More > File Download button at the top right of the widget whose information you want to download. The File Download popup window opens.
5. After selecting the file download method, click the Confirm button. The download will start.
   • Download methods can be selected simultaneously.

     Category	Detailed description
     CSV	Convert the widget’s metrics and monitoring data to an Excel (*.csv) file and download it.
     PNG	Convert the widget chart to an image (*.png) file and download

     Table. Widget file download item

Check widget metrics

You can view the widget’s resource and metric information on the Metrics page. To view widget metrics on the metrics page, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. 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 you want to view widget metrics for. You will be taken to the Dashboard Details page.
4. On the Dashboard Detail page, click the More > View Metrics button at the top right of the widget you will view on the Metrics page. You will be taken to the Metrics page.
   • The resources and metric information of the selected widget are automatically configured and displayed on the Metrics page.

Check widget source code

You can view the source code of the dashboard.

To check the dashboard’s source code, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. 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 you want to view details for. You will be taken to the Dashboard Detail page.
4. On the Dashboard Details page, click the More > View Source button located at the top right of the widget to view its source code. The Widget Source View popup will open.

   Category	Detailed description
   Source information	Display the widget source code in JSON format
   Copy code	Copy the source code to the clipboard

   Table. Widget source view item

Download widget file

You can download widget information as a file. To download widget information, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. Dashboard List page, click the dashboard to download widget information. You will be taken to the Dashboard Detail page.
4. Dashboard Details page, click the More > File Download button at the top right of the widget whose information you want to download. The File Download popup window opens.
5. After selecting the file download method, click the Confirm button. The download will start.
   • Download methods can be selected simultaneously.

     Category	Detailed description
     CSV	Convert the widget’s metrics and monitoring data to an Excel (*.csv) file and download it.
     PNG	Convert the widget chart to an image (*.png) file and download

     Table. Widget file download item

Export to Object Storage

You can store widget information in Object Storage.

To store widget information in Object Storage, follow these steps.

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 from which you want to download widget information. You will be taken to the Dashboard Detail page.
4. On the Dashboard Details page, click the More > Export to Object Storage button located at the top right of the widget whose information you want to download. The Export to Object Storage popup will open.
5. After selecting the bucket to store widget information, click the Done button. A popup confirming the save will appear.
6. Click the Confirm button in the popup window. Data export will begin.

2.2 - Alert

In ServiceWatch, you can set threshold criteria for the metrics to be monitored, and create and manage alert policies that generate alert notifications when the specified conditions are met.

Create Alert Policy

You can create an alert policy for a metric and set the criteria for alert triggering. To create an alert policy, follow these steps.

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

3. Click the Create Alert Policy button on the Alert Policy List page. You will be taken to the Create Alert Policy page.

4. After entering the name and description of the alert policy in the Basic Information Input area, click the Select Metric button. The Select Metric popup window will open.

5. Metric Selection In the popup window, after selecting the metric for which to create an alert policy, click the Confirm button. The Metric and Condition Settings area will be displayed.

   Category	Required status	Detailed description
   Indicator classification	Required	In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list
   Indicator List Area	Required	List of metrics that can be monitored in ServiceWatch

   • Click the **+** button in front of the namespace and dimension to view the sub-level list

   • When you select a metric to monitor, it is displayed as a chart in the **Selected Metric** area

   • • If the metric is associated with a namespace, the **Service Dashboard** is displayed

   • • Clicking the **Service Dashboard** navigates to the detailed page of that dashboard

   | | Search filter area | - | After setting the search items to filter, click the **Apply Filter** button to filter the metric list

   • **Namespace-Dimension Name**: Search based on the sub-dimension names of the selected namespace

   • **Metric Name**: 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 top-level category and the entered keyword
     • Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key

   • **Tag Key**: Search using the selected tag key

   | | Selected metric area | - | Monitoring chart for the selected metric in the metric list area

   • Data graph collected during the period applied to the chart
     • When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point
     • You can drag the mouse to zoom in on a specific area of the graph
     • Clicking a label displayed in the legend shows detailed information for that legend in a popup

   • In the table area within the chart, you can view and edit legend labels, statistics, and aggregation periods
     • **Legend**: color for each legend
       • You can click a legend color to change it to another color
     • **Period**: period applied to the chart
     • **Metric**: displays the selected metric's namespace, resource name, and metric name
     • **Statistics**: select the method for aggregating metric data
       • Choose among **Average** (default), **Minimum**, **Maximum**, **Sum**
     • **Aggregation Period**: select the aggregation period unit for metric values
       • Choose among **1 minute**, **5 minutes** (default), **15 minutes**, **30 minutes**, **1 hour**, **3 hours**, **6 hours**, **12 hours**, **1 day**
     • **Delete**: remove the legend

   |

   Table. Indicator selection popup items

6. Set the threshold values for generating alerts in the Indicator and Condition Settings area.

   Category	Required status	Detailed description
   namespace	-	Namespace of the selected metric
   Indicator name	-	Name of the selected metric
   unit	-	Data unit of the selected metric
   Evaluation scope	Required	Time range (seconds) for alarm evaluation Input allowed up to a maximum of 604,800 seconds in multiples of 60 If set smaller than the collection interval or not in a multiple of the collection interval, alarm evaluation may be applied abnormally
   Statistics	Required	Select the method for calculating metric data over the evaluation range Sum: The sum of all data point values collected during the period Average: The value obtained by dividing the Sum over the specified period by the number of data points during that period Minimum: The lowest value observed during the specified period Maximum: The highest value observed during the specified period
   Additional configuration	Select	Setting evaluation count, violation count, and missing data handling method When the additional configuration is set to Use, you can set the evaluation count and violation count used for alarm evaluation. If the number of violations meets the condition within the evaluation count during the evaluation period (seconds), the alarm state changes to Alert Evaluation Count: Number of evaluations that trigger an alarm 1 ~ 8,640 enterable range Violation Count: Allowed number of violations before an alarm is triggered 1 ~ Evaluation Count enterable range If the evaluation period is less than 1 hour (3,600 seconds), evaluation count/evaluation period can be set up to a maximum of 1 day (86,400 seconds) If the evaluation period is 1 hour (3,600 seconds) or more, evaluation count/evaluation period can be set up to a maximum of 7 days (604,800 seconds) When the additional configuration is set to Use, you can specify how to handle missing data during alarm evaluation. Treat missing data as missing (Missing) Ignore missing data and maintain the current alarm state (Ignore) Treat missing data as satisfying the condition (Breaching) Treat missing data as not satisfying the condition (Not breaching)
   Condition setting	Required	Condition Operator: After calculating metric data over the evaluation period, select a condition operator to compare the value with the threshold Threshold: After calculating metric data over the evaluation period, set the threshold to compare the value with the condition operator Input allowed from 0 ~ 2,147,483,647 Condition: Explanation of alert state (Alert) change conditions based on the configured Condition Operator and Threshold
   Alert level	Required	Select alert stage based on the importance of the alert policy
   Resource ID	-	Metric monitoring target resource ID
   Resource Name	-	Metric Monitoring Target Resource Name

   Table. Indicator and Condition Setting Items

7. In the Notification Settings area, select the user who will receive notifications when an alarm occurs.

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

8. Add tag information in the Additional Information Input area.
9. After reviewing the summary information, click the Create button. A popup indicating the creation of the alert policy will open.
10. Click the Confirm button. The alert policy has been created.

Check detailed alert policy information

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

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. You will be taken to the Alert Policy List page.
   • In the Alert Policy menu, you can click the Alert Level button to filter and view only the list of alert policies that correspond to that alert level.
3. On the Alert Policy List page, click the alert policy name to view its details. You will be taken to the Alert Policy Details page.

   Category	Detailed description
   Alert policy status	Alert policy status Active: The alert policy is in an active state Inactive: The alert policy is in an inactive state You can change it by clicking the Activate or Deactivate button
   Delete alarm policy	Delete the relevant alert policy
   Alarm status	Current alert status Normal: when the metric does not meet the configured condition Insulfficient data: when the metric data cannot be verified (missing, nonexistent, not arrived) Alert: when the metric meets the configured condition When the alert status is Alert, display the alert level (>High, Middle, Low) as well
   Metric Monitoring Chart	Metric monitoring chart for the configured period For details on the monitoring chart, refer to Metric Monitoring
   Information Classification Tab	Alert policy information tabs Details, notifications, alert history, tags, operation history Click each tab to view the corresponding information

   Table. Alarm detailed items

Detailed Information

On the Alert Policy List page, you can view the selected alert policy’s basic information and metric information.

Notification

On the Alert Policy List page, you can view the notification recipients of the selected alert policy.

Alert History

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

tag

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

Job History

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

Modify Alert Policy

You can modify the target metrics and policy settings of the alert policy. To modify the alert policy, follow these steps.

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. It navigates to the Alert Policy List page.
3. On the Alert Policy List page, click the alert policy name to view detailed information. You will be taken to the Alert Policy Details page.
4. On the Detail Information tab of the Alert Policy Details page, click the Edit button of Metric Information. The Edit Metric Information popup opens.
5. After modifying the metric information and policy settings, click the Confirm button. A popup notifying the metric modification will open.
   • For detailed information on metric modification items, please refer to Create Alert Policy.
6. Click the Confirm button. The alert policy update is complete.

Disable Alert Policy

You can disable the alert policy to stop sending notifications when the alert status changes. Even if the alert policy is disabled, alert evaluation continues, and alert history accumulates as the alert status changes. However, notifications are not sent.

If you want to block receiving notifications for a specific period, you can disable the corresponding alert policy.

To disable the alert policy, follow these steps.

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 Details page, click the Disable button. The Alert Policy Deactivation Notification popup opens.
4. Click the Confirm button. Check the status of the alert policy.

Activate Alert Policy

You can enable the alert policy to resume sending notifications when the alert status changes. To enable the alert policy, follow these steps.

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 Details page, click the Enable button. The Alert Policy Activation Notification popup window opens.
4. Click the Confirm button. Check the status of the alert policy.

Delete Alert Policy

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

1. All Services > Management > ServiceWatch menu, click it. 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 notifying the alert policy deletion will appear.
   • You can delete multiple alert policies at once.
   • 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. Click the Confirm button. The alert policy will be deleted.

2.3 - indicator

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

Check Indicators

You can view the metrics available in ServiceWatch. To check the indicator, follow these steps.

1. All Services > Management > ServiceWatch menu, click it. 1. Go to the Service Home page.
2. On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
3. Check the metrics in the metric list on the Metrics page.

Manage Indicator Charts

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

Add as widget

You can add the selected metric as a widget to the dashboard.

To add a metric as a widget, follow these steps.

1. All Services > Management > ServiceWatch Click the menu. 1. Go to the Service Home page.

2. On the Service Home page, click the Metrics menu. 2. Navigate to the Indicator page.

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

4. After configuring the table area in the monitoring chart of the Selected metric region, click the More > Add widget button. 4. Add Widget The popup window opens.

5. After selecting the method to add the widget, enter the required information. 5. The required information varies depending on the addition method.

   Category	Required status	Detailed description
   Replication Method	Required	After duplicating the widget, select the dashboard to add it to Existing Dashboard: Add the widget to the existing dashboard New Dashboard: Create a new dashboard and add the widget
   Select Dashboard	Required	Select the dashboard to which the duplicated widget will be added among the existing dashboards Displayed when the duplication method is selected as Existing Dashboard
   Dashboard name	Required	Enter the name of the new dashboard Displayed when selecting the duplication method as New Dashboard Enter using English letters, numbers, and special characters (-_) within 3 ~ 40 characters
   Widget name	Required	When adding a widget to the dashboard, enter English letters, numbers, special characters(-_.\

   Table. Widget additional items

6. When you have finished entering the required information, click the Complete button. 6. A popup window notifying the addition of a widget opens.

7. Click the Confirm button on the popup window. 7. A widget will be added to the dashboard.

Share monitoring chart URL

You can download monitoring chart information as a file. To download the monitoring chart information, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
2. On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
3. Select the metric to monitor from the metric list on the Metrics page. 3. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. After setting the table area in the monitoring chart of the Selected metric region, click the More > URL Share button. 4. URL sharing A popup window opens.
5. In the URL Share popup, click the Copy URL button. 5. The generated URL is copied.
   • Information within the monitoring chart is provided as metadata links.

Download Monitoring Chart File

You can download monitoring chart information as a file. To download the monitoring chart information, follow these steps.

1. All Services > Management > ServiceWatch menu, click it. 1. Go to the Service Home page.
2. On the Service Home page, click the Metrics menu. 2. Navigate to the Indicator page.
3. Select the metric to monitor from the metric list on the Metric page. 3. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. In the monitoring chart of the selected metric area, set the table region, then click the More > File Download button. 4. File Download popup window opens.
5. After selecting the file download method, click the Confirm button. 5. The download will start.
   • The download method can be selected simultaneously.

     Category	Detailed description
     CSV	Convert chart metrics and monitoring data to an Excel (*.csv) file and download
     PNG	Convert the chart to an image (*.png) file and download Available only when the metric comparison mode is set to Metric Comparison Up to 100 metric data items can be downloaded

     Table. Indicator monitoring file download item

Export to Object Storage

You can store monitoring chart data in Object Storage.

To store monitoring chart data in Object Storage, follow these steps.

1. All Services > Management > ServiceWatch click the menu. 1. Go to the Service Home page.
2. On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
3. Select the metric to monitor from the metric list on the Metric page. 3. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. In the monitoring chart of the Selected metric area, after setting the table region, click the More > Export to Object Storage button. 4. Object Storage Export The popup window opens.
5. After selecting the bucket to store the data, click the Done button. 5. A popup window notifying data saving opens.
6. Click the Confirm button in the popup window. 6. Data export is starting.

View monitoring chart source

You can view the source code of the monitoring chart.

To view the source code of the monitoring chart, follow these steps.

1. Click the All Services > Management > ServiceWatch menu. 1. Go to the Service Home page.
2. On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
3. Please select the metric to monitor from the metric list on the Metric page. 3. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. After setting the table area in the monitoring chart of the selected metric region, click the More > View Source button. 4. View Widget Source A popup window opens.

   Category	Detailed description
   Source information	Display the source code of the monitoring chart in JSON format
   Copy code	Copy the source code to the clipboard

   Table. Monitoring chart source view items

2.4 - Log

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

Create Log Group

You can create a log group for the metric. To create a log group, follow these steps.

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

   Category	Whether required	Detailed description
   Log group name	Required	Enter the name of the log group to monitor in ServiceWatch using English letters, numbers, and special characters (-_./#) within 3 ~ 512 characters
   Log retention policy	Required	Select the retention period for monitored log data
   Tag	Select	Add tag information Up to 50 tags can be added per resource When adding a tag, entering the Key and Value allows selection from the list of previously created tag Keys and Values

   Table. Log group creation items

5. After reviewing the summary information, click the Create button. A popup notifying the creation of the log group will appear.

6. Click the Confirm button. Log group creation is complete.

Check log group details

You can view and manage detailed information about log groups.

To view detailed information about the log group, follow these steps.

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 to view detailed information. You will be taken to the Log Group Details page.

   Category	Detailed description
   Log group status	Log group status Active: The log group is in an active state Inactive: The log group is in an inactive state
   Export Log Group	Store log group log data in Object Storage For detailed information on log group export, see Log Group Export
   Delete log group	Delete the corresponding log group
   Information Classification Tab	Information tabs for log groups Details, Log Streams, Tags, Activity History Click each tab to view the corresponding information

   Table. Log Group Details

   Reference

   On the Log Group List page, click the More > Export Log Group button for the log group you want to store in Object Storage to export the data.

Detailed Information

Log Group List page allows you to view the basic information and details of the selected log group.

Log Stream

Log Group List page allows you to view the log streams of the selected log group.

log pattern

Log Group List page allows you to view the log pattern of the selected log group.

tag

On the Log Group List page, you can view the tag information of the selected log group and add, modify, or delete it.

Job History

Log Group List page lets you view the operation history of the selected log group.

Managing Log Streams

You can create and manage log streams.

Create Log Stream

You can create a new log stream in a log group. To create a Hog stream, 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 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 Details page.
4. Log Group Details page, click the Log Stream tab. The Log Stream list is displayed.
5. Click the Create Log Stream button. The Create Log Stream popup opens.
6. Enter the Log stream name, then click the Create button. Log stream creation is completed.
   • Enter the name using English letters and numbers, within 3~512 characters.

Check detailed log stream information

You can view and manage detailed information about log streams. To view detailed information about the log stream, follow these steps.

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. Click the log group name on the Log Group List page to view detailed information. You will be taken to the Log Group Details page.
4. On the Log Group Details page, click the Log Stream tab. The Log Stream list is displayed.
5. Click the log stream name in the Log Stream list to view its details. You will be taken to the Log Stream Details page.

   Category	Detailed description
   Excel download	Log stream history can be downloaded as an Excel file
   Timestamp list	Message list by timestamp Period selection, User time zone, can filter using message input

   Table. Log group details - 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 Stream Details page.

Delete Log Stream

You can delete unused log streams. To delete a log stream, follow these steps.

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 whose log stream you want to delete. You will be taken to the Log Group Details page.
4. Log Group Details page, click the Log Stream tab. The log stream list will be displayed.
5. Select the checkbox of the log stream to delete in the log stream list, then click the More > Delete button. A popup notifying the log stream deletion will open.
   • You can delete multiple log streams simultaneously.
   • You can also delete each individually by clicking the Delete button at the right end of each log stream.
6. Click the Confirm button. The log stream will be deleted.

Managing Log Patterns

Create Log Pattern

To create a log pattern, follow these steps.

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

4. Log Group Details page, click the Log Pattern tab. The log pattern list will be 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.

   • In the Basic Information area, enter and select the basic information for the log pattern.

     Category	Required	Detailed description
     Log pattern name	Required	Enter the name of the log pattern using English letters, numbers, and special characters (-_./#) within 3 ~ 512 characters
     Pattern format	Required	Select a pattern format or enter manually Pattern format: Choose one of the string pattern, space-delimited pattern, or JSON format pattern provided as pattern formats Direct input: After selecting one of the string pattern, space-delimited pattern, or JSON format pattern, enter a value between 1 ~ 1,024
     Pattern test	Select	Enter or select log data to verify using a pattern Direct Input: Enter the log data to be used directly into the Log Event Message Separate log events using line breaks Up to 50 log events can be entered Each log event can be entered within 1 ~ 1,024 bytes Log Data Selection: Choose the log data to use When selecting log data, the corresponding log data is displayed in the Log Event Message Pattern Test: Conduct a test on the log event message If the test succeeds, the test result is displayed at the bottom

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

     Category	Required status	Detailed description
     namespace	Required	Select a namespace for the log pattern If there is no namespace for the log pattern, Create New to create one Namespace Name: When creating a new namespace, use English letters, numbers, spaces, and special characters(-_\/#) to enter between 3 ~ 128 characters
     Indicator Name	Required	Enter the name of the indicator using English letters, numbers, and special characters(_) within 3 ~ 128 characters
     indicator value	Required	Enter the indicator value a number greater than or equal to 0 or $indetifier
     default	Select	If you use the default value, enter 0 or greater float value When using the default, dimension cannot be used
     unit	Required	Select indicator unit
     dimension	Selection	Set the dimension of metrics generated by log patterns Log pattern format is available only when it is a space-delimited pattern or a JSON format pattern Default value cannot be used when entered If Use is checked, you can add custom dimension fields After clicking the Add button, add by entering Field name and Field value You can add up to a maximum of 3

     Table. Log pattern generation - metric information items

7. After reviewing the summary information, click the Create button. A popup indicating log pattern creation will appear.

8. Confirm click the button. Log pattern generation is complete.

Check detailed log pattern information

To view detailed information about the log pattern, follow these steps.

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. Click the log group name to view detailed information on the Log Group List page. You will be taken to the Log Group Details page.
4. Log Group Details page, click the Log Pattern tab. The log pattern list will be displayed.
5. Log pattern Click the log pattern name in the list to view its details. Log pattern details page will open.

   Category	Detailed description
   Create alert policy	Alert policy creation available When the button is clicked, navigate to the alert policy creation page
   Delete log pattern	Delete the log pattern currently being examined
   Log pattern name	Log pattern name
   constructor	User who created the log pattern
   Creation date and time	Log pattern creation timestamp
   Editor	User who modified the log pattern information
   Modification date	Date and time the log pattern information was modified
   Pattern	Pattern format
   Indicator Information	Metric information of the pattern group Namespace name, metric name, metric value, default value, unit, alarm policy name, dimension name Edit button allows modification of metric value, default value, unit information

   Table. Log pattern detailed items

Delete log pattern

To delete a log pattern, follow these steps.

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 whose log pattern you want to delete. You will be taken to the Log Group Details page.
4. On the Log Group Details page, click the Log Pattern tab. The log pattern list will be displayed.
5. After selecting the checkbox of the log pattern to delete in the log pattern list, click the Delete button. A popup notifying the log pattern deletion will open.
   • You can delete multiple log patterns simultaneously.
   • You can also delete individually by clicking the More > Delete button at the far right of each log pattern, or by clicking the Delete Log Pattern button on the log pattern’s detail page.
6. Click the Confirm button. The log pattern will be deleted.

Export Log Group

Log group data can be stored in Object Storage. To store log group data in Object Storage, follow these steps.

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

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

   Category	Required	Detailed description
   Select log group	Required	Select the log group to store in Object Storage If the log group contains log streams, you can click the Select button to choose the log stream to store If no log group is selected, the entire data of the log group will be stored
   Select period	Select	Select the user time zone and data storage interval In the Time Settings area, you can select the desired interval or click the Enter Manually button to set the start and end date and time
   storage bucket	Required	Select the bucket to store data Up to 50 tags can be added per resource When adding a tag, entering the Key and Value allows you to select from the list of existing tag Keys and Values

   Table. Log group export items

4. After selecting the bucket to store the data, click the Complete button. A popup notifying that the data has been saved will open.

5. In the popup window, click the Confirm button. Data export will begin.

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

Delete Log Group

You can delete unused log groups.

To delete a log group, follow these steps.

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 you want to delete, then click the Delete button. A popup notifying the log group deletion will appear.
   • You can delete multiple log groups simultaneously.
   • You can delete individually by clicking the Delete button at the far right of each log group, or by clicking the Delete Log Group button on the Log Group Details page.
4. Click the Confirm button. The log group will be deleted.

2.5 - Event

You can view and handle events generated by the Samsung Cloud Platform service in ServiceWatch.

Create Event Rule

You can create an event rule to receive notifications when an event occurs. To create an event rule, follow these steps.

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

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

4. Enter the name and description of the event rule in the Basic Information Input area.

5. Set the required information in the Event Pattern Configuration area. The configured event pattern is entered in Event Pattern Configuration Status as JSON code.

   Category	Required status	Detailed description
   Event source	Required	Select the service name of the event you want to receive in ServiceWatch Refer to the event source list Event Source
   Event type	Required	Select the event type of the event source to use in the event rule Classify the same as the resource type
   Apply Event	Required	Select events to apply the event pattern from events generated by the event type All events: Apply all events generated by the event type Individual events: Choose events from those generated by the event type to set as the event pattern
   Applied resource	Required	Select the resource to apply the event pattern All resources: Set the event pattern for events that occur in all resources Individual resource: Set the event pattern for the specific event that occurs in a particular resource When an individual resource is selected, display the event resource selection area Add resource button can be clicked to select resources Added resources can be removed by selecting the resource in the resource list and clicking the Delete button
   Event Pattern Configuration Status	-	Convert and display in JSON code format according to the event pattern settings Changing the event pattern settings will reset Copy code item can be clicked to copy the source code

   Table. Event pattern configuration items

6. In the Notification Settings area, select the users who will receive notifications when an event occurs.

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

7. Add tag information in the Additional Information Input area.
8. After checking the summary information, click the Create button. A popup notifying the creation of an event rule will open.
9. 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. You will be taken to the Service Home page.
2. On the Service Home page, click the Event Rules menu. You will be taken 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.

   Category	Detailed description
   Event rule status	Event rule status Active: The event rule is in an active state Inactive: The event rule is in an inactive state You can change it by clicking the Activate or Deactivate button
   Delete event rule	Delete the corresponding event rule
   Information Category Tab	Information tabs for alert policies Details, notifications, tags, activity history Click each tab to view the corresponding information.

   Table. Event rule details

Detailed Information

Event Rule List page lets you view the basic information and event rule details of the selected rule.

Notification

Event Rule List page allows you to view the notification recipients of the selected event rule.

tag

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

Job History

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

Modify event pattern

You can modify the event pattern. To modify the event pattern, follow these steps.

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 Rules menu. You will be taken to the Event Rules List page.
3. Event Rule List page, click the event name to edit the event pattern. You will be taken to the Event Rule Details page.
4. Click the Edit button in the Event Pattern Configuration Status on the Event Rule Details page. The Edit Event Pattern popup opens.
5. After modifying the event pattern settings, click the Confirm button. A popup notifying the event pattern modification will appear.
   • For detailed information on the event pattern modification items, refer to Creating Event Rules.
6. Click the Confirm button. The event pattern modification is complete.

Delete Event Rule

You can delete unused event rules. To delete an event rule, follow these steps.

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 Rules menu. You will be taken to the Event Rules List page.
3. On the Event Rule List page, select the checkbox of the event rule you want to delete, then click the Delete button. A popup notifying the deletion of the event rule will appear.
   • You can delete multiple event rules simultaneously.
   • 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. Click the Confirm button. The event rule will be deleted.

2.6 - Using ServiceWatch Agent

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 to collect custom metrics and logs for ServiceWatch can be divided into two main types. It is a Prometheus Exporter and Open Telemetry Collector.

Pre-configuration for ServiceWatch Agent

You need to add a Security Group and firewall rules to enable communication between the ServiceWatch Agent and ServiceWatch.

1. Add Security Group rule

   • To transmit the data collected by ServiceWatch from the ServiceWatch Agent installed on Virtual Server/GPU Server to ServiceWatch, you need to add a rule to the Security Group as follows.

     Direction	type	Port	Target address
     Outbound	Custom TCP	443	ServiceWatch OpenAPI Endpoint IP Address

     Table. Security Group rules for ServiceWatch Agent communication

2. Add firewall rule

   • If you configure the VPC’s Internet Gateway to use a firewall, you must add firewall rules as shown below.

     Direction	type	Port	Operation	Source address	Destination address
     Outbound	TCP	443	Allow	When creating a Virtual Server, the assigned Private IP address. The Virtual Server Private IP address can be found in Check 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 the ServiceWatch Agent to send the data collected to ServiceWatch is as follows.

Open Telemetry Collector configuration for ServiceWatch

Install the OpenTelemetry Collector on the server following the steps below to collect ServiceWatch metrics and logs.

1. Download the Agent file from the URL that provides the Agent file 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 found as follows.
   • Extract the Agent file for ServiceWatch.
     • Tab 0

     Sample Code Download

     Copy Code

     Color mode

     unzip ServiceWatch_Agent.zip

     unzip ServiceWatch_Agent.zip

   • When using the ServiceWatch Agent on a Linux OS, you must grant execution permission as shown below.
     • Tab 0

     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 agent.json, log.json, metric.json example files os-metrics-min-examples: Minimal metric configuration example using Node Exporter os-metrics-all-examples: Example of memory/filesystem Collector metric configuration using Node Exporter gpu-metrics-min-examples: Minimal metric configuration example 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 in ServiceWatch Agent Manager for the ServiceWatch Open Telemetry Collector.

   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 for separating custom metrics A namespace must be 3 to 128 characters long, may include 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 a Virtual Server
   openApiEndpoint	ServiceWatch OpenAPI endpoint per region/offering Example: https://servicewatch.region.offering.samsungsdscloud.com region and offering information can be found in the Samsung Cloud Platform Console access URL
   telemetryPort	ServiceWatch Agent’s Telemetry Port is typically used on port 8888. If port 8888 is in use, it needs to be changed

   Table. agent.json configuration file entries
   • Tab 0

   Sample Code Download

   Copy Code

   Color mode

   {
      "namespace": "swagent-windows",     # Custom namespace for user-defined 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. If port 8888 is in use, change it)
   }

   {
      "namespace": "swagent-windows",     # Custom namespace for user-defined 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. If port 8888 is in use, change it)
   }

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

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

     Category	Detailed description
     prometheus > scrape_configs > targets	Endpoint of the metric collection target For servers, because the Prometheus Exporter is installed on the same machine, set it to that endpoint Example: localhost:9100
     prometheus > scrape_configs > jobName	Set the Job Name. Usually set it 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, include letters, numbers, and special characters (_), and start with a letter. Example: node_cpu_seconds_total
     metricMetas > dimensions	Set the label of the Collector, among those provided to identify the source of the Exporter’s metric data, for visualization in the Console. When visualizing the collected metrics in the Console, combine them according to the dimensions setting. Example: For metrics like the Memory Collector of Node Exporter that do not provide a special label, set it to resource_id. Example: The Filesystem Collector metrics of Node Exporter can have the mountpoint, which represents the path where the filesystem is mounted on the system, set as a dimension.
     metricMetas > unit	Metric unit can be set Example: Bytes, Count, etc.
     metricMetas > aggregationMethod	Method to aggregate based on specified dimensions(dimensions) Example: select from SUM, MAX, MIN, COUNT
     metricMetas > descriptionKo	Korean description of the metrics being collected
     metricMetas > descriptionEn	English description of the metrics being collected

     Table. metric.json configuration file entries
     • Tab 0

     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 used for visualizing in the Console among the Collector's labels provided to identify the source of Node Exporter's metric data
                                         # If no specific label is provided, such as for the Memory-related metric, set it to **resource_id**.
                 ]
              ],
              "unit": "Bytes",           # unit of the 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 with ServiceWatch among the metrics collected from the Prometheus Exporter
              "dimensions": [
                 [
                    "mountpoint"        # Set the label for visualizing in the Console among the Collector labels provided to identify the source of Node Exporter's metric data.
                                        # Set the dimension (dimensions) of the Filesystem-related metric to the mountpoint, which indicates the path where the filesystem 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 used for visualizing in the Console among the Collector's labels provided to identify the source of Node Exporter's metric data
                                         # If no specific label is provided, such as for the Memory-related metric, set it to **resource_id**.
                 ]
              ],
              "unit": "Bytes",           # unit of the 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 with ServiceWatch among the metrics collected from the Prometheus Exporter
              "dimensions": [
                 [
                    "mountpoint"        # Set the label for visualizing in the Console among the Collector labels provided to identify the source of Node Exporter's metric data.
                                        # Set the dimension (dimensions) of the Filesystem-related metric to the mountpoint, which indicates the path where the filesystem 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"
           }
        ]
     }

   • To display the resource name, set resource_name in commonLabels as shown below, and also set resource_name in metricMetas.dimensions; then ServiceWatch can retrieve the metric along with the resource name.
     • Tab 0

     Sample Code Download

     Copy Code

     Color mode

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

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

5. Defines the log configuration file for collecting logs for ServiceWatch.

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

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

     Table. log.json configuration file entries
     • Tab 0

     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 a regular expression
              "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"   # 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 a regular expression
              "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"   # Log stream name within the pre‑created ServiceWatch log group
        }
     }