The page has been translated by Gen AI.

Custom Metrics and Logs

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

There are two ways to collect custom metrics and logs.

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

Reference
Collecting custom metrics/logs via the ServiceWatch Agent is currently available only on Samsung Cloud Platform For Enterprise. It will be offered in other offerings in the future.
Caution

The ServiceWatch metric API incurs costs for calls. Collecting metrics via the ServiceWatch Agent also operates on an OpenAPI basis, so metric API calls incur costs.
Caution is required to avoid excessive API calls when collecting metrics and logs. The billable metric APIs are listed below.

APIdescription
ListMetricDataRetrieve metric data list.
  • Since a single API call can request multiple metrics, charges are applied per 1,000 metric requests
DownloadMetricDataImageMetric data widget image download.
  • Since a single API call can request multiple metrics, a fee is charged per 1,000 metric requests
ListMetricInfosRetrieve indicator data.
  • This API incurs a charge per 1,000 calls
CreateCustomMetricMetasCreate custom metric metadata
  • This API is billed per 1,000 calls
CreateCustomMetricsCreate (send) custom metric data
  • This API incurs a charge per 1,000 calls
ShowDashboardDashboard view
  • This API is charged per 1,000 calls
ListDashboardsDashboard list retrieval
  • This API incurs a charge per 1,000 calls
CreateDashboardCreate Dashboard
  • This API incurs a charge per 1,000 calls
SetDashboardEdit Dashboard
  • This API is charged per 1,000 calls
DeleteBulkDashboardsDelete Dashboard
  • This API incurs a charge per 1,000 calls
Table. Indicator API Billing Information

Since logs incur charges based on the amount of data collected, there is no additional charge for API calls.

※ For detailed pricing information, refer to the ServiceWatch pricing details on the Samsung Cloud Platform Service Portal.

ServiceWatch Agent

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

ServiceWatch Agent Constraints

ServiceWatch Agent network environment

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

ServiceWatch Agent Supported OS Image

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

OS Image versionEOS Date
Alma Linux 8.102029-05-31
Alma Linux 9.62025-11-17
Oracle Linux 8.102029-07-31
Oracle Linux 9.62025-11-25
RHEL 8.102029-05-31
RHEL 9.42026-04-30
RHEL 9.62027-05-31
Rocky Linux 8.102029-05-31
Rocky Linux 9.62025-11-30
Ubuntu 22.042027-06-30
Ubuntu 24.042029-06-30
Windows 20192029-01-09
Windows 20222031-10-14
Table. OS images supported by ServiceWatch Agent

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

Quick Guide for Using ServiceWatch Agent

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

Installing and Configuring Node Exporter

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

Metric collection through the ServiceWatch Agent is classified as custom metrics and, unlike the default metrics collected from each service, incurs charges, so be careful not to configure unnecessary metric collection. Ensure that only the metrics that need to be collected are collected.

  • Free provision is limited to 10 per account/region.
Reference
For detailed information about using the ServiceWatch Agent, refer to How-to guides > Using ServiceWatch Agent.

ServiceWatch Custom Metrics and Logs API

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

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

Caution

Collecting metrics via ServiceWatch OpenAPI/CLI is classified as custom metrics, and unlike the default metrics collected from each service, it incurs charges, so be careful not to configure unnecessary metric collection. Ensure that only the metrics that need to be collected are configured for collection.

  • Free provision is limited to 10 per account/region.

Create custom metric metadata

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

Parameterdescription
namespaceUsers can define a namespace in ServiceWatch that distinguishes it from other metrics.
  • The namespace must be 3 to 128 characters long, consisting of letters, numbers, spaces, and special characters (_-/), and must start with a letter.
metricMetas > metricNameSet the name of the metric to be collected. The metric name must be 3 to 128 characters, consisting of letters, numbers, and special characters (_), and must start with a letter.
  • Example: custom_cpu_seconds_total
metricMetas > storageResolutionSet the collection interval for the relevant metric. The default is 60 (1 minute), and it can be set in seconds.
metricMetas > unitMetric unit can be set
  • Example: Bytes, Count, etc.
metricMetas > dimensionsYou can set dimensions to identify custom metric data and visualize it in the Console. When visualizing the collected metrics in the Console, they are displayed in combinations based on the dimension (dimensions) settings.
metricMetas > descriptionKoKorean description of the metrics being collected
metricMetas > descriptionEnEnglish description of the metrics being collected
Table. Description of custom metric metadata parameters

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

Create custom metric

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

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

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

Metric Data Query

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

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

Create log stream

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

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

Log Event Creation

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

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

ServiceWatch integration service
How-to guides