tencent cloud

문서Cloud Log Service

Introduction

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-06-10 15:54:25

Overview

Cloud Log Service (CLS) is a SaaS Service with integrated observability that supports Log and Metric data collection, ETL, search and analysis, visualization, and alerting.

  • The CLS APIs covered in this section are all API 3.0 APIs.
    -You can call APIs to perform CLS row operations, such as create log topic, upload log, retrieve logs. Please ensure you fully understand CLS product (https://www.tencentcloud.com/document/product/614/11254?from_cn_redirect=1) and billing method (https://www.tencentcloud.com/document/product/614/45802?from_cn_redirect=1) before using these APIs.
    -For all APIs supported by CLS, see API overview.

Glossary

Common terminology for the CLS API interface is listed below:

Term Description
Logset is a classification of log topics and metric topics. A logset can contain multiple log topics and metric topics. The logset itself does not store any log data, only making user management convenient. A logset usually corresponds to a certain project/business in the company. It is advisable to group log topics of multiple applications/services under the same logset.
Log Topic A log topic is the basic unit for log data collection, storage, retrieval, and analysis on the CLS platform. Massive logs are managed by log topic, including collection rule configuration, retention time configuration, log retrieval analysis, and log download, consumption, and delivery.
Metric Topic A metric topic is the basic unit for collecting, storing, retrieving, and analyzing metric data on the CLS platform. Collected metric data is managed by metric topic, including retention time configuration and search and analysis.
Machine Group A machine group is a list of machines needing log collection. Log Service uses machine groups to manage ALL machines that need to collect logs using LogListener.
Topic Partition A topic Partition is the smallest read-write unit in CLS. A single log topic can contain multiple partitions. The number of partitions determines the maximum data read-write capability of a log topic.
Data Processing Data processing is the process of filtering, cleaning, masking, enriching, and distributing log data to target log topics. It can be understood as log ETL (Extract-Transform-Load).
Scheduled SQL Analysis Scheduled SQL analysis is the process of periodically querying log data (support retrieval and SQL) based on a specified time window and saving query results to target log topic.
Log Group A log group (LogGroup) is a collection of multiple logs. For log upload, to improve data reading and writing efficiency, multiple logs are packaged into a log group and uploaded to CLS in units of log groups. Logs in a log group have the same basic information (TIMESTAMP, FILENAME, SOURCE, HOSTNAME, and metadata).
Metric A Metric is a measurement used to estimate system and application performance and operating status, such as CPU usage, memory usage, access throughput, response time and response success rate. Metrics are generated at regular intervals, producing a value at each point in time and form a sequence over time, which is generally called a time series, or time sequence for short. It is used for data collection and recording in systems and applications.

Usage Limits

For usage limits, please refer to Document Center > Log Service > Product Introduction > Specifications and Limits.

Getting Started with APIs

You can use the API Explorer tool to call APIs online.
This document uses creating a log topic, uploading logs, and retrieving logs as an example. The steps to call the API via the API Explorer Tool are as follows:

  1. Go to the API Explorer tool page. For more information about API Explorer tool usage, see Using API Explorer.
  2. Call the CreateLogset API to create a logset and return the ID of the newly created logset.
  3. Call the CreateTopic API to create a log topic and return the ID of the newly created log topic.
  4. Call the CreateIndex API to create an index.
  5. Use SDK log upload. Based on your business needs, select the language version to use.
  6. Call the SearchLog api to retrieve and analyze logs.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백