ServiceWatch

• 1: Overview
• 1.1: Metrics
• 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: Metric
• 2.4: Logs
• 2.5: Events
• 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: PostgreSQL(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 collects metrics, logs, and events of resources created on the Samsung Cloud Platform, monitors them, and provides various tools to offer observability of resource performance, operational status, and more.

Key Advantages

It provides the following key advantages.

• Resource Monitoring: Collects and visualizes performance metrics (e.g., CPU Usage) of resources. It also creates a dashboard that visualizes multiple metrics in one place for a quick overview.
• Alert Policy Configuration and Automatic Notifications: Users can define conditions and thresholds to create alert policies, and receive notifications when thresholds are exceeded, enabling rapid detection and response to resource status.
• Log Analysis and Storage: Collects logs generated by resources for easy retrieval and searching. Collected logs are stored in log groups, with up to 5 GB of storage provided for free. Users can set log retention policies to define retention periods, and logs older than the retention period are automatically managed.
• Cost Efficiency: ServiceWatch offers a flexible pay-as-you-go pricing model for cost-effective usage. A free tier is also provided, allowing users to try the service for free and scale to paid usage as needed.

Features Provided

The following features are provided.

• Metric Monitoring
  • Metrics: ServiceWatch receives metric data from Samsung Cloud Platform services, collects and stores this data, and makes it available to users.
  • Dashboard: Visualizes metrics of a single region to provide an integrated view of resources. ServiceWatch distinguishes between automatically generated service dashboards and user-created custom dashboards.
  • Alert: Offers alert functionality that notifies when metrics change beyond user-defined thresholds.
• Log Monitoring
  • ServiceWatch provides log management capabilities. Logs collected from Samsung Cloud Platform services are stored in log groups for management. Log retention policies can be set to control log retention periods. Users can also view and search log data via the console, and export log groups to Object Storage.
• ServiceWatch Agent
  • With the ServiceWatch Agent, detailed metrics on processes, CPU, memory, disk usage, and network performance can be collected from Virtual Server, GPU Server, Bare Metal Server, etc. GPU performance metrics can also be collected. Additionally, the Agent can collect logs generated by resources. (Planned for December 2025)
• Event Monitoring
  • ServiceWatch can create event rules from system events reflecting changes to resources created on Samsung Cloud Platform, allowing users to receive notifications when specific conditions are met.

Components

Metrics

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

Metric data can be retained for up to 15 months (455 days). For detailed information about metrics, see Metrics.

Logs

Logs from resources such as Virtual Server, Kubernetes Engine, and other services on Samsung Cloud Platform can be collected, stored, and viewed.

For detailed information about logs, see Logs.

Events

Events represent changes in the environment from Samsung Cloud Platform services. The following are examples of events.

• An event is generated when a Virtual Server’s status changes from Stopped to Running.
• An event is generated 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, see Events.

Dashboards

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

ServiceWatch Agent

The ServiceWatch Agent is a software component that collects metrics and logs from Virtual Server, GPU Server, and On-Premise servers, enabling more granular monitoring of infrastructure and applications beyond the basic monitoring provided by default.

Limitations

The following shows the monthly free tier details for ServiceWatch.

Regional Availability

ServiceWatch is available in the following regions.

Prerequisite Services

ServiceWatch has no prerequisite services.

1.1 - Metrics

Metrics

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

Metric data is retained for 15 months (455 days), allowing access to both recent and historical data.

Namespace

Namespace is a logical separation used to distinguish and group metrics in ServiceWatch. Most Samsung Cloud Platform services use a namespace that matches the service name, which can be found in the ServiceWatch Integrated Services List.

For custom metrics, users can define a namespace that distinguishes them from other metrics within ServiceWatch, either via ServiceWatch Agent configuration or via the OpenAPI. For details on custom metrics and logs, see Custom Metrics and Logs.

Metrics

Metrics represent an ordered set of data points collected by ServiceWatch over time. Each data point consists of a timestamp, the collected value, and the unit of measurement.

For example, the CPU usage of a specific Virtual Server is one of the default monitoring metrics provided by Virtual Server. Data points can be generated by any application or activity that collects data.

By default, Samsung Cloud Platform services integrated with ServiceWatch provide free metrics for resources. Detailed monitoring for certain resources is available as a paid offering and can be enabled per service.

Metrics can only be queried in the region where they were generated. Users cannot manually delete metrics. However, if no new data is posted to ServiceWatch, metrics automatically expire after 15 months. Data points older than 15 months (455 days) are sequentially expired, and when new data points are added, those older than 15 months are deleted.

Timestamp

The timestamp of a data point indicates the time at which the data point was recorded. Each metric data point is composed of a timestamp and a value.

A timestamp consists of hour, minute, second, and date.

Metric Retention Period

ServiceWatch retains metric data as follows.

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

Data points initially collected at a short interval are downsampled for long-term storage. For example, if data is collected at a 1‑minute interval, it is retained at 1‑minute granularity for 15 days. After 15 days, the data remains available but can only be queried at 5‑minute intervals. After 63 days, the data is further aggregated and provided at 1‑hour intervals. If metric data points need to be retained longer than the retention period, they can be separately archived using the File Download or Object Storage Export features.

Dimensions

Key-value pairs that serve as unique identifiers for metrics, allowing data points to be categorized and filtered.

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

Collection Interval

Refers to the frequency at which data points for each service’s metrics are collected, as provided by the service-defined collection interval.

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

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

Statistics

Statistics define how metric data is aggregated over a specified period. ServiceWatch provides aggregated data based on the metric data points supplied by each service to ServiceWatch. Aggregation uses the namespace, metric name, dimensions, and data point units within the defined aggregation period.

The provided statistics are Sum, Average, Minimum, and Maximum.

• Sum: The sum of all data point values collected during the period.
• Average: The sum of all data point values divided by the number of data points during the period.
• Minimum: The lowest observed value during the period.
• Maximum: The highest observed value during the period.

Units

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

Aggregation Period

Each statistic calculates metric data points collected over the chosen aggregation period. The aggregation period can be selected from 1 minute, 5 minutes, 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, and 1 day, with a default of 5 minutes. The aggregation period is closely tied to the metric data point collection interval, and for valid aggregation results, the aggregation period must be equal to or longer than the collection interval.

For example, if the statistic is Average, the aggregation period is set to 5 minutes, and a metric with a 1‑minute collection interval is selected, data points are collected every minute and the average is computed over the 5‑minute window. Conversely, if the aggregation period is shorter than the collection interval, valid aggregation results cannot be obtained.

Downsampling is applied for long‑term retention of metric data. For example, if data is collected at a 1‑minute interval, after 15 days it can only be queried at 5‑minute granularity. Setting the aggregation period from 5 minutes to 30 minutes for such metrics may require up to 5 minutes to retrieve the downsampled data. After 63 days, the data is further aggregated and provided at 1‑hour intervals. Selecting an aggregation period from 1 hour to 1 day may require up to 1 hour for data retrieval due to aggregation processing delays.

Alerts

When creating an alert policy, a metric is evaluated over the specified evaluation window, and if it meets the condition set based on the threshold, users receive an alert notification.

Alert states are Alert, Normal, and Insufficient data.

• Alert: The metric meets the set condition.
• Normal: The metric does not meet the set condition.
• Insufficient data: No metric data exists, the metric data is missing, or data has not yet arrived.

When the alert state is Alert, if the evaluation later falls outside the condition, the alert state reverts to Normal.

For more details on alerts, see the Alert section.

Basic Monitoring and Detailed Monitoring

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

Samsung Cloud Platform services integrated with ServiceWatch publish a basic set of metrics to ServiceWatch for free, providing basic monitoring. As soon as any of those services are used, basic monitoring is automatically enabled and visible in ServiceWatch.

Detailed monitoring is available for select services and incurs charges. To use detailed monitoring, it must be enabled in the service’s detailed settings.

The detailed monitoring options vary depending on the service.

• For Virtual Server, the default monitoring collection interval is 5 minutes. Enabling detailed monitoring changes the collection interval for those metrics from 5 minutes to 1 minute.
• Object Storage provides basic metrics for default monitoring, and enabling replication metrics adds additional replication metrics.

The following includes services that provide detailed monitoring and their guides.

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

• Alert Policy
  • Alarm Status
  • Alert Evaluation
    • Evaluation Scope
    • Condition
  • Alert Notification
  • How to handle missing data during alarm evaluation
• Alarm History

Alert Policy

Alert policies can monitor metrics of the same Account and evaluate alerts for a single metric. These alert policies compare the specified threshold and metric conditions, and send notifications when the conditions are met.

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

When you enable the alert policy, evaluation of the alert policy begins, and according to the set conditions, the alert status changes to Alert, and a notification is sent each time the alert status changes.

The alarm policy status allows you to check whether the alarm policy is enabled/disabled.

You can set alert levels for the alert policy. Depending on the alert level, the alert color (red/pink/purple) is expressed differently so that the levels can be visually distinguished by color. You can filter according to the alert policy’s alert level and retrieve the alert policy by each alert level.

Alarm Status

Alert status changes according to the alert evaluation of the alert policy. Alert status 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 counts, 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 counts, the evaluation interval is 30 minutes.

Evaluation Scope

The evaluation scope of the alarm policy is the evaluation time range for alarm evaluation.

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

Condition

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

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

Alarm Notification

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

Method for handling missing data during alarm evaluation

Some resources may not be able to send metric data to ServiceWatch under certain conditions. For example, if a specific resource is inactive or does not exist, it will not be sent to ServiceWatch. If metrics are not collected for a certain period, the alarm state will be changed to Insufficient data by the alarm evaluation.

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

• Ignore: Maintain the current alarm state. (default)
• Missing: Treat missing data points as missing. If all data points within the evaluation range are missing, the alarm state switches to Insufficient data state.
• Breaching: Treat as satisfying the threshold condition for missing data points.
• Not breaching: Process as normal for missing data points that do not satisfy the threshold condition.

Alert History

The change history for 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

A log group is a container 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 Kubernetes Engine cluster, you can group the log streams into a single log group called /scp/ske/{cluster name}.

Log Retention Policy

Log retention policy can set the period for storing log events in ServiceWatch. Log events whose 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 and is set in days.

Log Stream

A log stream is a collection of log events sorted in the order they occurred from the same source. For example, all log events generated in a particular Kubernetes Engine cluster can constitute a single log stream.

Log Event

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

Log Pattern

You can create a log pattern to filter log data that matches the pattern. A log pattern defines the words or patterns to search for in the log data collected by ServiceWatch, allows you to view the status of log occurrences in a graph, and creates metrics that can be used to generate 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 for distinguishing and grouping 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
• Namespace composed of custom metrics, the namespace of metrics collected via the custom metrics API or ServiceWatch Agent
• Namespace of the metric created by the log pattern

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

Indicator Name

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

Indicator 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

It is the value recorded in the log pattern during periods when no matching logs can be found while collecting logs. Setting the default to 0 can prevent the metric from becoming irregular due to periods with no matching data in all such intervals.

If you set a dimension for a metric generated by a log pattern, you cannot set a default value for that metric.

Dimension

A dimension is a key-value pair that defines a metric additionally. You can add dimensions to metrics generated from log patterns. Since a dimension is part of a unique identifier for a metric, each time a unique name/value pair is extracted from the log, a new variant of that metric is created.

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

Pattern Format

This explains how ServiceWatch interprets data in 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: logs separated by spaces such as timestamps, IP addresses, strings, etc.
• JSON format pattern: logs containing specific JSON fields

Available regular expression syntax

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

Only the following can be included in patterns that contain regular expressions.

• Alphanumeric - Alphanumeric refers to characters that are letters (A~Z or a~z) or numbers (0~9).
  • A-Z, a-z, 0-9 can be used as.
• The supported symbol characters are as follows.
  • :, _, #, =, @, /, ;, ,, -
  • For example, %servicewatch!% cannot be used because ! is not supported.
• The supported operators are as follows.
  • This 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 of the regex. Below is an example of a pattern that searches all log events composed of the ERROR keyword. Please refer to the Available Regex Syntax.

%ERROR%

  The above pattern matches log event messages like the following.
* <code>[2026-02-13 14:22:01] ERROR 500 POST /api/v1/checkout (192.168.1.10) - NullPointerException at com.app.controller.CheckoutController.java:55</code>
* <code>[ERROR] Configuration file not found: /etc/app/config.yaml</code>

##### String pattern in log events without format
String pattern for searching strings in log events that are not in formats like JSON.
Below is an example of a log event message, and you can see the log events that match according to various string pattern classifications.

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

  



Category
Pattern
Matching log event message




single string
ERROR CODE
log event containing ERROR
ERROR CODE 400 BAD REQUEST
ERROR CODE 401 UNAUTHORIZED REQUEST
ERROR CODE 419 MISSING ARGUMENTS
ERROR CODE 420 INVALID ARGUMENTS


Multiple strings (And condition)
ERROR REQUEST
log events containing the strings ERROR and REQUEST
ERROR CODE 400 BAD REQUEST
ERROR CODE 401 UNAUTHORIZED REQUEST


Multiple strings (Or condition)
?ERROR ?400
log events containing the ERROR or 400 string
ERROR CODE 400 BAD REQUEST
ERROR CODE 401 UNAUTHORIZED REQUEST
ERROR CODE 419 MISSING ARGUMENTS
ERROR CODE 420 INVALID ARGUMENTS


Exact matching string
“BAD REQUEST”
log event containing the exact phrase “BAD REQUEST”
ERROR CODE 400 BAD REQUEST


Exclude specific string
ERROR -400
A pattern where some terms are included and other terms are excluded. Enter - before the string you want to exclude. The following are log events that include the string ERROR and exclude the string 400
ERROR CODE 401 UNAUTHORIZED REQUEST
ERROR CODE 419 MISSING ARGUMENTS
ERROR CODE 420 INVALID ARGUMENTS




  Table. String pattern in log events without format





#### Space-separated pattern

Create a pattern to search for matching strings in log events separated by spaces.

##### Space-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 log event above is a space-separated log event that includes <code>timestamp</code>, <code>logLevel</code>, <code>user_id</code>, <code>action</code>, <code>status</code>, <code>ip</code>. Text between brackets (<code>[]</code>) and double quotes (<code>""</code>) is considered a single field.

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

<code>[timestamp, logLevel, user_id, action, status = success, ip]</code> can find log events where the 5th field, <code>status</code>, is <code>success</code>.

##### Space-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 6th 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 like […, statusCode=4*, size] is a pattern that represents the first five fields with an ellipsis.

You can also create composite expressions using the AND (&&) operator and the OR (||) operator. A pattern such as […, statusCode=400 || statusCode=410, size] can find log events where the 6th field, statusCode, is 400 or 410.

You can use regular expressions to provide conditions for a pattern. A pattern such as [host, logName, user, timestamp, request, statusCode=%4[0-9]{2}%, size] can find log events where the sixth field, statusCode, is a number starting 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 non-alphanumeric characters and underscore symbols 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

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

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

Export Log Group

From the log group, you can export log data to Object Storage for log retention and log analysis. You can export log groups for log data in the same Account.

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

The log group export operation can take a long time depending on the amount of logs. When exporting a log group, you can reduce the export operation time by specifying a particular stream within the log group or by specifying a time range.

Log group export can only be executed one at a time on the same Account. To run another log group export, the current export task must be completed.

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

1.4 - event

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

Most events generated in Samsung Cloud Platform services are received by ServiceWatch. Events of each service can be viewed and processed in the ServiceWatch of the same Account.

Refer to the list of services that send events via ServiceWatch and the events those services send in the ServiceWatch Event Reference.

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 set 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 specifies which events are delivered to which targets.

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

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

• Event rules basically allow you to specify a notification recipient to receive alerts when an event occurs.
• The event rules are planned to be expanded to include multiple services of the Samsung Cloud Platform as targets for receiving events when events occur. (Planned for 2026)

To create an event rule, please refer to How-to Guides > Creating Event Rules.

Event Source

ServiceWatch can select the event source as the 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 type. Event types are classified the same as resource types, and you select the type of events from the event source to use in event rules.

The following are the event types of Virtual Server.

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

Event

The event can select all events that occur from the event type of the event source, and can select specific events.

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

For other events available in ServiceWatch, see ServiceWatch Event.

Applied Resources

Set the event pattern for selected events on all resources or specific resources.

Event Pattern

If you select all event sources, event types, events, and applied resources, the event pattern setting for the event rule will be 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, please refer to How-to Guides > Creating Event Rules.

Event Notification

If the event pattern is satisfied, an alert is sent to the notification recipient set in the event rule.

1.5 - ServiceWatch Integration Service

You can check services linked with ServiceWatch.

Metrics and Log Monitoring

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

Event

Below you can check the service that links ServiceWatch with events.

1.6 - Custom Metrics and Logs

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

There are two ways to collect custom metrics and logs.

First, you can install the ServiceWatch Agent directly on the resource, set the resources to be collected, and collect them.
The second is that you can collect custom metrics and logs through the OpenAPI/CLI provided by ServiceWatch.

ServiceWatch Agent

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

ServiceWatch Agent Constraints

ServiceWatch Agent Network Environment

ServiceWatch Agent is designed to collect data using OpenAPI by default, so to install and use it on server resources, external communication via the Internet must be possible. Please create an Internet Gateway in the VPC where the resources are located and set a NAT IP on the server resources so that they can communicate with the outside.

ServiceWatch Agent Supported OS Image

The OS images available for ServiceWatch Agent are as follows.

Provides the same as the OS Image provided by Virtual Server. Please refer to Virtual Server > OS Image provided version.

Quick Guide for Using ServiceWatch Agent

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

Node Exporter Installation and Configuration

1. Refer to Node Exporter installation and install Node Exporter on the server for collecting custom metrics.
   • If you install Node Exporter, you can collect OS metrics through Node Exporter in addition to the metrics provided by ServiceWatch’s default monitoring.
2. ServiceWatch Agent Settings refer to and after downloading the ServiceWatch_Agent zip file, configure and run the ServiceWatch Manager.
   • Refer to the examples/os-metric-min-examples folder in the zip file to set at least two metrics and run the ServiceWatch Agent.

ServiceWatch Custom Metrics and Logs API

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

Custom metric data and custom logs can be delivered to ServiceWatch via ServiceWatch OpenAPI/CLI, allowing you to view visualized information in the Console.

Create Custom Metric Metadata

To collect metric data generated from user resources or applications, rather than metrics provided by Samsung Cloud Platform services (e.g., Virtual Server), into ServiceWatch, you need to create custom metric metadata.

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

Create Custom Metrics

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

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

For detailed information on creating custom metric data, refer to CreateCustomMetrics.

Indicator Data Query

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

For detailed information on metric data retrieval, refer to ListMetricInfos and ListMetricData.

Log Stream Creation

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 to be delivered to ServiceWatch.

For detailed information on creating a log stream, refer to CreateCustomLogStream.

Log Event Creation

To collect custom logs, after creating log groups and log streams, 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 in Samsung Cloud Platform through ServiceWatch.

Using Dashboards

You can monitor resources on the dashboard detail screen of ServiceWatch.

Follow these steps to monitor resources using a dashboard.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for the resources you want to monitor. You will be taken to the Dashboard Detail page.
4. On the Dashboard Detail page, select the monitoring period and time zone, then monitor resources through widgets.

   Division	Detailed Description
   Dashboard Name	Dashboard name Click the name to select another dashboard
   Period Setting Area	Select the period to apply to widgets in the dashboard For metric query, you can set up to 455 days from the current time
   Time Zone Setting Area	Select the time zone to apply to the period setting
   Reset Button	Reset all manipulations or settings on the dashboard detail screen
   Refresh Setting Area	Select the refresh cycle for widget information Click the Refresh button to display information based on the current time Click the refresh cycle to select the desired cycle: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   Edit	Modify dashboard information When you click the Edit button, you will be taken to the Edit Dashboard page For details on dashboard editing, refer to Managing Dashboards
   More	Display additional task items for managing the dashboard For details on dashboard management items, refer to Managing Dashboards
   Alert Status	Display the number of active alerts among the alerts linked to the recommended metrics of the service dashboard by level When you click the View All Alert Policies button, you will be taken to the Alert Policy List page When you click the Expand button, it is provided in widget format (up to 12) For details on widget management, refer to Managing Widgets View Alert Policy: Go to the Alert Policy Detail page for that metric
   Dashboard Status	Display metric widgets for monitoring each resource Click the View Widget Enlarged button to view detailed information about the metric For details on metric detailed information, refer to Viewing Widget Details Click the More button to manage the widget For details on widget management, refer to Managing Widgets When you place the mouse cursor on the graph, the time, data value, and metric data information at that point are displayed in a popup You can zoom in on a specific area of the graph by dragging the mouse When you click the resource name displayed in the legend, detailed information about that resource is displayed in a popup

   Table. Dashboard Detail Items

Setting Dashboard Favorites

You can set frequently used dashboards as favorites to easily navigate to those dashboards on the Service Home page of ServiceWatch. Follow these steps to set a dashboard as a favorite.

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, check the favorite icon of the dashboard you want to add to favorites. Click the dashboard for which you want to view detailed information. You will be taken to the Dashboard Detail page.
   • The favorited dashboard is added to the bottom of the Dashboard > Dashboard Favorites menu and the Dashboard Favorites area of the Service Home page.

Viewing Widget Details

You can individually view widgets in the dashboard by enlarging them. Follow these steps to view an individual widget in enlarged mode.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for the resources you want to monitor. You will be taken to the Dashboard Detail page.
4. On the Dashboard Detail page, click the View Widget Enlarged button of the widget you want to view in enlarged mode. The Metric Detail popup window for that widget will open.

   Division	Detailed Description
   Widget Name	Display the widget name
   Period Setting Area	Select the period to apply to the widget For metric query, you can set up to 455 days from the current time
   Time Zone Setting Area	Select the time zone to apply to the period setting
   Reset Button	Reset all manipulations or settings on the dashboard detail screen
   Statistics	Select the statistics criterion for the metrics displayed in the widget Click the statistics criterion to select the criterion: Average, Minimum, Maximum, Sum
   Aggregation Period Setting Area	Select the aggregation period for widget information Click the aggregation period to select the desired period: 1 minute, 5 minutes, 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
   Refresh Setting Area	Select the refresh cycle for widget information Click the Refresh button to display information based on the current time Click the refresh cycle to select the desired cycle: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   Chart Area	Display monitoring results as a chart When you place the mouse cursor on the graph and legend areas, the time, data value, and metric data information at that point are displayed in a popup You can zoom in on that area by dragging the graph area When you click the resource name displayed in the legend, the alert status for that resource opens in a popup

   Table. Metric Detail Items

Viewing Alert History

You can view alert history for metrics registered in ServiceWatch dashboards. Follow these steps to view alert history.

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 History menu. You will be taken to the Alert History page.
3. On the Alert History page, view the alert history.

   Division	Detailed Description
   Alert Filter and Search Area	Filter or search alert history All Alert Status: Filter by selecting alert status Search by entering the alert policy name in the search input field Detailed Search: Search by entering alert policy name, alert status, or change date
   Alert Policy Name	Alert policy name When you click the alert policy name, you can view detailed information of that alert policy
   Condition	Alert occurrence condition and total occurrence time Display levels by importance: High, Middle, Low
   Division	Classification of alert creation and alert status change information
   Alert Status	Current alert status Normal: When the metric does not meet the set condition Insufficient data: When metric data cannot be verified (missing, non-existent, not arrived) Alert: When the metric meets the set condition
   Alert Level	When alert status is Alert, display the alert level High, Middle, Low

   Table. Alert History Items

Monitoring Metrics

You can view and monitor metrics available in ServiceWatch.

Comparing by Metrics

You can select one or more metrics and resources to monitor. Follow these steps to monitor by comparing metrics.

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

3. On the Metrics page, click Compare by Metrics in the metric view mode.

4. On the Metrics page, select the metrics you want to monitor from the metric list. A monitoring chart for the selected metrics is displayed in the Selected Metrics area at the bottom.

   Division	Detailed Description
   Metric List Area	List of metrics that can be monitored in ServiceWatch Click the + button in front of the namespace and dimensions to view the lower-level list When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
   Search Filter Area	Set the search items to filter, then click the Apply Filter button to filter the metric list Namespace-Dimension Name: Search based on the sub-dimension name of the selected namespace Metric Name: Search by entering the exact metric name Resource Name: Search by entering the exact resource name Resource ID: Search by entering the exact resource ID Keyword: Search based on the selected upper category and entered keyword Search for each item excluding metric name, resource name, resource ID, and Tag-Key Tag Key: Search with the selected tag key

   Table. Metric List Items

5. View the monitoring chart in the Selected Metrics area.

   Division	Detailed Description
   Period Setting Area	Select the period to apply to the chart For metric query, you can set up to 455 days from the current time
   Time Zone Setting Area	Select the time zone to apply to the chart
   Reset Button	Reset all manipulations or settings on the chart
   Refresh Setting Area	Select the refresh cycle for the chart Click the Refresh button to display information based on the current time Click the refresh cycle to select the desired cycle: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   More	Display additional task items for managing the chart For details on chart management, refer to Managing Metric Charts
   Graph Area	Data graph collected during the period applied to the chart When you place the mouse cursor on the graph, the time, data value, and metric data information at that point are displayed in a popup You can zoom in on a specific area of the graph by dragging the mouse When you click the label name displayed in the legend, detailed information about that legend is displayed in a popup
   Table Area	Check and modify labels, statistics, and aggregation period by legend Legend: Color by legend Click the legend color to change to a different color Label: Display the namespace, resource name, and metric name of the selected metric Click the legend name to change Enter within 3 to 255 characters using English letters, numbers, and special characters Statistics: Select the method to aggregate metric data You can select from Average (default), Minimum, Maximum, Sum Aggregation Period: Select the aggregation period unit of metric values You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day More: Delete the legend or create an alert policy for the legend For details on alert policy creation, refer to Creating an Alert Policy

   Table. Compare by Metrics Monitoring Chart Items

   Reference

   • Statistics methods are as follows.
     • Sum: Sum of all data point values collected during the period
     • Average: Value obtained by dividing the Sum during the specified period by the number of data pointers during that period
     • Minimum: Lowest value observed during the specified period
     • Maximum: Highest value observed during the specified period
   • For a detailed explanation of metrics, refer to Metrics Overview.

Comparing by Date

You can monitor by comparing one metric and resource by date or period. Follow these steps to monitor by comparing by date or period.

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

3. On the Metrics page, click Compare by Date in the metric view mode.

4. On the Metrics page, select the metrics you want to monitor from the metric list. A monitoring chart for the selected metrics is displayed in the Selected Metrics area at the bottom.

   Division	Detailed Description
   Metric List Area	List of metrics that can be monitored in ServiceWatch Click the + button in front of the namespace and dimensions to view the lower-level list When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
   Search Filter Area	Set the search items to filter, then click the Apply Filter button to filter the metric list Namespace-Dimension Name: Search based on the sub-dimension name of the selected namespace Metric Name: Search by entering the exact metric name Resource Name: Search by entering the exact resource name Resource ID: Search by entering the exact resource ID Keyword: Search based on the selected upper category and entered keyword Search for each item excluding metric name, resource name, resource ID, and Tag-Key Tag Key: Search with the selected tag key

   Table. Metric List Items

5. View the monitoring chart in the Selected Metrics area.

   Division	Detailed Description
   Date Comparison/Period Comparison	Select the criterion to compare metrics Date Comparison: Compare by specifying a specific date Period Comparison: To be provided in the future
   Date and Period Setting Area	Select the date or period to compare Date Comparison: Specify the date to view in the chart You can set up to 455 days from the current time You can set up to 4 Period Comparison: To be provided in the future
   Time Zone Setting Area	Select the time zone to apply to the chart
   Reset Button	Reset all manipulations or settings on the chart
   Refresh Setting Area	Select the refresh cycle for the chart Click the Refresh button to display information based on the current time Click the refresh cycle to select the desired cycle: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   More	Display additional task items for managing the chart For details on chart management, refer to Managing Metric Charts
   Graph Area	Data graph collected during the period applied to the chart When you place the mouse cursor on the graph, the time, data value, and metric data information at that point are displayed in a popup You can zoom in on a specific area of the graph by dragging the mouse When you click the date or period displayed in the legend, detailed information about that legend is displayed in a popup
   Table Area	Check and modify labels, statistics, and aggregation period by legend Legend: Color by legend Click the legend color to change to a different color Period: Period applied to the chart Metric: Display the namespace, resource name, and metric name of the selected metric Statistics: Select the method to aggregate metric data You can select from Average (default), Minimum, Maximum, Sum. Note the green icon displayed to the right of meaningful metrics for that metric Aggregation Period: Select the aggregation period unit of metric values You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day More: Delete the legend or create an alert policy for the legend For details on alert policy creation, refer to Creating an Alert Policy

   Table. Compare by Date Monitoring Chart Items

   Reference

   • Statistics methods are as follows.
     • Sum: Sum of all data point values collected during the period
     • Average: Value obtained by dividing the Sum during the specified period by the number of data pointers during that period
     • Minimum: Lowest value observed during the specified period
     • Maximum: Highest value observed during the specified period
   • For a detailed explanation of metrics, refer to Metrics Overview.

Monitoring Logs

You can monitor logs collected from Samsung Cloud Platform services.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
3. On the Log Group List page, click the log group name for which you want to view detailed information. You will be taken to the Log Group Detail page.
4. On the Log Group Detail page, click the Log Stream tab. The Log Stream list is displayed.
5. On the Log Stream list, click the log stream name for which you want to view detailed information. You will be taken to the Log Stream Detail page.
   • When you click the View All Log Streams button at the top of the log stream list, you will be taken to the All Log Streams Detail page.

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

     Table. Log Group Detail - Log Stream Detail Items

Receiving Event Notifications

You can receive notifications by creating system event rules for changes in resources created in Samsung Cloud Platform.

Installing ServiceWatch Agent

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

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 Agent Setup & Guideline button. The Agent Setup & Guideline popup window will open.
3. Copy the Installation File URL from the Agent Setup & Guideline popup window and navigate to that address. You can download the agent, manager, and configuration files.
   • For details on ServiceWatch Agent installation, refer to Using ServiceWatch Agent.

2.1 - Managing Dashboards and Widgets

You can create and manage dashboards to monitor resources of services in use on the Samsung Cloud Platform Console.

Creating a Dashboard

You can create dashboards in ServiceWatch.

Creating a Dashboard by Adding Individual Widgets

Follow these steps to create a dashboard.

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

2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.

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

4. Enter a name for the dashboard.

   • The dashboard name must be 3 to 40 characters long, using English letters, numbers, and special characters (-_).
   • You cannot enter a name that is already in use in the service dashboard.

5. Add widgets to configure the dashboard. Depending on the widget addition method, a corresponding popup window will open.

   • Add Individual Widget: You can add a single widget combining metrics and resources. When you click the button, the Add Individual Widget popup window will open.

     Division	Required	Detailed Description
     Metric Division	Optional	Filter the metrics that can be monitored in ServiceWatch by All or Key Metrics and display them in the metric list
     Metric List Area	Required	List of metrics that can be monitored in ServiceWatch Click the + button in front of the namespace and dimensions to view the lower-level list When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
     Search Filter Area	-	Set the search items to filter, then click the Apply Filter button to filter the metric list Namespace-Dimension Name: Search based on the sub-dimension name of the selected namespace Metric Name: Search by entering the exact metric name Resource Name: Search by entering the exact resource name Resource ID: Search by entering the exact resource ID Keyword: Search based on the selected upper category and entered keyword Search for each item excluding metric name, resource name, resource ID, and Tag-Key Tag Key: Search with the selected tag key
     Selected Metrics Area	-	Monitoring chart for the metric selected in the metric list area Data graph collected during the period applied to the chart When you place the mouse cursor on the graph, the time, data value, and metric data information at that point are displayed in a popup You can zoom in on a specific area of the graph by dragging the mouse When you click the resource name displayed in the legend, detailed information about that resource is displayed in a popup You can modify item values in the table area within the chart Label: Enter the legend name using English letters, numbers, and special characters within 3 to 255 characters Statistics: Select the method to aggregate metric data You can select from Average (default), Minimum, Maximum, Sum Aggregation Period: Select the aggregation period unit of metric values You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours Delete: Delete that legend

     Table. Add Individual Widget Items

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

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

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

Creating a Dashboard by Adding Multiple Widgets

Follow these steps to create a dashboard.

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

2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.

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

4. Enter a name for the dashboard.

   • The dashboard name must be 3 to 40 characters long, using English letters, numbers, and special characters (-_).
   • You cannot enter a name that is already in use in the service dashboard.

5. Add widgets to configure the dashboard. Depending on the widget addition method, a corresponding popup window will open.

   • Add Multiple Widgets: You can select desired resources by metric unit and add multiple widgets at once. When you click the button, the Add Multiple Widgets popup window will open.

     Division	Required	Detailed Description
     Metric Division	Optional	Filter the metrics that can be monitored in ServiceWatch by All or Key Metrics and display them in the metric list
     Metric Selection Area	Required	Select the namespace and resources to add Click the + button in front of the namespace and resources to view the lower-level resources and metric list When you check a metric to add to a widget from the metric list, the Selected Metrics and Selected Resources areas are displayed You can select multiple metrics
     Selected Metrics	Required	Display the list of metrics selected from the namespace and resource list When you click a metric, the list of resources included in that metric is displayed in the Selected Resources area
     Selected Resources	Required	Add resources to the metrics selected in the Selected Metrics list After clicking the Select button, select resources that can be added to that metric and add up to 5 You must add resources for all metrics in the Selected Metrics list
     Statistics	Required	Select the statistics criterion for metric values You can select from Average (default), Minimum, Maximum, Sum
     Aggregation Period	Required	Select the aggregation period unit of metric values You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours

     Table. Add Multiple Widgets Items

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

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

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

Creating a Dashboard by Importing a Dashboard

Follow these steps to create a dashboard.

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

2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.

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

4. Enter a name for the dashboard.

   • The dashboard name must be 3 to 40 characters long, using English letters, numbers, and special characters (-_).
   • You cannot enter a name that is already in use in the service dashboard.

5. Add widgets to configure the dashboard. Depending on the widget addition method, a corresponding popup window will open.

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

     Division	Required	Detailed Description
     Dashboard	Required	Display the list of dashboards registered in ServiceWatch When you select a dashboard, the widgets applied to that dashboard are displayed in the Preview area
     Preview	Required	Display the widgets applied to the dashboard selected from the dashboard list Check the widget name to select the widget to add to the dashboard to create When you check the Select All item, all metrics of that dashboard are selected

     Table. Import Dashboard Items

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

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

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

Viewing Dashboards

You can view information about the dashboard selected on the Dashboard List page. Follow these steps to view a dashboard.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.

   Division	Detailed Description
   Dashboard Name	Dashboard name User dashboard is the dashboard name set by the user. Service dashboard is the Samsung Cloud Platform service name matching the service namespace
   Dashboard Division	Dashboard division User: Dashboard created directly by the user Service: Dashboard composed of key metrics for each service automatically pre-built
   Modified Date	Dashboard modification date
   Created Date	Dashboard creation date
   Favorites	Displayed in yellow if favorites are set To set or unset favorites, click the star icon

   Table. Dashboard List Items
3. On the Dashboard List page, click the dashboard for which you want to view detailed information. You will be taken to the Dashboard Detail page.

   Division	Detailed Description
   Dashboard Name	Display the dashboard name Click the name to select another dashboard
   Period Setting Area	Select the period to apply to widgets in the dashboard For metric query, you can set up to 455 days from the current time
   Time Zone Setting Area	Select the time zone to apply to the period setting
   Reset Button	Reset all manipulations or settings on the dashboard detail screen
   Refresh Setting Area	Select the refresh cycle for widget information Click the Refresh button to display information based on the current time Click the refresh cycle to select the desired cycle: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
   Edit	Modify the dashboard name or manage widgets When you click the Edit button, you will be taken to the Edit Dashboard page For details on dashboard editing, refer to Editing a Dashboard
   More	Display additional task items for managing the dashboard You can clone and delete the dashboard, view detailed information, and view source For details on dashboard management items, refer to Managing Dashboards For details on widget management items, refer to Managing Widgets
   Widget Area	Display widgets for monitoring each resource Click the More button in the upper right corner of the widget to manage the widget You can edit and clone the widget, download files, view metrics, and view source For details on widget management items, refer to Managing Widgets

   Table. Dashboard Detail Items

Managing Dashboards

On the Dashboard Detail page, you can modify or manage dashboard information and widgets.

Editing a Dashboard

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for which you want to view detailed information. You will be taken to the Dashboard Detail page.
4. Click the Edit button in the upper right corner of the Dashboard Detail page. You will be taken to the Edit Dashboard page.
5. After modifying the dashboard information or widgets, click the Save button.

   Division	Detailed Description
   Dashboard Name	Dashboard name cannot be modified Enter within 34 characters using English letters, numbers, and special characters (-_) Duplicate dashboard names in use cannot be used
   Widget Name	Widget name can be modified Enter within 3 to 255 characters using English letters, numbers, spaces, and special characters (-_.|)
   Widget Management	When you place the mouse cursor on a widget, management buttons are displayed on the right side of the widget border Edit: You can modify the widget’s metrics and resources in the Edit Widget popup window For details on widget editing, refer to Edit Individual Widget in Managing Widgets Clone: Clone the current widget and add it to the dashboard Delete: Delete the current widget from the dashboard Expand: Display the current widget in an expanded size Shrink: If displayed in expanded size, click again to shrink the widget size
   Add Widget	Add a new widget to the dashboard Add Individual Widget: Add a single widget combining metrics and resources Add Multiple Widgets: Select desired resources by metric unit and add multiple widgets at once Import Dashboard: Import widgets from another dashboard and add them For details on widget addition methods, refer to Creating a Widget

   Table. Edit Dashboard Items

Viewing Dashboard Detailed Information

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for which you want to view detailed information. You will be taken to the Dashboard Detail page.
4. Click the More > Detailed Information button in the upper right corner of the Dashboard Detail page. The Dashboard Detailed Information popup window will open.

   Division	Detailed Description
   Dashboard Name	Dashboard name
   Dashboard Division	Usage division of the dashboard User: Dashboard created directly by the user Service: Dashboard composed of key metrics for each service automatically pre-built
   Service	Service name
   Resource Type	dashboard
   SRN	Unique resource ID in Samsung Cloud Platform In ServiceWatch, it means the SRN of the dashboard
   Resource Name	Resource name In ServiceWatch, it means the dashboard name
   Resource ID	Unique resource ID in the service
   Creator	User who created the dashboard
   Created Date	Date and time when the dashboard was created
   Modifier	User who modified the dashboard information
   Modified Date	Date and time when the dashboard information was modified

   Table. Dashboard Detail - Detailed Information Popup Items

Viewing Dashboard Source Code

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for which you want to view detailed information. You will be taken to the Dashboard Detail page.
4. Click the More > View Source button in the upper right corner of the Dashboard Detail page. The Dashboard View Source popup window will open.

   Division	Detailed Description
   Source Information	Display dashboard source code in JSON format
   Copy Code	Copy source code to clipboard

   Table. Dashboard Detail - Dashboard View Source Popup Items

Cloning a Dashboard

You can clone the widgets of the current dashboard and add them to another dashboard.

Follow these steps to clone a dashboard.

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

2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.

3. On the Dashboard List page, click the dashboard for which you want to view detailed information. You will be taken to the Dashboard Detail page.

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

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

   Division	Required	Detailed Description
   Clone Target	-	Dashboard name to clone
   Clone Method	Required	After cloning the dashboard widgets, select the dashboard to add to New Dashboard: Create a new dashboard and create by cloning the widgets of the current dashboard Existing Dashboard: Clone the widgets of the current dashboard and add them to an existing dashboard
   Dashboard Name	Required	Enter the name of the dashboard to create Displayed when clone method is selected as New Dashboard Enter within 3 to 40 characters using English letters, numbers, and special characters (-_)
   Dashboard Selection	Required	Select a dashboard to add the cloned widgets from among previously created dashboards Displayed when clone method is selected as Existing Dashboard

   Table. Clone Dashboard Items

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

7. Click the Confirm button in the popup window. The dashboard cloning is complete.

Deleting a Dashboard

You can delete dashboards that are not in use.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, select the checkbox of the dashboard to delete and click the Delete button. A popup window will open announcing the dashboard deletion.
   • You can delete multiple dashboards at the same time.
   • You can also delete individually by clicking the More > Delete button in the upper right corner of the Dashboard Detail page.
4. After entering Delete in the delete confirmation input area, click the Confirm button. The dashboard is deleted.

Managing Widgets

On the Dashboard Detail page, you can modify or manage widgets.

Editing a Widget

You can modify the metrics and resources of a widget.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for which you want to edit widgets. You will be taken to the Dashboard Detail page.
4. Click the More > Edit Widget button in the upper right corner of the widget to edit on the Dashboard Detail page. The Edit Widget popup window will open.
5. After modifying the widget’s metrics and resources, click the Confirm button. The widget editing is complete.

   Division	Required	Detailed Description
   Metric Division	Optional	Filter the metrics that can be monitored in ServiceWatch by All or Key Metrics and display them in the metric list
   Metric List Area	Required	List of metrics that can be monitored in ServiceWatch Click the + button in front of the namespace and dimensions to view the lower-level list When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
   Search Filter Area	-	Set the search items to filter, then click the Apply Filter button to filter the metric list Namespace-Dimension Name: Search based on the sub-dimension name of the selected namespace Metric Name: Search by entering the exact metric name Resource Name: Search by entering the exact resource name Resource ID: Search by entering the exact resource ID Keyword: Search based on the selected upper category and entered keyword Search for each item excluding metric name, resource name, resource ID, and Tag-Key Tag Key: Search with the selected tag key
   Selected Metrics Area	-	Monitoring chart for the metric selected in the metric list area Data graph collected during the period applied to the chart When you place the mouse cursor on the graph, the time, data value, and metric data information at that point are displayed in a popup You can zoom in on a specific area of the graph by dragging the mouse When you click the label name displayed in the legend, detailed information about that legend is displayed in a popup In the table area within the chart, you can check and modify labels, statistics, and aggregation period by legend Legend: Color by legend Click the legend color to change to a different color Period: Period applied to the chart Metric: Display the namespace, resource name, and metric name of the selected metric Statistics: Select the method to aggregate metric data You can select from Average (default), Minimum, Maximum, Sum Aggregation Period: Select the aggregation period unit of metric values You can select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day Delete: Delete that legend

   Table. Add Individual Widget Items

Cloning a Widget

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

Follow these steps to clone a widget.

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

2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.

3. On the Dashboard List page, click the dashboard to clone. You will be taken to the Dashboard Detail page.

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

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

   Division	Required	Detailed Description
   Clone Target	-	Dashboard name to clone
   Clone Method	Required	After cloning the widget, select the dashboard to add to Existing Dashboard: Add the widget to an existing dashboard New Dashboard: Create a new dashboard and add the widget
   Dashboard Selection	Required	Select a dashboard to add the cloned widget from among previously created dashboards Displayed when clone method is selected as Existing Dashboard
   Dashboard Name	Required	Enter the name of the dashboard to create Displayed when clone method is selected as New Dashboard Enter within 3 to 40 characters using English letters, numbers, and special characters (-_)
   Widget Name	Required	Enter the widget name when adding the widget to the dashboard Enter within 3 to 255 characters using English letters, numbers, and special characters (-_.|)

   Table. Clone Widget Items

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

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

Downloading Widget Files

You can download widget information as a file. Follow these steps to download widget information.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for which you want to download widget information. You will be taken to the Dashboard Detail page.
4. Click the More > File Download button in the upper right corner of the widget for which you want to download widget information on the Dashboard Detail page. The File Download popup window will open.
5. Select a file download method and click the Confirm button. The download will start.
   • You can select multiple download methods at the same time.

     Division	Detailed Description
     CSV	Convert the widget’s metrics and monitoring data to Excel (*.csv) file format and download
     PNG	Convert the widget chart to image (*.png) file format and download

     Table. Widget File Download Items

Viewing Widget Metrics

You can view the resource and metric information of a widget on the Metrics page. Follow these steps to view widget metrics on the metrics page.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for which you want to view widget metrics. You will be taken to the Dashboard Detail page.
4. Click the More > View Metrics button in the upper right corner of the widget to view on the Metrics page on the Dashboard Detail page. You will be taken to the Metrics page.
   • The resource and metric information of the selected widget are automatically set and displayed on the Metrics page.

Viewing Widget Source Code

You can view the dashboard source code.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for which you want to view detailed information. You will be taken to the Dashboard Detail page.
4. Click the More > View Source button in the upper right corner of the widget for which you want to view source code on the Dashboard Detail page. The Widget View Source popup window will open.

   Division	Detailed Description
   Source Information	Display widget source code in JSON format
   Copy Code	Copy source code to clipboard

   Table. Widget View Source Items

Downloading Widget Files

You can download widget information as a file. Follow these steps to download widget information.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for which you want to download widget information. You will be taken to the Dashboard Detail page.
4. Click the More > File Download button in the upper right corner of the widget for which you want to download widget information on the Dashboard Detail page. The File Download popup window will open.
5. Select a file download method and click the Confirm button. The download will start.
   • You can select multiple download methods at the same time.

     Division	Detailed Description
     CSV	Convert the widget’s metrics and monitoring data to Excel (*.csv) file format and download
     PNG	Convert the widget chart to image (*.png) file format and download

     Table. Widget File Download Items

Exporting to Object Storage

You can save widget information to Object Storage.

Follow these steps to save widget information to Object Storage.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
3. On the Dashboard List page, click the dashboard for which you want to download widget information. You will be taken to the Dashboard Detail page.
4. Click the More > Export to Object Storage button in the upper right corner of the widget for which you want to download widget information on the Dashboard Detail page. The Export to Object Storage popup window will open.
5. Select the bucket to save the widget information and click the Done button. A popup window will open announcing the save.
6. Click the Confirm button in the popup window. The data export will start.

2.2 - Alert

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

Creating an Alert Policy

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

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

2. On the Service Home page, click the Alert > Alert Policy menu. You will be taken to the Alert Policy List page.

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

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

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

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

   Table. Select Metric Popup Items

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

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

   Table. Metric and Condition Settings Items

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

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

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

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

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

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

Viewing Alert Policy Details

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Alert > Alert Policy menu. You will be taken to the Alert Policy List page.
   • You can also click the Alert Level button displayed in the Alert Policy menu to view only the list of alert policies corresponding to that alert level.
3. On the Alert Policy List page, click the alert policy name for which you want to view detailed information. You will be taken to the Alert Policy Details page.

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

   Table. Alert Details Items

Detailed Information

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

Notifications

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

Alert History

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

Tags

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

Operation History

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

Modifying an Alert Policy

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

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

Deleting an Alert Policy

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Alert > Alert Policy menu. You will be taken to the Alert Policy List page.
3. On the Alert Policy List page, select the checkbox of the alert policy you want to delete, then click the Delete button. A popup window announcing the deletion of the alert policy opens.
   • You can delete multiple alert policies at the same time.
   • You can also individually delete by clicking the Delete button at the right end of each alert policy or by clicking the Delete Alert Policy button on the corresponding Alert Policy Details page.
4. Click the Confirm button. The alert policy is deleted.

2.3 - Metric

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

Viewing Metrics

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Metric menu. You will be taken to the Metric page.
3. Check the metrics in the metric list on the Metric page.

Managing Metric Charts

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

Adding as Widget

You can add selected metrics as widgets to a dashboard.

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

2. On the Service Home page, click the Metric menu. You will be taken to the Metric page.

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

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

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

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

   Table. Add Widget Items

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

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

Sharing Monitoring Chart URL

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Metric menu. You will be taken to the Metric page.
3. Select the metric to monitor in the metric list on the Metric page. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. Set the chart area in the monitoring chart in the Selected Metric area, then click the More > Share URL button. The Share URL popup window opens.
5. Click the Copy URL button in the Share URL popup window. The generated URL is copied.
   • Information in the monitoring chart is provided in the form of a metadata link.

Downloading Monitoring Chart File

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Metric menu. You will be taken to the Metric page.
3. Select the metric to monitor in the metric list on the Metric page. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. Set the chart area in the monitoring chart in the Selected Metric area, then click the More > Download File button. The Download File popup window opens.
5. Select the file download method, then click the Confirm button. Download starts.
   • You can select download methods simultaneously.

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

     Table. Metric Monitoring File Download Items

Exporting to Object Storage

You can save monitoring chart data to Object Storage.

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Metric menu. You will be taken to the Metric page.
3. Select the metric to monitor in the metric list on the Metric page. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. Set the chart area in the monitoring chart in the Selected Metric area, then click the More > Export to Object Storage button. The Export to Object Storage popup window opens.
5. Select the bucket to save data, then click the Complete button. A popup window announcing data saving opens.
6. Click the Confirm button in the popup window. Data export starts.

Viewing Monitoring Chart Source

You can view the source code of the monitoring chart.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Metric menu. You will be taken to the Metric page.
3. Select the metric to monitor in the metric list on the Metric page. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
4. Set the chart area in the monitoring chart in the Selected Metric area, then click the More > View Source button. The View Widget Source popup window opens.

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

   Table. Monitoring Chart View Source Items

2.4 - Logs

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

Creating a Log Group

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

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

2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.

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

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

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

   Table. Create Log Group Items

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

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

Viewing Log Group Detailed Information

You can view and manage detailed information about log groups.

Follow these steps to view detailed information about log groups.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
3. On the Log Group List page, click the log group name for which you want to view detailed information. You will be taken to the Log Group Detail page.

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

   Table. Log Group Detail Items

   Reference

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

Detailed Information

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

Log Streams

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

Log Patterns

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

Tags

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

Operation History

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

Managing Log Streams

You can create and manage log streams.

Creating a Log Stream

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
3. On the Log Group List page, click the log group name for which you want to create a log stream. You will be taken to the Log Group Detail page.
4. On the Log Group Detail page, click the Log Stream tab. The log stream list is displayed.
5. Click the Create Log Stream button. The Create Log Stream popup window will open.
6. After entering the Log Stream Name, click the Create button. The log stream creation is complete.
   • Enter the name within 3 to 512 characters using English letters and numbers.

Viewing Log Stream Detailed Information

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
3. On the Log Group List page, click the log group name for which you want to view detailed information. You will be taken to the Log Group Detail page.
4. On the Log Group Detail page, click the Log Stream tab. The Log Stream list is displayed.
5. On the Log Stream list, click the log stream name for which you want to view detailed information. You will be taken to the Log Stream Detail page.

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

   Table. Log Group Detail - Log Stream Detail Items

   Reference

   When you click the View All Log Streams button at the top of the log stream list, you will be taken to the All Log Streams Detail page.

Deleting a Log Stream

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
3. On the Log Group List page, click the log group name for which you want to delete a log stream. You will be taken to the Log Group Detail page.
4. On the Log Group Detail page, click the Log Stream tab. The log stream list is displayed.
5. On the log stream list, select the checkbox of the log stream to delete and click the More > Delete button. A popup window will open announcing the log stream deletion.
   • You can delete multiple log streams at the same time.
   • You can also delete individually by clicking the Delete button at the right end of each log stream.
6. Click the Confirm button. The log stream is deleted.

Managing Log Patterns

Creating a Log Pattern

Follow these steps to create a log pattern.

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

2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.

3. On the Log Group List page, click the log group name for which you want to create a log pattern. You will be taken to the Log Group Detail page.

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

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

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

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

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

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

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

     Table. Create Log Pattern - Metric Information Items

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

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

Viewing Log Pattern Detailed Information

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
3. On the Log Group List page, click the log group name for which you want to view detailed information. You will be taken to the Log Group Detail page.
4. On the Log Group Detail page, click the Log Pattern tab. The log pattern list is displayed.
5. On the Log Pattern list, click the log pattern name for which you want to view detailed information. You will be taken to the Log Pattern Detail page.

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

   Table. Log Pattern Detail Items

Deleting a Log Pattern

Follow these steps to delete a log pattern.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
3. On the Log Group List page, click the log group name for which you want to delete a log pattern. You will be taken to the Log Group Detail page.
4. On the Log Group Detail page, click the Log Pattern tab. The log pattern list is displayed.
5. On the log pattern list, select the checkbox of the log pattern to delete and click the Delete button. A popup window will open announcing the log pattern deletion.
   • You can delete multiple log patterns at the same time.
   • You can also delete individually by clicking the More > Delete button at the right end of each log pattern or by clicking the Delete Log Pattern button on the log pattern detail page.
6. Click the Confirm button. The log pattern is deleted.

Exporting Log Group

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

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

2. On the Service Home page, click the Log > Export Log Group menu. You will be taken to the Export Log Group List page.

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

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

   Table. Export Log Group Items

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

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

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

Deleting a Log Group

You can delete unused log groups.

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
3. On the Log Group List page, select the checkbox of the log group to delete and click the Delete button. A popup window will open announcing the log group deletion.
   • You can delete multiple log groups at the same time.
   • You can also delete individually by clicking the Delete button at the right end of each log group or by clicking the Delete Log Group button on the corresponding Log Group Detail page.
4. Click the Confirm button. The log group is deleted.

2.5 - Events

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

Creating an Event Rule

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

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

2. On the Service Home page, click the Event Rule menu. You will be taken to the Event Rule List page.

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

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

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

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

   Table. Event Pattern Setting Items

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

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

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

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

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

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

Viewing Event Rule Detailed Information

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Event Rule menu. You will be taken to the Event Rule List page.
3. On the Event Rule List page, click the event name for which you want to view detailed information. You will be taken to the Event Rule Detail page.

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

   Table. Event Rule Detail Items

Detailed Information

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

Notifications

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

Tags

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

Operation History

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

Modifying Event Pattern

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Event Rule menu. You will be taken to the Event Rule List page.
3. On the Event Rule List page, click the event name for which you want to modify the event pattern. You will be taken to the Event Rule Detail page.
4. Click the Edit button in the Event Pattern Setting Status on the Event Rule Detail page. The Edit Event Pattern popup window will open.
5. After modifying the event pattern settings, click the Confirm button. A popup window will open announcing the event pattern modification.
   • For details on event pattern modification items, refer to Creating an Event Rule.
6. Click the Confirm button. The event pattern modification is complete.

Deleting an Event Rule

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

1. Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
2. On the Service Home page, click the Event Rule menu. You will be taken to the Event Rule List page.
3. On the Event Rule List page, select the checkbox of the event rule to delete and click the Delete button. A popup window will open announcing the event rule deletion.
   • You can delete multiple event rules at the same time.
   • You can also delete individually by clicking the More > Delete button at the right end of each alert policy or by clicking the Delete Event Rule button on the corresponding Event Rule Detail page.
4. Click the Confirm button. The event rule is deleted.

2.6 - Using ServiceWatch Agent

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

ServiceWatch Agent

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

Pre-environment Configuration for ServiceWatch Agent

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

1. Adding Security Group Rules

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

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

     Table. Security Group Rules for ServiceWatch Agent Communication

2. Adding Firewall Rules

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

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

     Table. Internet Gateway Firewall Rules for ServiceWatch Agent Communication

ServiceWatch OpenAPI Endpoint IP Address

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

Configuring Open Telemetry Collector for ServiceWatch

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

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

   Guide

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

   Copy Code

   Color mode

   wget [ServiceWatch Agent File Download URL]

   wget [ServiceWatch Agent File Download URL]

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

   • Extract the Agent file for ServiceWatch.
     Sample Code Download

     Copy Code

     Color mode

     unzip ServiceWatch_Agent.zip

     unzip ServiceWatch_Agent.zip

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

     Copy Code

     Color mode

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

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

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

     Table. ServiceWatch Agent File Configuration

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

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

   Table. agent.json Configuration File Items
   Sample Code Download

   Copy Code

   Color mode

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

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

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

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

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

     Table. metric.json Configuration File Items
     Sample Code Download

     Copy Code

     Color mode

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

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

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

     Copy Code

     Color mode

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

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

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

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

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

     Table. log.json Configuration File Items
     Sample Code Download

     Copy Code

     Color mode

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

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

     Note

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

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