사용자 정의 지표와 로그

ServiceWatch는 사용자가 직접 정의한 사용자 정의 지표를 수집할 수 있고 사용자가 생성한 자원으로부터 로그 파일을 수집할 수 있습니다.

사용자 정의 지표와 로그를 수집하는 방법은 다음 2가지로 제공됩니다.

수집 방법	상세 설명
ServiceWatch Agent	자원에 Agent를 직접 설치하고 수집할 지표와 로그를 설정하여 수집
ServiceWatch 사용자 정의 지표 및 로그 API	ServiceWatch에서 제공하는 OpenAPI/CLI를 통해 수집

표. 사용자 정의 지표와 로그 수집 방법

안내

ServiceWatch Agent를 통한 사용자 정의 지표/로그 수집 시, kr-south3 리전은 Support Center > 문의하기를 참고하여 별도로 문의하세요.

안내

kr-south1, kr-south2 리전에서 NAT Gateway 또는 Internet Gateway를 통해 ServiceWatch Agent 또는 ServiceWatch OpenAPI를 사용하는 경우, 별도 방화벽 해제가 필요합니다.
방화벽 해제는 Support Center > 문의하기를 통해 요청하세요.

주의

ServiceWatch의 지표 API는 호출에 대한 비용이 발생합니다. ServiceWatch Agent를 통한 지표 수집 역시 OpenAPI 기반으로 동작하기 때문에 지표 API 호출에 대한 비용이 발생합니다.
지표 및 로그 수집을 위해 과도하게 API를 호출하지 않도록 주의하세요. 과금 대상 API는 과금 대상 지표 API를 참고하세요.

과금 대상 지표 API

사용자 정의 지표와 로그를 수집할 때 과금되는 지표 API는 다음과 같습니다. ListMetricData와 DownloadMetricDataImage는 무료 제공 없이 상시 과금되며, 그 외의 API는 월 1,000,000건까지 무료입니다.

API	설명	과금 단위	무료 제공
ListMetricData	지표 데이터 목록 조회	요청 지표 1,000건당	없음
DownloadMetricDataImage	지표 데이터 위젯 이미지 다운로드	요청 지표 1,000건당	없음
ListMetricInfos	지표 데이터 조회	호출 1,000건당	월 1,000,000건
CreateCustomMetricMetas	사용자 정의 지표 메타 데이터 생성	호출 1,000건당	월 1,000,000건
CreateCustomMetrics	사용자 정의 지표 데이터 생성(전송)	호출 1,000건당	월 1,000,000건
ShowDashboard	대시보드 조회	호출 1,000건당	월 1,000,000건
ListDashboards	대시보드 목록 조회	호출 1,000건당	월 1,000,000건
CreateDashboard	대시보드 생성	호출 1,000건당	월 1,000,000건
SetDashboard	대시보드 수정	호출 1,000건당	월 1,000,000건
DeleteBulkDashboards	대시보드 삭제	호출 1,000건당	월 1,000,000건

표. 과금 대상 지표 API

API 직접 호출과 사용자 콘솔 및 ServiceWatch Agent 또한 ServiceWatch API를 사용하므로 API 호출에 포함됩니다.
ListMetricData와 DownloadMetricDataImage API 요청 시, 요청 지표를 최대 500개까지 포함할 수 있으며 API 요청 건수가 아닌 요청 지표 건수로 과금됩니다.
ListMetricData와 DownloadMetricDataImage 이 외의 API는 API 요청 건수로 과금되며, 월 1,000,000건까지 무료입니다.
- CreateCustomMetricMetas는 사용자 정의 지표 수집 설정 시, 최초 1회 호출됩니다.
- CreateCustomMetrics는 1분 주기로 지표 데이터를 ServiceWatch로 전송하기 위해 호출됩니다.
로그는 수집 용량에 따라 요금이 발생하기 때문에 API 호출에 대한 과금은 별도로 추가되지 않습니다.

자세한 요금 정보는 Samsung Cloud Platform Service Portal에서 ServiceWatch 요금 정보를 참고하세요.

ServiceWatch Agent

사용자의 자원인 Virtual Server/GPU Server/Bare Metal Server 등에서 ServiceWatch Agent를 설치하여 사용자 정의 지표와 로그를 수집할 수 있습니다.

ServiceWatch Agent 네트워크 환경

ServiceWatch Agent는 OpenAPI를 사용하여 수집한 지표와 로그를 전송하는 구조로 설계되었습니다. 따라서 서버 자원에서 ServiceWatch OpenAPI Endpoint로 통신할 수 있는 네트워크 환경이 필요하며, 다음 2가지 방식 중 하나를 사용합니다.

Internet Gateway 활용 방식: 자원이 위치한 VPC에 Internet Gateway를 생성하고 서버 자원에 NAT IP를 설정하여 외부와 통신할 수 있도록 설정합니다.
PrivateLink 활용 방식: VPC에 PrivateLink Endpoint를 생성하여 인터넷을 경유하지 않고 내부 네트워크로 통신합니다.

각 방식의 설정 절차와 지원 리전은 ServiceWatch Agent를 위한 사전 환경 설정을 참고하세요.

ServiceWatch Agent 지원 OS Image

ServiceWatch Agent를 사용 가능한 OS Image는 다음과 같습니다.

OS Image 버전	EOS Date
Alma Linux 8.10	2029-05-31
Alma Linux 9.6	2025-11-17
Oracle Linux 8.10	2029-07-31
Oracle Linux 9.6	2025-11-25
RHEL 8.10	2029-05-31
RHEL 9.4	2026-04-30
RHEL 9.6	2027-05-31
Rocky Linux 8.10	2029-05-31
Rocky Linux 9.6	2025-11-30
Ubuntu 22.04	2027-06-30
Ubuntu 24.04	2029-06-30
Windows 2019	2029-01-09
Windows 2022	2031-10-14

표. ServiceWatch Agent 사용 가능 OS Image

Virtual Server 제공 OS Image와 동일하게 제공합니다. Virtual Server > OS Image 제공 버전을 참고하세요.

ServiceWatch Agent 사용을 위한 Quick Guide

아래에서는 Linux 환경에서 Virtual Server의 OS 지표와 로그 수집을 위한 Quick guide를 소개합니다.

Node Exporter 설치를 참고하여 서버에 사용자 정의 지표 수집을 위한 Node Exporter를 설치합니다.
- Node Exporter를 설치하면 ServiceWatch에서 기본 모니터링으로 제공하는 지표 이외에 Node Exporter를 통해 OS 지표를 수집할 수 있습니다.
ServiceWatch Agent 설정을 참고하여 ServiceWatch_Agent 압축 파일을 다운로드한 뒤, ServiceWatch Agent Manager를 설정하고 실행합니다.
- 압축 파일 내의 os-metrics-min-examples 폴더를 참고하면 최소 지표(4개)를 설정하여 ServiceWatch Agent를 실행할 수 있습니다.

주의

ServiceWatch Agent를 통한 지표 수집은 사용자 정의 지표로 구분되어 각 서비스로부터 기본으로 수집되는 지표와는 달리 요금이 부과되므로, 불필요한 메트릭 수집 설정을 하지 않도록 주의해야 합니다. 반드시 수집이 필요한 지표만 수집될 수 있도록 설정하세요.

무료 제공은 Account/리전별 10개까지 제공됩니다.

참고

ServiceWatch Agent 사용에 대한 자세한 내용은 How-to guides > ServiceWatch Agent 사용하기를 참고하세요.

ServiceWatch 사용자 정의 지표 및 로그 API

ServiceWatch에서 제공하는 OpenAPI/CLI를 통해 사용자 정의 지표와 로그를 수집할 수 있습니다.

사용자 정의 지표 데이터와 사용자 정의 로그를 ServiceWatch OpenAPI/CLI를 통해 ServiceWatch로 전달하여 Console에서 시각화된 정보를 확인할 수 있습니다.

주의

ServiceWatch OpenAPI/CLI를 통한 지표 수집은 사용자 정의 지표로 구분되어 각 서비스로부터 기본으로 수집되는 지표와는 달리 요금이 부과되므로, 불필요한 메트릭 수집 설정을 하지 않도록 주의해야 합니다. 반드시 수집이 필요한 지표만 수집될 수 있도록 설정하세요.

무료 제공은 Account/리전별 10개까지 제공됩니다.

사용자 정의 지표 API

사용자 정의 지표 메타 데이터 생성

Samsung Cloud Platform의 서비스(예시: Virtual Server 등)에서 제공하는 지표가 아닌 사용자의 자원이나 애플리케이션에서 발생하는 지표 데이터를 ServiceWatch로 수집하기 위해서 사용자 정의 지표 메타 데이터를 생성해야 합니다.

Parameter	설명
namespace	ServiceWatch에서 다른 지표들과 구분할 수 있는 네임스페이스를 사용자가 정의할 수 있음 네임 스페이스는 영문, 숫자, 공백, 특수문자(`_-/`)를 포함하여 3~128자로 작성해야하며, 영문으로 시작해야 함. 자세한 설명은 네임스페이스를 참고하세요.
metricMetas > metricName	수집하고자 하는 지표 이름 설정. 지표명은 영문, 숫자, 특수문자(`_`)를 포함하여 3~128자로 작성해야하며, 영문으로 시작해야 함. 예시: custom_cpu_seconds_total
metricMetas > storageResolution	해당하는 지표의 수집 주기를 설정. 기본값은 60(1분)으로 초단위로 설정 가능
metricMetas > unit	지표의 단위 설정 가능 예시: Bytes, Count 등
metricMetas > dimensions	사용자 정의 지표 데이터의 식별하기 위해 차원을 설정하여 Console에서 시각화하여 보여줄 수 있음. 수집한 지표를 Console에 시각화하여 보여줄 때, 차원(dimensions) 설정에 따라 조합하여 표시
metricMetas > descriptionKo	수집하는 지표에 대한 국문 설명
metricMetas > descriptionEn	수집하는 지표에 대한 영문 설명

표. 사용자 정의 지표 메타 데이터 파라미터 설명

사용자 정의 지표 메타 데이터 생성을 위한 자세한 내용은 CreateCustomMetricMetas를 참고하세요.

사용자 정의 지표 생성

사용자 정의 지표 메타 데이터를 생성한 후 발생한 지표 데이터를 CreateCustomMetrics API를 사용하여 ServiceWatch로 전달할 수 있습니다.

전달된 지표 데이터는 설정한 네임스페이스로 구분되어 조회할 수 있습니다.

사용자 정의 지표 데이터 생성을 위한 자세한 내용은 CreateCustomMetrics를 참고하세요.

지표 데이터 조회

사용자 정의 지표를 포함한 지표 데이터를 Console과 ListMetricInfos, ListMetricData API를 사용하여 조회할 수 있습니다.

지표 데이터 조회를 위한 자세한 내용은 ListMetricInfos와 ListMetricData를 참고하세요.

사용자 정의 로그 API

로그 스트림 생성

사용자 정의 로그 수집을 위해서는 ServiceWatch 로그 그룹이 필요합니다. 로그 그룹은 Console에서만 생성할 수 있습니다. 미리 로그 그룹을 생성한 후 로그 스트림 생성 API를 사용하여 ServiceWatch로 전달할 로그 스트림을 생성할 수 있습니다.

로그 스트림 생성을 위한 자세한 내용은 CreateCustomLogStream을 참고하세요.

로그 이벤트 생성

사용자 정의 로그 수집을 위해 로그 그룹과 로그 스트림을 생성한 후 개별 로그 메시지(로그 이벤트)를 ServiceWatch로 전달하기 위해서 로그 이벤트 생성 API를 사용합니다.

로그 이벤트 생성을 위한 자세한 내용은 CreateCustomLogEvents을 참고하세요.

ServiceWatch 연계 서비스

How-to guides